Composite Elements
Composite elements are one or more pre-configured elements that you can use in your reports. You can configure properties such as the size, color, or font of an element, or create a text field with a complex expression you frequently use, and then save it as a composite element. Jaspersoft Studio also ships with several pre-existing composite elements, such as page number and total pages.
Some element types are hard to reuse in other reports, in particular, those elements that depend on the availability of a specific subdataset having certain fields. You cannot include elements based on a dataset in a composite element. In particular, composite elements can not include charts, tables, lists and crosstabs. Composite elements can include notes, text fields, static text, images, breaks, rectangles, ellipses, lines, frames (must contain only permitted elements), barcodes, HTML elements, and other composite elements.
If your composite element contains elements that use expressions (text-field expressions or print-when expressions), the objects you are referencing in those expressions (such as variables, fields or parameters) should available in the report in which you use the composite elements. If the objects are not present, you may receive an error when compiling or previewing the report.
| Composite elements cannot include elements based on a dataset, such as charts or crosstabs. |
Inserting Page and Column Breaks
Page and column breaks are used to force the report engine to make a jump to the next page or column. A column break in a single column report has the same effect as a page break.
In the Design tab, they are represented as a small line. If you try to resize them, the size is reset to the default, this because they are used just to set a particular vertical position in the page (or better, in the band) at which Jaspersoft Studio forces a page or column break.
The type of break can be changed in the Properties view.
Creating and Editing Composite Elements
To create a composite element:
| 1. | Open or create a report. |
For example:
| a. | Go to File > New > Jasper Report or click |
| b. | In the New Report Wizard, select Blank A4 in the Report Templates window and click Next. |
| c. | Select a name and location for your file (for example, Composite Element Sample Report in MyReports) and click Next. |
| d. | Choose One Empty Record in the Data Source window and click Finish. |
| 2. | Place the elements you want in the Title band and format and position them. |
| Composite elements must be created from the Title band. |
For example, to create a footer that includes your company name and the page number:
| a. | Drag the Static Text element to the Title band in your report and type My Company. Then align the company name to the to the left by right-clicking the Static Text element and selecting Align in Container > Align to Left Margin. |
| b. | Drag the Page Number element to the Title band in your report. Align the Page Number to the right by right-clicking the Page Number element and selecting Align in Container > Align to Right Margin. Then, with the Page Number element selected, go to the Text Field tab in the Properties view and click |
| c. | Select both elements, right-click, and choose Align Components > Align Top. |
| 3. | Select all the elements you want in your composite. |
| 4. | (Optional) To have your elements move together, right-click and select Enclose into Frame from the context menu. |
| 5. | Make sure all elements are still selected. |
Selected Elements For Composite Element Creation |
|
| 6. | Right-click and select Save as Composite Element. |
The Composite Element Settings dialog box opens.
Composite Element Settings Dialog Box |
|
| 7. | Enter the following information |
| • | Name: Enter a unique name you want to appear in the palette. |
| • | Description (optional): Enter a description. If the element uses text fields or expressions, it may be useful to mention these, or the expected data adapter, in the description. |
| • | Icon (optional): Choose the icon that will show in the palette for this composite element. You can choose an icon in JPG, PNG, or GIF format. If you click Browse to locate an icon, and you want to use a PNG or a GIF, you must choose the correct format at the bottom right of the file open dialog. If you do not choose an icon, Jaspersoft Studio uses the default icon |
| • | Position in Palette: Select one of Basic Elements, Composite Elements, or Components Pro. |
| 9. | Click OK on the confirmation message. |
The new composite element is saved as a .jrtool file in the same location as your report. An icon is added to the bottom of the subpalette you selected.
Composite Element in the Palette |
|
To edit the contents of a composite element:
| 1. | Right-click on the composite element in the palette and select Open in Designer. |
The composite element opens in the Designer as a .jrtool file.
| 2. | You can add and remove elements and change element formatting. If you add elements, remember to select all elements and create a frame. |
To edit the name or location of a composite element:
| 1. | Right-click on the composite element in the palette and select Edit. |
The Composite Element Settings dialog box opens.
| 2. | Change the name, description, icon, or position in palette. |
| 4. | Click OK on the confirmation message. |
To delete a composite element you have created:
| 1. | Right-click on the composite element in the palette and select Delete. |
The element is removed from the palette.
| You cannot delete the composite elements that are shipped with Jaspersoft Studio. |
Recommended Comments
There are no comments to display.