Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Wiki Markup
{scrollbar}
h2. Description
The following describes the property settings available.

h2. CSV default separator
Defines the default separator, that should be used for the output.
{code:xml}
<configuration> 

Description

The following describes the property settings available.

CSV default separator

Defines the default separator, that should be used for the output.

Code Block
xml
xml

<configuration>
 <property name="org.jfree.report.modules.output.table.csv.Separator">,</property>

</configuration>
{code}
h2. CSV write column name into first row
Defines whether to write the column names of the data row into the first row.
{code:xml}
<configuration> 
 

CSV write column name into first row

Defines whether to write the column names of the data row into the first row.

Code Block
xml
xml

<configuration>
 <property name="org.jfree.report.modules.output.csv.WriteDatarowNames">true</property>

</configuration>
{code}
h2. Excel output set paper size
Defines the Paper that should be used in the excel print setup. If no paper is defined, a suitable paper will be selected automatically.
{code:xml}
<configuration> 
 

Excel output set paper size

Defines the Paper that should be used in the excel print setup. If no paper is defined, a suitable paper will be selected automatically.

Code Block
xml
xml

<configuration>
 <property name=" org.jfree.report.modules.output.table.xls.Paper">LETTER</property> 
</configuration>
{code}
h2. Excel output set paper orientation
Defines the Paper that should be used in the excel print setup. If no paper is defined, an suitable paper will be selected automatically.  Valid values are "Landscape" or "Portrait" 
{code:xml}
<configuration> 

Excel output set paper orientation

Defines the Paper that should be used in the excel print setup. If no paper is defined, an suitable paper will be selected automatically. Valid values are "Landscape" or "Portrait"

Code Block
xml
xml

<configuration>
 <property name="org.jfree.report.modules.output.table.xls.PaperOrientation">LETTER</property> 
</configuration>
{code}
h2. HTML encoding
Defines the encoding for the HTML.
{code:xml}

HTML encoding

Defines the encoding for the HTML.

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.table.html.Encoding">UTF-8</property>

</configuration>
{code}
h2. HTML body fragment only
Defines whether to define a body fragment only. This removes the header and body tags and makes it easy to include the generated content in own pages.
{code:xml}
<configuration> 

HTML body fragment only

Defines whether to define a body fragment only. This removes the header and body tags and makes it easy to include the generated content in own pages.

Code Block
xml
xml

<configuration>
 <property name="org.jfree.report.modules.output.table.html.BodyFragment">false</property> 
</configuration>
{code}
h2. 

HTML,

...

XHTML

...

1.0

...

or

...

HTML

...

4.0

...

format

...

Defines

...

whether

...

to

...

generate

...

XHTML1.0

...

or

...

HTML4.0

...

content.

...

Code Block
xml
xml
<configuration> 
 <property name="org.jfree.report.modules.output.table.html.GenerateXHTML">false</property>

</configuration>
{code}
h2. HTML default title
Defines the default title for generated HTML documents.
{code:xml}

HTML default title

Defines the default title for generated HTML documents.

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.table.html.Title">My First Report</property>

</configuration>
{code}
h2. HTML set author
Defines a author for generated HTML documents.
{code:xml}

HTML set author

Defines a author for generated HTML documents.

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.table.html.Author">Shakespeare</property>

</configuration>
{code}
h2. HTML set empty cells to use CSS
Defines, whether empty cells will be controlled using CSS.  If this is set to true, the Table gets the style property 

HTML set empty cells to use CSS

Defines, whether empty cells will be controlled using CSS. If this is set to true, the Table gets the style property "empty-cells:

...

show"

...

assigned

...

and

...

the

...

otherwise

...

required

...

no-break-space

...

entities

...

will

...

no

...

longer

...

be

...

generated.

...

The

...

Internet

...

Explorer

...

is

...

not

...

able

...

to

...

use

...

correct

...

CSS2

...

yet.

...

Thus,

...

the

...

default

...

is

...

set

...

to

...

"false".

...


This

...

is

...

a

...

local

...

configuration

...

setting

...

an

...

can

...

be

...

enabled

...

in

...

the

...

report.

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.table.html.EmptyCellsUseCSS">false</property>

