Parameter fields

A parameter in JReport is a variable whose value is determined at runtime. The runtime parameters help you dynamically control your report results.

Inserting a parameter field in a report

Parameter fields can be inserted in the report areas listed in Component placement. Before you can insert a parameter field into a report, you need to create it. For details about how to create parameters, see Creating a parameter.

To insert a parameter field into a report, you can use either of the following methods:

• Using dialog
  1. Position the mouse pointer at the destination where you want to insert the parameter and do one of the following:
     • Click Insert > Parameter on the menu bar.
     • Click the Insert Parameter button on the Insert toolbar.

     The Insert Fields dialog appears. See the dialog.

     

  2. Select the required parameter from the Parameters node, then specify its layout in the Insert Layout box.
  3. Click the Insert button to insert the parameter into the destination.
• By dragging and dropping

  Select the required parameter from the Resource View panel, then drag it to the destination.

When a parameter field has been inserted into a report, you can customize its appearance and behavior by setting properties in the Report Inspector, which can be saved as a CSS style for future use (for details, see Creating a CSS style).

Changing the display type of a parameter field

The display type of a parameter field can be changed, that is to say, you can map the parameter field to another value or image to be displayed instead.

To change the display type a parameter field:

1. Right-click the parameter field and select Display Type from the shortcut menu.
2. In the Display Type dialog, specify the required display type in the Display As box, and set the options for the selected type.
   • To change the display type of a parameter to list or drop-down list, select the item List or Drop-down List, and then in the Web Options panel, set the name and title. You may notice that a default list item had been added, and its value is the parameter. If you check Use Runtime Value, when running the report, you need to specify a value for the parameter, and then the item same as the value will be selected in the list or drop-down list by default; if you uncheck the option, the Selected text box will be enabled for you to input a value and the item same as this value will be selected. For the List type, you can check Allow Multiple Selections to enable more than one item selected.
   • For other display types, refer to Changing the display type of a label for details.
3. Upon finishing, click the OK button to close the dialog.

Applying web actions to a parameter field

A parameter field can be bound with some web actions. This allows you to customize a parameter field to make it respond to some events, and execute corresponding actions, such as sorting and filtering.

To apply web actions to a parameter field:

1. Right-click the parameter field and select Display Type from the shortcut menu.
2. In the Web Behaviors box of the Display Type dialog, choose an event from the Events column, then click in the Actions column and click that appears in the text box.
3. In the Web Action List dialog, select a web action and define the action as required.
4. Click in the Display Type dialog to add more web behavior lines and specify the events and actions accordingly. If a web behavior is not required, click to remove it.
5. Adjust the order of the added web actions by clicking or . Then, when an event that has been bound with more than one action happens, the upper action will be triggered first.
6. When done , click OK to accept the settings.

For more information about web actions, see Applying web actions to a label.

Binding a link to a parameter field

You can make a parameter field linked with another report, a location specified by a URL, an e-mail address, or a Blob data type field. The link can either be a simple link or a conditional link. With conditional link, different targets can be loaded based on different conditions.

To bind a link to a parameter field:

1. Right-click the parameter field and click Link on the shortcut menu.
2. In the Insert Link dialog, specify whether it is a conditional link or a simple link, then select the link target and set the options for the link target as required.
3. When done, click OK.

For details about different link targets, see Binding a link to a label.

Adding conditional formats to a parameter field

You can add some conditional formats to a parameter field, then when a specified condition is fulfilled, the format bound with the condition will be applied to the field values automatically for distinguishing.

To add conditional formats to a parameter field:

1. Right-click the parameter field and select Conditional Formatting from the shortcut menu.
2. In the Conditional Formatting dialog, click the button to add a condition.
3. Set the format that will be applied to the field values when the specified condition is fulfilled.
4. Repeat the above two steps to add more conditions and define the format for each condition.
5. When done, click OK to save the settings.

For more details about conditional formatting, see Adding conditional formats to a DBField.