Report

The properties of a report object are:

Property Name	Description	Editable	Formula Controllable	Data Type
General
Report Layout Type	Indicates the layout type of the report. Flow Report means that the report is built as a regular flow layout report; Banded Report means that the report is built as a restricted flow layout report, which is a layout intended for JReport Version 7 compatibility only.	N	N	_
Result Buffer
Result Buffer Size	Sets the size of the result buffer for storing the report result.	Y	Y	_
Others
Expand Detail Data	It describes the state of the groups when the report set is open in JReport Web. If true, the groups will expand to show their details; if false, the groups will collapse.	Y	Y	Boolean
Shrink Footer	If true, when you shrink data in group, the group footer will be shrunk too.	Y	Y	Boolean
Current Block Index	It only works in continuous page mode. It describes the index of data block that should be displayed. This property is related to Items per Block.	Y	Y	Integer
Items per Block	It only works in continuous page mode. It describes how many data blocks should be split. This property is related to Current Block Index.	Y	Y	Integer
National Language Support	Specifies whether or not to apply the NLS function for the report.	Y	Y	Boolean
Applet Width	Sets the applet width for running an exported applet in a web server.	Y	N	Float
Applet Height	Sets the applet height for running an exported applet in a web server.	Y	N	Float
Page Background	Sets the report background color.	Y	N	String
Before Run	Exit function usage. You can run an application file (java class file) before running a report.	Y	N	String
After Run	Exit function usage. You can run an external application file (java class file) just after the report result is obtained.	Y	N	String
Show Subreport Header Footer	Displays PageHeader and PageFooter information of subreport(s) in the main report (in page level) if true.	Y	Y	Boolean
Embedded Fonts	Select the TrueType fonts that have been used in the report so as to embed them if you want to export the report result to a PDF file. You can select multiple fonts by pressing the Ctrl or Shift key.	Y	N	String
Style Group	Specifies a style group for the report. If the report is to be used as a subreport, choosing any style group from the drop-down list to turn on the style group feature for the report and it will inherit the styles of the main report; choosing "None" or leaving this property empty to turn off the style group feature for the report and it will not inherit styles from the main report.	Y	N	String
No Template File	Specifies whether the template file can be created or not. It only works under force fast pass engine procedure.	Y	N	Boolean
Import JavaScript	Specifies a JavaScript file to apply customized functions.	Y	N	String
Excel
Excel Buffer Size	Specifies the size of the Excel buffer for storing Excel-format report result.	Y	Y	Integer
Rows per Sheet	Specifies the maximum number of rows for every worksheet when exporting to Excel.	Y	Y	Integer
Column Width List	Specifies the width for columns, measured in characters.	Y	N	Integer
Fast Pass	Improves the performance of the engine when running a report to CSV format on JReport Enterprise Sever if true. Note that only when the property Columned is true, this property can be true.	Y	N	Boolean
Columned	Improves the performance when exporting the report to CSV format or Excel format if true, and in this case, users can define the position of the object in the CSV or Excel format file by setting the properties Column Index, Row Index, Top Attach Column, Top Attach Row, Bottom Attach Column, and Bottom Attach Row.	Y	N	Boolean

Result buffer

The result buffer is used to store the report result of one report in pages. Its default size is 4 which indicates 4 pages of a report result have been allocated to the result buffer. The other pages will be stored on disk. If you have enough memory, you can increase the result buffer size to store more pages of the report result. By doing this, you will achieve better performance.

Applet setting

Reports are developed in JReport Designer and saved as .cls file. Report files and their associated resource files (.cat and .fml files) to JReport Enterprise Server for running reports in client/server mode. Once the report repository is properly set up, it can be accessed with any web browser, JReport Viewer or Client Viewer Bean. Also, you can choose to export the report result to a printer, a PDF or TXT file, etc.

If the report result has been specified to be transferred and viewed in the applet format, you can change the display area by inputting the correct number in the Report Inspector. Alternatively, you can edit the applet file directly in a text editor.

Applet Height: Refers to the height of an applet.
Applet Width: Refers to the width of an applet.

See also Exporting to Applet for more information about this format.

Setup callback or exit functions

During the running of a report, the display of the report is done by JReport Engine. You have no control over this. However, JReport functionality allows you to interact with this mechanism at 3 points:

After the parameter has been initiated.
At the point JReport Engine is about to run the report. If you have parameters, the parameter at this stage will have been initiated, and you have given the parameter value.
Immediately after JReport Engine has run the report result.

At any or all of these three points you have the option of executing a class of your choice. JReport has developed three exit functions for you: AfterInitParameter, Before Run and After Run. These functions enable you to develop an action to be called before, after or during the process of running a report. Your applications will return true or false. For true, JReport Engine will go on running. For false, JReport Engine will stop at this point.

Import JavaScript

If you want to develop functions in your own JS file, you can use this property to support the control objects in DHTML. Your own JS file should be located in <server_install_root>\public_html\javascript\dhtml, and it will work together with the API.js file in the same folder, but with a higher priority if both of them contain the same functions.

To use this property, simply set the property value to the name of your JS file.

For example, you have a JavaScript file named "user1.js" which contains the following function:

Function promptMassage(message)
  {
  alert(message);
  }

In this example, set the property to "user1.js" in order to apply functions defined in the file.

Excel buffer

The Excel buffer is used to store the report result in Excel buffer sheets when exporting the result in Excel format. Its default size is 1, which indicates 1 sheet of the report result is allocated to the result buffer. The other sheets will be stored on disk. If you have enough memory, you can increase the Excel buffer size to store more sheets of the Excel-format report result. By doing this, you will achieve better performance.

Rows per Sheet

This property is used to control the maximum number of rows in every worksheet in an exported Excel report. The default value is -1, which means a maximum number of 65000 rows is allowed in a single worksheet. The value range is 0 ~ 65000. Any value out of this range will be considered as 65000.

Column Width List

Specifies the width for columns, measured in characters. This property takes effect only when the Columned property is set to true.

Type the width for the columns in turn, using semicolon (;) to separate each value. If you don't want to specify the width for a certain column, omit the value. JReport will use the default value, which is 8. For example, the value list 12;15;;20 sets the first column width 12, the second 15, the third 8, which is the default value, and the fourth 20.