</configuration>
{code}
h2. HTML image size in Points or Pixels
Defines, whether image sizes should be given in device independent Point unit 

HTML image size in Points or Pixels

Defines, whether image sizes should be given in device independent Point unit (1/72

...

inch)

...

or

...

in

...

pixels

...

(which

...

is

...

device

...

dependent

...

and

...

makes

...

it

...

hard

...

to

...

predict

...

the

...

final

...

size

...

in

...

the

...

HTML-Page.

...

The

...

default

...

is

...

pixels,

...

false.

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.table.html.UseDeviceIndependentImageSize">false</property>

</configuration>
{code}
h2. HTML table carrier a border definition
Defines, whether table rows should carry a border definition (in addition to the cell definitions). This is a workaround for a layout bug in the Mozilla browser family. 
{code:xml}
<configuration> 
 

HTML table carrier a border definition

Defines, whether table rows should carry a border definition (in addition to the cell definitions). This is a workaround for a layout bug in the Mozilla browser family.

Code Block
xml
xml

<configuration>
 <property name="org.jfree.report.modules.output.table.html.TableRowBorderDefinition">false</property>

</configuration>
{code}
h2. HTML 

HTML Table,

...

use

...

proportional

...

column

...

widths

...

Enables

...

the

...

use

...

of

...

proportional

...

column

...

widths

...

instead

...

of

...

static

...

ones.

...

The

...

resulting

...

table

...

will

...

have

...

a

...

width

...

of

...

100%

...

and

...

the

...

columns

...

will

...

have

...

the

...

proportional

...

equivalent

...

of

...

their

...

static

...

widths

...

as

...

width.

...

Code Block
xml
xml
<configuration> 
 <property name="org.jfree.report.modules.output.table.html.ProportionalColumnWidths">false</property>

</configuration>
{code}
h2. PDF set author
The author string of the document.
{code:xml}

PDF set author

The author string of the document.

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.Author">Larry Augustin</property>

</configuration>
{code}
h2. PDF set title
The title of the document.
{code:xml}

PDF set title

The title of the document.

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.Title">Sales Report</property>

</configuration>
{code}
h2. PDF encoding
Defines PDF encoding for report.
{code:xml}

PDF encoding

Defines PDF encoding for report.

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.Encoding">Cp1252</property>

</configuration>
{code}
h2. PDF embed fonts
 Defines whether to embed fonts in the generated PDF. This will result in larger PDF files, but makes sure that all characters are displayed properly.
{code:xml}
<configuration> 
 

PDF embed fonts

Defines whether to embed fonts in the generated PDF. This will result in larger PDF files, but makes sure that all characters are displayed properly.

Code Block
xml
xml

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.EmbedFonts">Cp1252</property> 
</configuration>
{code}
h2. PDF version
The PDF Version that should be created.   Valid values are 

PDF version

The PDF Version that should be created. Valid values are "1.2",

...

"1.3","1.4"

...

or

...

"1.5"

...

Code Block
xml
xml
<configuration> 
 <property name="org.jfree.report.modules.output.pageable.pdf.Version">1.4</property> 
</configuration>
{code}
h2. PDF 

PDF Security,

...

Allow

...

Copy

...

Defines,

...

whether

...

the

...

PDF

...

Security

...

setting

...

allows

...

copying

...

of

...

the

...

document's

...


contents

...

by

...

default.

...

PDF

...

Security

...

flags

...

are

...

only

...

used

...

with

...

security

...

enabled

...

and

...

a

...

password

...

set.

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.AllowCopy">false</property>

</configuration>
{code}
h2. PDF 

PDF Security,

...

Allow

...

Printing

...

Defines,

...

whether

...

the

...

PDF

...

Security

...

setting

...

allows

...

printing

...

of

...

the

...

document's

...


contents

...

by

...

default

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.AllowPrinting">false</property>

</configuration>
{code}
h2. PDF 

PDF Security,

...

Allow

...

Modifying

...

Contents

...

Defines,

...

whether

...

the

...

PDF

...

Security

...

setting

...

allows

...

modifying

...

of

...

the

...

document

...

by

...

default.

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.AllowModifyContents">false</property> 
</configuration>
{code}
h2. PDF 

PDF Security,

...

Allow

...

Modifying

...

Annotations

...

Defines,

...

whether

...

the

...

PDF

...

Security

...

setting

...

allows

...

document

...

annotations

...

by

...

default.

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.AllowModifyAnnotations">false</property>

</configuration>
{code}
h2. PDF 

PDF Security,

...

Allow

...

Fill-in

...

of

...

Document

...

Forms

...

Defines,

...

whether

...

the

...

PDF

...

Security

...

setting

...

allows

...

the

...

fill-in

...

of

...

document

...

forms

...

(input

...

fields

...

etc).

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.AllowFillIn">false</property>

</configuration>
{code}
h2. PDF 

PDF Security,

...

Allow

...

access

...

for

...

screenreaders

...

Defines,

...

whether

...

the

...

PDF

...

Security

...

setting

...

allows

...

access

...

for

...

screen

...

readers

...

by

...

default.

...

Although

...

this

...

could

...

make

...

it

...

easier

...

to

...

grab

...

the

...

contents

...

your

...

PDF

...

document,

...

enabling

...

this

...

property

...

will

...

allow

...

blind

...

people

...

to

...

access

...

your

...

content.

...

It

...

is

...

usually

...

a

...

good

...

idea

...

to

...

always

...

enable

...

this

...

property.

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.AllowScreenReaders">false</property>

</configuration>
{code}
h2. PDF 

PDF Security,

...

Allows

...

reassembly

...

of

...

document

...

Defines,

...

whether

...

the

...

PDF

...

Security

...

setting

...

allows

...

reassembly

...

of

...

the

...

document

...

by

...

default.

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.AllowAssembly">false</property> 
</configuration>
{code}
h2. PDF 

PDF Security,

...

Allow

...

low

...

quality

...

printing

...

Defines,

...

whether

...

the

...

PDF

...

Security

...

setting

...

allows

...

low

...

quality

...

printing

...

of

...

the

...

document's

...

contents

...

by

...

default.

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.AllowDegradedPrinting">false</property> 
</configuration>
{code}
h2. PDF 

PDF Security,

...

Encrypt

...

Defines

...

whether

...

the

...

PDF

...

file

...

should

...

be

...

encrypted

...

by

...

default.

...

Set

...

this

...

to

...

"none"

...

"40bit"

...

or

...

"128bit".

...

Access

...

restrictions

...

have

...

no

...

effect

...

if

...

the

...

document

...

is

...

not

...

encrypted,

...

and

...

not

...

all

...

security

...

settings

...

are

...

active

...

on

...

40-Bit

...

encryption.

...

No

...

encryption

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.Encryption">none</property>

</configuration>
{code}

40

...

bit

...

encryption

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.Encryption">40bit</property>

</configuration>
{code}

128

...

bit

...

encryption

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.Encryption">128bit</property> 
</configuration>
{code}

{note}
Specifying passwords in the property file can introduce a security risk. Do not use these settings on the client side or in unprotected 
Note

Specifying passwords in the property file can introduce a security risk. Do not use these settings on the client side or in unprotected (world-readable)

server

environments.

In

these

cases

use

other

means

of

defining

the

password.

{note} h2. PDF

PDF Security,

...

Password

...

The

...

default

...

user

...

password

...

for

...

the

...

document.

...

Users

...

are

...

able

...

to

...

access

...

the

...

document

...

within

...

the

...

defined

...

security

...

restrictions.

...

Code Block
xml
xml
<configuration>
  <property name="org.jfree.report.modules.output.pageable.pdf.UserPassword">password</property> 
</configuration>
{code}
h2. PDF 

PDF Security,

...

Owner

...

The

...

default

...

owner

...

password

...

for

...

the

...

document.

...

The

...

owner

...

has

...

all

...

permissions

...

on

...

the

...

document

...

and

...

will

...

be

...

able

...

to

...

change

...

the

...

security

...

settings.

...

Code Block
xml
xml
<configuration> 
 <property name="org.jfree.report.modules.output.pageable.pdf.OwnerPassword">password</property>

</configuration>
{code}