|
|
|
|
|
jasperReport | top |
| Root element representing the definition of a report. |
|
CONTAINS (
reportFont*,
parameter*,
queryString?,
field*,
variable*,
group*,
background?,
title?,
pageHeader?,
columnHeader?,
detail?,
columnFooter?,
pageFooter?,
summary?
) |
|
ATTRIBUTES |
| name |
| Name of the report. |
| REQUIRED |
| columnCount |
| Number of columns on the report. |
| DEFAULT 1 |
| printOrder |
| Columns filling order. |
| Vertical |
| Columns on the report are filled vertically. |
| Horizontal |
| Columns on the report are filled horizontally. |
| DEFAULT Vertical |
| pageWidth |
| Page width. |
| DEFAULT 595 |
| pageHeight |
| Page height. |
| DEFAULT 842 |
| orientation |
| Page printing orientation. |
| Portrait |
| Landscape |
| DEFAULT Portrait |
| whenNoDataType |
| Allows users to customize the behavior of the reporting engine when there are now rows in the data source. |
| NoPages |
| The generated document contains zero pages. |
| BlankPage |
| The generated document contains one blank page. |
| AllSectionsNoDetail |
| All the report sections except the detail section will get printed. |
| DEFAULT NoPages |
| columnWidth |
| Column width. |
| DEFAULT 555 |
| columnSpacing |
| Space between columns. |
| DEFAULT 0 |
| leftMargin |
| Left margin. |
| DEFAULT 20 |
| rightMargin |
| Right margin. |
| DEFAULT 20 |
| topMargin |
| Top margin. |
| DEFAULT 30 |
| bottomMargin |
| Bottom margin. |
| DEFAULT 30 |
| isTitleNewPage |
| Flag used to specify if the title section should be printed on a separate initial page. |
| true |
| Title section will be printed on a separate initial page. |
| false |
| Title section will be printed on the first page of the report, along with the other sections. |
| DEFAULT false |
| isSummaryNewPage |
| Flag used to specify if the summary section should be printed on a separate last page. |
| true |
| Summary section will be printed on a separate last page. |
| false |
| Summary section will be printed on the last page of the report, along with the other sections, if there is enough space. |
| DEFAULT false |
| scriptletClass |
| Indicates which class implements the scriptlets functionality for this report. The specified class must be a subclass of JRAbstractScriptlet class. If omitted, an instance of JRDefaultScriptlet will be created. |
| DEFAULT dori.jasper.engine.JRDefaultScriptlet |
|
property | top |
| Allows the creation of a name-value pair property for the report. |
|
CONTAINS EMPTY |
|
ATTRIBUTES |
| name |
| Name of the report property. |
| REQUIRED |
| value |
| Value of the report property. |
|
reportFont | top |
| Represents the definition of a report font. Report fonts are used as default or base font settings in other font definitions throughout the report. |
|
CONTAINS EMPTY |
|
ATTRIBUTES |
| name |
| Name of the report font definition. |
| REQUIRED |
| isDefault |
| The default report font is used as base font for all the font definitions that do not explicitly reference a report font definition. |
| true |
| false |
| DEFAULT false |
| fontName |
| Name of the font. |
| DEFAULT sansserif |
| size |
| Size of the font. |
| DEFAULT 10 |
| isBold |
| true |
| false |
| DEFAULT false |
| isItalic |
| true |
| false |
| DEFAULT false |
| isUnderline |
| true |
| false |
| DEFAULT false |
| isStrikeThrough |
| true |
| false |
| DEFAULT false |
| pdfFontName |
| Name of the PDF font. |
| DEFAULT Helvetica |
| pdfEncoding |
| Encoding type to use with the PDF font. |
| DEFAULT CP1252 |
| isPdfEmbedded |
| Specifies if the PDF font should be embedded in the document. |
| true |
| false |
| DEFAULT false |
|
parameter | top |
| Represents the definition of a report parameter. Parameters are very useful for passing data to the report engine and can be used in the expressions or in the query string of the report. |
|
CONTAINS (
parameterDescription?,
defaultValueExpression?
) |
|
ATTRIBUTES |
| name |
| Name of the parameter. |
| REQUIRED |
| class |
| Class of the parameter values. |
| REQUIRED |
| isForPrompting |
| Optional flag that might be used by the parent application to prompt the user for the parameter value. |
| true |
| false |
| DEFAULT true |
|
parameterDescription | top |
| Can be used to specify a short text description for the parameter and is useful especially when prompting for the user to supply a value for this parameter at runtime. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
defaultValueExpression | top |
| Specifies the parameter default value to use when not supplied by the parent application at runtime. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
queryString | top |
| Contains the SQL query that will be used to retrieve the data needed to fill the report. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
field | top |
| Represents the definition of a data field that will store values retrieved from the data source of the report. |
|
CONTAINS (
fieldDescription?
) |
|
ATTRIBUTES |
| name |
| Name of the field. |
| REQUIRED |
| class |
| Class of the field values. |
| java.lang.Object |
| java.lang.Boolean |
| java.lang.Byte |
| java.util.Date |
| java.sql.Timestamp |
| java.sql.Time |
| java.lang.Double |
| java.lang.Float |
| java.lang.Integer |
| java.io.InputStream |
| java.lang.Long |
| java.lang.Short |
| java.math.BigDecimal |
| java.lang.String |
| DEFAULT java.lang.String |
|
fieldDescription | top |
| Can be used to specify a short text description for the field and is useful especially when creating special designed data sources and an extra information is needed in order to extract the value of the field. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
variable | top |
| Represents the definition of a report variable. Variables are objects that store the values of their associated expressions or perform various calculations on those expression values. Expressions are java expressions build on top of fields and variables declared in the report. They are evaluated at runtime, when filling the report. |
|
CONTAINS (
variableExpression?,
initialValueExpression?
) |
|
ATTRIBUTES |
| name |
| Name of the variable. |
| REQUIRED |
| class |
| Class of the variable values. |
| DEFAULT java.lang.String |
| resetType |
| Reset level for variables that perform calculations. |
| None |
| Variable is never initialized using the initial value expression and only holds the values obtained by evaluating its main expression. |
| Report |
| Variable is initialized only once, at the beginning of the report. |
| Page |
| Variable is initialized at the beginning of each page. |
| Column |
| Variable is initialized at the beginning of each column. |
| Group |
| Variable is initialized when the group specified by the resetGroup attribute changes. |
| DEFAULT Report |
| resetGroup |
| Name of the group at which the variable is reinitialized, when resetType is "Group". |
| calculation |
| Calculation to perform on the variable expression when filling the report. |
| Nothing |
| No calculations are performed. |
| Count |
| Variable stores the number of the not null values encountered for the variable expression. |
| Sum |
| Variable stores the sum of the not null values encountered for the variable expression. Numeric variables only. |
| Average |
| Variable stores the average of the not null values encountered for the variable expression. Numeric variables only. |
| Lowest |
| Variable stores the lowest value encountered for the variable expression. |
| Highest |
| Variable stores the highest value encountered for the variable expression. |
| StandardDeviation |
| Variable stores the standard deviation of the not null values encountered for the variable expression. Numeric variables only. |
| Variance |
| Variable stores the variance of the not null values encountered for the variable expression. Numeric variables only. |
| System |
| Variable stores a system calculated value. |
| DEFAULT Nothing |
|
variableExpression | top |
| Definition of the expression associated with the variable. The value of this expression will be calculated at runtime and will represent the value of the corresponding variable or it will be used in calculation to obtain the value of the calculated variable. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
initialValueExpression | top |
| Definition of the expression that will be used to calculate the initial value of the variable, before any calculations are made. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
group | top |
| Definition of a group on the report. |
|
CONTAINS (
groupExpression?,
groupHeader?,
groupFooter?
) |
|
ATTRIBUTES |
| name |
| Name of the group |
| REQUIRED |
| isStartNewColumn |
| Flag that signals if the group header should be printed always on a new column. |
| true |
| Group header section is printed always on a new column. |
| false |
| Group header section is printed on the current column, if there is enough space. |
| DEFAULT false |
| isStartNewPage |
| Flag that signals if the group header should be printed always on a new page. |
| true |
| Group header section is printed always on a new page. |
| false |
| Group header section is printed on the current page, if there is enough space. |
| DEFAULT false |
| isResetPageNumber |
| Flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number. |
| true |
| Group header section is printed always on a new page and the page number is reinitialized. |
| false |
| Group header section is printed accordingly with the isStartNewPage attribute and the page number is not affected. |
| DEFAULT false |
| isReprintHeaderOnEachPage |
| Flag that signals if the group header should be reprinted at the beginning of each page. |
| true |
| Group header section is reprinted always at the beginning of a new page. |
| false |
| Group header section is not reprinted at the beginning of a new page. |
| DEFAULT false |
| minHeightToStartNewPage |
| Minimum amount of vertically space needed at the bottom of the column in order to place the group header on the current column. |
| DEFAULT 0 |
|
groupExpression | top |
| Specifies the expression that will be evaluated at runtime to determine the group ruptures. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
groupHeader | top |
| Contains the definition of the header section for this group. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
groupFooter | top |
| Contains the definition of the footer section for this group. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
background | top |
| Definition of the page background section for this report. The background section is displayed on every page and cannot overflow to the next page. Elements placed on this section are evaluated at page initialization time and are displayed in the back. All other page elements are displayed on top of the background elements. This section allows creating watermark or other similar effects in documents. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
title | top |
| Definition of the title section for this report. The title section appears only once at the beginning of the report. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
pageHeader | top |
| Definition of the page header section for this report. The page header is printed at the beginning of each page on the report. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
columnHeader | top |
| Definition of the column header section for this report. The column header is printed at the beginning of each column on the report. If the report's column count is 1, column header and footer sections are ignored. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
detail | top |
| Definition of the detail section for this report. The detail section is repeted for each line of data supplied by the report's data source. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
columnFooter | top |
| Definition of the column footer section for this report. The column footer is printed at the bottom of each column on the report. If the report's column count is 1, column header and footer sections are ignored. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
pageFooter | top |
| Definition of the page footer section for this report. The page footer is printed at the bottom of each page on the report. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
summary | top |
| Definition of the summary section for this report. The summary section is printed only once at the end of the report. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
band | top |
| Generic definition of a report section. |
|
CONTAINS (
printWhenExpression?, (
line |
rectangle |
ellipse |
image |
staticText |
textField |
subreport |
elementGroup
)*) |
|
ATTRIBUTES |
| height |
| Height of the band. |
| DEFAULT 0 |
| isSplitAllowed |
| Flag that indicates if the band is allowed to split when it stretches. |
| true |
| Page breaks are accepted within this band. |
| false |
| When the band stretches and it does not fit on the current page, the content of the band will be transferred on the next new page. On this new page the flag will be ignored since the band has to be displayed even there is not enough space to acquire the stretch. |
| DEFAULT true |
|
line | top |
| Definition of a line object. |
|
CONTAINS (
reportElement,
graphicElement?
) |
|
ATTRIBUTES |
| direction |
| Lines are drawn as diagonals of the rectangle defined by the report element properties. This attribute specifies which of the two diagonals should be drawn. |
| TopDown |
| The diagonal that starts in the top-left corner of the rectangle will be drawn. |
| BottomUp |
| The diagonal that starts in the bottom-left corner of the rectangle will be drawn. |
| DEFAULT TopDown |
|
reportElement | top |
| Element used to specify the common properties of an object on the report. |
|
CONTAINS (
printWhenExpression?
) |
|
ATTRIBUTES |
| key |
| This attribute is used to identify band elements by their "key" when wanting to alter their settings at runtime. The key value must be unique for elements within report band. |
| positionType |
| Specifies the object position when the report section is affected by stretch. |
| Float |
| The element moves relative to the size of the surrounding elements. |
| FixRelativeToTop |
| The element maintains its position relative to the top of the band. |
| FixRelativeToBottom |
| The element maintains its position relative to the bottom of the band. |
| DEFAULT FixRelativeToTop |
| stretchType |
| Specifies the graphic element stretch behavior when the report section is affected by stretch. |
| NoStretch |
| The graphic element won't stretch vertically as the band stretches to display field data. |
| RelativeToTallestObject |
| The graphic element will stretch to accommodate the tallest object in its the group. See the <elementGroup> element, to see how to group elements in bands. |
| RelativeToBandHeight |
| The graphic element will stretch to fit in the band. |
| DEFAULT NoStretch |
| isPrintRepeatedValues |
| This flag allows suppressing the repeating values for the dynamic elements such as text fields and image fields and to fully customize the behavior of the static elements like rectangles, lines, ellipses and static texts. |
| true |
| Dynamic elements will print even if their values repeat. Static elements will appear every time the band that contains them is started. |
| false |
| Suppresses the repeated values for the dynamic elements. The static elements will print only according to the other 3 attributes: isPrintInFirstWholeBand , isPrintWhenDetailOverflows , printWhenGroupChanges . |
| DEFAULT true |
| mode |
| Specifies whether the background of an object is transparent or opaque. |
| Opaque |
| Transparent |
| x |
| Specifies the x coordinate for the object within the band. |
| REQUIRED |
| y |
| Specifies the y coordinate for the object within the band. |
| REQUIRED |
| width |
| Width of the object. |
| REQUIRED |
| height |
| Height of the object. |
| REQUIRED |
| isRemoveLineWhenBlank |
| Collapses the band if the element is not printing and no other element is occupying the same horizontal space. |
| true |
| false |
| DEFAULT false |
| isPrintInFirstWholeBand |
| The element gets printed in the first band of a new page or column that is not an overflow from a previous page or column. |
| true |
| false |
| DEFAULT false |
| isPrintWhenDetailOverflows |
| The element will be printed when the band overflows to a new page or a new column. |
| true |
| false |
| DEFAULT false |
| printWhenGroupChanges |
| The element will be printed when the specified group changes. |
| forecolor |
| Fore color to use when drawing the object. Hexadecimal formatted values preceded by the # character or decimal values are accepted along with the following predefined color values: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, yellow, white. |
| DEFAULT #000000 |
| backcolor |
| Back color to use when drawing the object. Hexadecimal formatted values preceded by the # character or decimal values are accepted along with the following predefined color values: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, yellow, white. |
| DEFAULT #FFFFFF |
|
printWhenExpression | top |
| Definition of a Boolean expression that will determine if the element or the band should be printed or not. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
graphicElement | top |
| Element used to specify the common properties of a graphic object on the report (line, rectangle, ellipse or image). |
|
CONTAINS EMPTY |
|
ATTRIBUTES |
| pen |
| Type of the lines used to draw the object. |
| None |
| No line. |
| Thin |
| Thin line. |
| 1Point |
| Normal line. |
| 2Point |
| Medium line. |
| 4Point |
| Thick line. |
| Dotted |
| Dotted line. |
| fill |
| Type of the fill pattern used to fill objects. |
| Solid |
| Solid fill. |
| DEFAULT Solid |
|
rectangle | top |
| Definition of a rectangle object. |
|
CONTAINS (
reportElement,
graphicElement?
) |
|
ATTRIBUTES |
| radius |
| The radius of the arc corner. |
| DEFAULT 0 |
|
ellipse | top |
| Definition of an ellipse object. |
|
CONTAINS (
reportElement,
graphicElement?
) |
|
ATTRIBUTES |
|
image | top |
| Definition of an image object. |
|
CONTAINS (
reportElement,
graphicElement?,
imageExpression?,
anchorNameExpression?,
hyperlinkReferenceExpression?,
hyperlinkAnchorExpression?,
hyperlinkPageExpression?
) |
|
ATTRIBUTES |
| scaleImage |
| Image displaying type. |
| Clip |
| Only the portion of the image that fits the specified object width and height will be printed. Image is not stretched. |
| FillFrame |
| Image will be stretched to adapt to the specified object width and height. |
| RetainShape |
| Image will adapt to the specified object width or height keeping its original shape. |
| DEFAULT RetainShape |
| hAlign |
| Horizontal image alignment. |
| Left |
| Center |
| Right |
| DEFAULT Left |
| vAlign |
| Vertical image alignment. |
| Top |
| Middle |
| Bottom |
| DEFAULT Top |
| isUsingCache |
| If true, tells the report engine to cache the images that are loaded from the same location. |
| true |
| false |
| DEFAULT true |
| evaluationTime |
| The image to be printed is supplied by the associated expression. This expression can be evaluated at a specified moment. This could be useful, for example, when we want to have on the first page a chart that will be generated only after fetching all the data source rows. |
| Now |
| The image expression is evaluated when filling the current band (section). |
| Report |
| The image expression is evaluated when reaching the end of the report. |
| Page |
| The image expression is evaluated when reaching the end of the current page. |
| Column |
| The image expression is evaluated when reaching the end of the current column. |
| Group |
| The image expression is evaluated when the group specified by the evaluationGroup attribute changes. |
| DEFAULT Now |
| evaluationGroup |
| Used to specify the group at which to evaluate the image expression value, when evaluationTime is "Group". |
| hyperlinkType |
| Indicates the type of the hyperlink element. |
| None |
| The current element doesn't represent a hyperlink. |
| Reference |
| The current hyperlink points to an external resource specified by the corresponding <hyperlinkReferenceExpression> element, usually an URL. |
| LocalAnchor |
| The current hyperlink points to a local anchor specified by the corresponding <hyperlinkAnchorExpression> element. |
| LocalPage |
| The current hyperlink points to a 1 based page index within the current document specified by the corresponding <hyperlinkPageExpression> element. |
| RemoteAnchor |
| The current hyperlink points to an anchor specified by the <hyperlinkAnchorExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element. |
| RemotePage |
| The current hyperlink points to a 1 based page index specified by the <hyperlinkPageExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element. |
| DEFAULT None |
|
imageExpression | top |
| Definition of the expression that will be used to determine the image to be displayed. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
| class |
| Class of the image source. |
| java.lang.String |
| Image location. First, the report engine tries to see whether the String represents an URL. If not, it tries to find the file on disk and finally, if the String does not represent a path file, it searches in the CLASSPATH to find the image as a resource. |
| java.io.File |
| Image loaded by opening an java.io.InputStream from this java.io.File object. |
| java.net.URL |
| Image loaded by opening an java.io.InputStream from this java.net.URL object. |
| java.io.InputStream |
| Image loaded from an java.io.InputStream object. |
| java.awt.Image |
| Image loaded from a java.awt.Image object. |
| DEFAULT java.lang.String |
|
anchorNameExpression | top |
| If specified, it will supply the name of the local anchor that will mark to the corresponding element. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
hyperlinkReferenceExpression | top |
| Used in hyperlink elements to point to external documents and resources. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
hyperlinkAnchorExpression | top |
| Used in hyperlink elements to point to document anchors. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
hyperlinkPageExpression | top |
| Used in hyperlink elements to point to document pages. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
staticText | top |
| Definition of a static text object. |
|
CONTAINS (
reportElement,
textElement?,
text?
) |
|
ATTRIBUTES |
|
textElement | top |
| Element used to specify the common properties of a text object on the report (<staticText> or <textField> ). |
|
CONTAINS (
font?
) |
|
ATTRIBUTES |
| textAlignment |
| Type of alignment for the text object. |
| Left |
| Text is aligned to the left. |
| Center |
| Text is centered. |
| Right |
| Text is aligned to the right. |
| Justified |
| Text is justified. |
| DEFAULT Left |
| verticalAlignment |
| Type of vertical alignment for the text object. |
| Top |
| Text is aligned to the top. |
| Middle |
| Text is vertically centered. |
| Bottom |
| Text is aligned to the bottom. |
| DEFAULT Top |
| rotation |
| Type of rotation for the text object. |
| None |
| Text runs horizontally from left to right and from top to bottom. |
| Left |
| Text runs vertically from bottom to top and from left to right. |
| Right |
| Text runs vertically from top to bottom and from right to left. |
| DEFAULT None |
| lineSpacing |
| Type of line spacing for the text object. |
| Single |
| Normal line spacing |
| 1_1_2 |
| Medium line spacing. |
| Double |
| Double line spacing |
| DEFAULT Single |
|
font | top |
| Defines the font to use with the text element. |
|
CONTAINS EMPTY |
|
ATTRIBUTES |
| reportFont |
| Name of the report level font to use as base font (see <reportFont> element). |
| fontName |
| Name of the font. |
| size |
| Size of the font. |
| isBold |
| true |
| false |
| isItalic |
| true |
| false |
| isUnderline |
| true |
| false |
| isStrikeThrough |
| true |
| false |
| pdfFontName |
| Name of the PDF font. |
| pdfEncoding |
| Encoding type to use with the PDF font. |
| isPdfEmbedded |
| Specifies if the PDF font should be embedded in the document. |
| true |
| false |
|
text | top |
| Specifies the text to print for a static text object. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
textField | top |
| Definition of a text field object. |
|
CONTAINS (
reportElement,
textElement?,
textFieldExpression?,
anchorNameExpression?,
hyperlinkReferenceExpression?,
hyperlinkAnchorExpression?,
hyperlinkPageExpression?
) |
|
ATTRIBUTES |
| isStretchWithOverflow |
| Instructs the report engine to allow the text field to stretch downwards in order to display all its text when it doesn't fit in the defined text field height. |
| true |
| false |
| DEFAULT false |
| evaluationTime |
| Text to be printed is supplied by the text field associated expression. This expression can be evaluated at a specified moment. This could be useful, for example, when we want to have on the first page the total number of pages. The total number of pages is known only after filling the entire report, so we can specify that the text filed that will represent the total number of pages placed at the beginning of the report should be evaluated only when reaching the end of the report. |
| Now |
| Text field expression is evaluated when filling the current band (section). |
| Report |
| Text field expression is evaluated when reaching the end of the report. |
| Page |
| Text field expression is evaluated when reaching the end of the current page. |
| Column |
| Text field expression is evaluated when reaching the end of the current column. |
| Group |
| Text field expression is evaluated when the group specified by the evaluationGroup attribute changes. |
| DEFAULT Now |
| evaluationGroup |
| Used to specify the group at which to evaluate the text field value, when evaluationTime is "Group". |
| pattern |
| Pattern to use when formatting the output of the text field expression. |
| isBlankWhenNull |
| Specifies that the text field should display a blank character instead of "null" when the text field expression evaluates to null . |
| true |
| false |
| hyperlinkType |
| Indicates the type of the hyperlink element. |
| None |
| The current element doesn't represent a hyperlink. |
| Reference |
| The current hyperlink points to an external resource specified by the corresponding <hyperlinkReferenceExpression> element, usually an URL. |
| LocalAnchor |
| The current hyperlink points to a local anchor specified by the corresponding <hyperlinkAnchorExpression> element. |
| LocalPage |
| The current hyperlink points to a 1 based page index within the current document specified by the corresponding <hyperlinkPageExpression> element. |
| RemoteAnchor |
| The current hyperlink points to an anchor specified by the <hyperlinkAnchorExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element. |
| RemotePage |
| The current hyperlink points to a 1 based page index specified by the <hyperlinkPageExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element. |
| DEFAULT None |
|
textFieldExpression | top |
| Defines the expression to use for this textField. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
| class |
| Class for the text field values. |
| java.lang.Boolean |
| java.lang.Byte |
| java.util.Date |
| java.sql.Timestamp |
| java.sql.Time |
| java.lang.Double |
| java.lang.Float |
| java.lang.Integer |
| java.lang.Long |
| java.lang.Short |
| java.math.BigDecimal |
| java.lang.String |
| DEFAULT java.lang.String |
|
subreport | top |
| Definition of a subreport object. |
|
CONTAINS (
reportElement,
parametersMapExpression?,
subreportParameter*, (
connectionExpression |
dataSourceExpression )?,
subreportExpression?
) |
|
ATTRIBUTES |
| isUsingCache |
| If true, tells the report engine to cache the report definition objects that are loaded from the same location. |
| true |
| false |
| DEFAULT true |
|
parametersMapExpression | top |
| Allows bulk passing the parameters to the subreport into a java.lang.Map object. There are cases when we want to pass to the subreport the same parameters that the master report has received. This can be achieved by passing the system-defined parameter called REPORT_PARAMETERS_MAP and maybe adding to or overriding those parameters using additional <subreportParameter> elements. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
subreportParameter | top |
| Definition of a subreport parameter. |
|
CONTAINS (
subreportParameterExpression?
) |
|
ATTRIBUTES |
| name |
| The name of the parameter that will be passed when filling the subreport. |
| REQUIRED |
|
subreportParameterExpression | top |
| Definition of the expression associated with the subreport parameter. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
connectionExpression | top |
| If present, it is used to pass the java.sql.Connection object to the subreport filling routines. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
dataSourceExpression | top |
| If present, it is used to pass the dori.jasper.engine.JRDataSource object to the subreport filling routines. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
subreportExpression | top |
| Definition of the expression that will be used to determine the report object that will be loaded as a subreport. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
| class |
| Class of the image source. |
| java.lang.String |
| Subreport location. First, the report engine tries to see whether the String represents an URL. If not, it tries to find the file on disk and finally, if the String does not represent a path file, it searches in the CLASSPATH to find the report definition as a resource. |
| java.io.File |
| Subreport loaded by opening an java.io.InputStream from this java.io.File object. |
| java.net.URL |
| Subreport loaded by opening an java.io.InputStream from this java.net.URL object. |
| java.io.InputStream |
| Subreport loaded from an java.io.InputStream object. |
| dori.jasper.engine.JasperReport |
| Subreport supplied directly as a dori.jasper.engine.JasperReport object. |
| DEFAULT java.lang.String |
|
elementGroup | top |
| Element for grouping objects on the report. |
|
CONTAINS (
line |
rectangle |
ellipse |
image |
staticText |
textField |
subreport |
elementGroup
)* |
|
ATTRIBUTES |