quick reference
 version 1.0.2
 
 

 
     
  A..D   E..L   O..S   T..Z

elementGroup
ellipse
field
fieldDescription
font
graphicElement
group
groupExpression
groupFooter
groupHeader
highExpression
highLowChart
highLowDataset
highLowPlot
hyperlinkAnchorExpression
hyperlinkPageExpression
hyperlinkReferenceExpression
image
imageExpression
import
initialValueExpression
jasperReport
keyExpression
labelExpression
lastPageFooter
line
lineChart
linePlot
lowExpression

         
 elementGrouptop 
 Element for grouping objects on the report.
 
 CONTAINS ( line | rectangle | ellipse | image | staticText | textField | subreport | elementGroup )*
 
 ATTRIBUTES
 
 ellipsetop 
 Definition of an ellipse object.
 
 CONTAINS ( reportElement, graphicElement? )
 
 ATTRIBUTES
 
 fieldtop 
 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.
 DEFAULT     java.lang.String
 
 fieldDescriptiontop 
 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
 
 fonttop 
 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
 
 graphicElementtop 
 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
 
 grouptop 
 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
 
 groupExpressiontop 
 Specifies the expression that will be evaluated at runtime to determine the group ruptures.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 groupFootertop 
 Contains the definition of the footer section for this group.
 
 CONTAINS ( band? )
 
 ATTRIBUTES
 
 groupHeadertop 
 Contains the definition of the header section for this group.
 
 CONTAINS ( band? )
 
 ATTRIBUTES
 
 highExpressiontop 
 High expresion in a <highLowchart>.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 highLowCharttop 
 Defines a high-low type chart
 
 CONTAINS ( chart, highLowDataset, highLowPlot )
 
 ATTRIBUTES
 
 highLowDatasettop 
 Defines a dataset that can be used with a <highLowChart>.
 
 CONTAINS ( dataset, seriesExpression, dateExpression , highExpression, lowExpression, closeExpression, volumeExpression )
 
 ATTRIBUTES
 
 highLowPlottop 
 Plot options for a <highLowChart>
 
 CONTAINS ( plot, timeAxisLabelExpression?, valueAxisLabelExpression? )
 
 ATTRIBUTES
 
 isShowCloseTicks
 Show close tick flag
 true
 false
 DEFAULT     true
 isShowOpenTicks
 Show open tick flag
 true
 false
 DEFAULT     true
 
 hyperlinkAnchorExpressiontop 
 Used in hyperlink elements to point to document anchors.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 hyperlinkPageExpressiontop 
 Used in hyperlink elements to point to document pages.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 hyperlinkReferenceExpressiontop 
 Used in hyperlink elements to point to external documents and resources.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 imagetop 
 Definition of an image object.
 
 CONTAINS ( reportElement, box?, 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
 isLazy
 Gives control over when the images are retrieved from their specified location.
 true
 The image is loaded from the specified location only when the document is viewed or exported to other formats.
 false
 The image is loaded during the report filling process and stored in the resulting document.
 DEFAULT     false
 onErrorType
 Controls the behavior of the engine in case the image is not available.
 Error
 An exception is raised when loading the image.
 Blank
 The exception is ignored and the image displays as blank.
 Icon
 The exception is ignored and an image replacement icon is displayed.
 DEFAULT     Error
 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.
 Band
 The image expression is evaluated after the parent band has finished rendering all the other elements.
 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
 hyperlinkTarget
 Indicates the target of the hyperlink.
 Self
 Loads the hyperlink destination document into the window in which the link was clicked.
 Blank
 Loads the hyperlink destination document into a new blank window.
 DEFAULT     Self
 
 imageExpressiontop 
 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.
 net.sf.jasperreports.engine.JRRenderable
 The image will be drawn directly on the target graphic context by a serializable instance of this interface.
 DEFAULT     java.lang.String
 
 importtop 
 Translates into an import statement inside the expression class order to eliminate the need to use complete class names in the report expressions.
 
 CONTAINS EMPTY 
 
 ATTRIBUTES
 value
 Class name or package to import.
 REQUIRED
 
 initialValueExpressiontop 
 Definition of the expression that will be used to calculate the initial value of the variable, before any calculations are made.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 jasperReporttop 
 Root element representing the definition of a report.
 
 CONTAINS ( property*, import*, reportFont*, parameter*, queryString?, field*, variable*, group*, background?, title?, pageHeader?, columnHeader?, detail?, columnFooter?, pageFooter?, lastPageFooter?, summary? )
 
 ATTRIBUTES
 name
 Name of the report.
 REQUIRED
 language
 Specifies the language used for the report expressions.
 DEFAULT     java
 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
 isFloatColumnFooter
 Flag used to specify if the column footer section should be printed at the bottom of the column or if it should immediately follow the last detail or group footer printed on the current column.
 true
 The column footer section is printed immediately after the last detail or group footer printed on the current column.
 false
 The column footer section is printed at the bottom of the current column.
 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     net.sf.jasperreports.engine.JRDefaultScriptlet
 resourceBundle
 The base name of the report associated resource bundle.
 whenResourceMissingType
 Allows customizing the way the engine deals with missing resources in the resource bundle.
 Null
 Null is returned for the missing resource.
 Empty
 An empty string is returned for the missing resource.
 Key
 The key is returned for the missing resources.
 Error
 An exception is thrown when the resource with the specified key is missing.
 DEFAULT     Null
 
 keyExpressiontop 
 Defines a key in a <pieDataset>
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 labelExpressiontop 
 Defines a label in a <pieDataset>.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 lastPageFootertop 
 The page footer section to use on the last page instead of the normal page footer. This might not be the very last page of the document in case the summary section is also present. This section is sometimes useful when summary information has to be displayed at the bottom of the last page.
 
 CONTAINS ( band? )
 
 ATTRIBUTES
 
 linetop 
 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
 
 lineCharttop 
 Defines a line chart
 
 CONTAINS ( chart, categoryDataset, linePlot )
 
 ATTRIBUTES
 
 linePlottop 
 Defines plot options for a <line chart>
 
 CONTAINS ( plot, valueAxisLabelExpression?, )
 
 ATTRIBUTES
 
 isShowLines
 Show lines flag
 true
 false
 DEFAULT     true
 isShowShapes
 Show shapes flag
 true
 false
 DEFAULT     true
 
 lowExpressiontop 
 Low expression in a <highLowChart>
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 

© 2005 JasperSoft Corporation www.jaspersoft.com