The JasperReports Ultimate Guide Third Edition

Transcription

THE JASPERREPORTS ULTIMATE GUIDEPAGE I

THE JASPERREPORTS ULTIMATE GUIDEThe JasperReports Ultimate Guide Third EditionCopyright 2011 Jaspersoft Corporation. All rights reserved. Printed in the U.S.A.Jaspersoft, the Jaspersoft logo, Jaspersoft iReport Designer, JasperReports Library,JasperReports Server, Jaspersoft OLAP, and Jaspersoft ETL are trademarks and/or registeredtrademarks of Jaspersoft Corporation in the United States and in jurisdictions throughout theworld. All other company and product names are or may be trade names or trademarks oftheir respective owners.This is version 0811-UGJ37-6 of the JasperReports Ultimate Guide.PAGE II

THE JASPERREPORTS ULTIMATE GUIDETABLE OF CONTENTSGETTING STARTED.1INSTALLING JASPERREPORTS.1REQUIREMENTS.1X11/HEADLESS JAVA.3BUILDING THE SOURCE FILES AND RUNNING THE SAMPLES.3ANT BUILD TOOL.3BUILDING THE PROJECT FROM SOURCE FILES.4RUNNING THE SAMPLES.4HSQLDB DEMO DATABASE.4WORKING WITH REPORT TEMPLATES.6CREATING REPORT TEMPLATES.6REPORT DESIGN PREVIEW.7LOADING AND STORING REPORT TEMPLATE FILES.8COMPILING REPORT TEMPLATES.10EXPRESSIONS SCRIPTING LANGUAGE.10REPORT COMPILERS.11A BRIEF HISTORY OF REPORT COMPILATION.12CONFIGURATION PROPERTIES TO CUSTOMIZE REPORT COMPILATION.13JDT COMPILER–SPECIFIC CONFIGURATION PROPERTIES.15ANT TASKS.15ANT TASKS FOR COMPILING REPORTS.15ATTRIBUTES OF THE REPORT TEMPLATE COMPILATION TASK.16ANT TASK FOR DECOMPILING REPORTS.17ANT TASK FOR UPDATING REPORTS.17FILLING REPORT TEMPLATES.19REPORTING DATA.20GENERATED REPORTS.21FILLING ORDER (VERTICAL/HORIZONTAL FILLING).21PAGE III

THE JASPERREPORTS ULTIMATE GUIDEASYNCHRONOUS REPORT FILLING.22HANDLING GENERATED REPORTS.24LOADING AND SAVING GENERATED REPORTS.24VIEWING REPORTS.25PRINTING REPORTS.27EXPORTING REPORTS.28LARGE FILE SUPPORT.30FILE VIRTUALIZER.31SWAP FILE VIRTUALIZER.31IN-MEMORY GZIP VIRTUALIZER.32API ASPERREPORTS.ENGINE.DATA.JRBEANARRAYDATASOURCE ANAGER LOADER.39REPORT TEMPLATE STRUCTURE.40JRXML.40XSD REFERENCE.40JRXML ENCODING.41REPORT TEMPLATE PROPERTIES.42PAGE IV

THE JASPERREPORTS ULTIMATE GUIDEREPORT NAME. 43LANGUAGE. 43COLUMN COUNT. 43PRINT ORDER. 43PAGE SIZE. 44PAGE ORIENTATION.44PAGE MARGINS. 45COLUMN SIZE AND SPACING.45EMPTY DATA SOURCE BEHAVIOR.45TITLE AND SUMMARY SECTION PLACEMENT.46COLUMN FOOTER PLACEMENT.46SCRIPTLET CLASS. 46RESOURCE BUNDLE.47MISSING RESOURCES BEHAVIOR.47PAGINATION. 47FORMATTING NUMBERS, DATES, AND TIMES.47CUSTOM PROPERTIES.48IMPORTING PACKAGES.49STYLES.49REPORT STYLE NAME. 51DEFAULT REPORT STYLE.51CASCADING REPORT STYLES.51CONDITIONAL STYLES. 51REFERENCING A REPORT STYLE.53STYLE TEMPLATES. 53REPORTING DATA.56EXPRESSIONS.56SYNTAX. 57CALCULATOR. 58BUILT-IN FUNCTIONS. 59CONDITIONAL EXPRESSIONS. 59PARAMETERS.60PARAMETER NAME. 60PARAMETER CLASS. 61PROMPTING FOR PARAMETER VALUES.61PARAMETER CUSTOM PROPERTIES.61PARAMETER DEFAULT VALUE.62BUILT-IN REPORT PARAMETERS.62DATA SOURCES.67JDBC DATA SOURCE.68JAVABEANS DATA SOURCES.69MAP-BASED DATA SOURCES.71TABLEMODEL DATA SOURCE.71XML DATA SOURCES. 72PAGE V

THE JASPERREPORTS ULTIMATE GUIDECSV DATA SOURCES. 75XLS DATA SOURCES. 76EMPTY DATA SOURCES.76REWINDABLE DATA SOURCES.77DATA SOURCE PROVIDER.77REPORT QUERIES.78SQL QUERIES. 78STORED PROCEDURES. 81QUERY EXECUTER API. 81SQL QUERY EXECUTER.83XPATH QUERY EXECUTER.83HIBERNATE QUERY EXECUTER.84MDX QUERY EXECUTER. 86XMLA QUERY EXECUTER. 91EJB QL/JPA QUERY EXECUTER.93FIELDS.95FIELD NAME. 96FIELD CLASS.96FIELD DESCRIPTION.97CUSTOM FIELD PROPERTIES.97SORT FIELDS. 97VARIABLES.98VARIABLE NAME. 99VARIABLE CLASS. 99RESET TYPE.99RESET GROUP. 100INCREMENT TYPE. 100INCREMENT GROUP. 100CALCULATIONS. 100INCREMENTERS. 102BUILT-IN REPORT VARIABLES.103DATA FILTERS.104REPORT SECTIONS.105BAND CONTENT.105BAND HEIGHT.106PREVENTING BAND SPLIT.106SKIPPING BANDS.106MAIN SECTIONS.107TITLE. 107PAGE HEADER. 108COLUMN HEADER. 108DETAIL. 108COLUMN FOOTER. 108PAGE VI

THE JASPERREPORTS ULTIMATE GUIDEPAGE FOOTER. 108SUMMARY. 108LAST PAGE FOOTER.108BACKGROUND. 109NO DATA. 109DATA GROUPING.109GROUP NAME. 110STARTING A NEW PAGE OR COLUMN WHEN A GROUP BREAKS.111RESETTING PAGE NUMBER. 111GROUP HEADER. 111GROUP FOOTER. 111PREVENTING GROUP SPLIT.112MULTI-BAND SECTIONS.113REPORT ELEMENTS.114REPORT ELEMENT PROPERTIES.114ELEMENT KEY. 115STYLE. 115ABSOLUTE POSITION.115RELATIVE POSITION. 115ELEMENT SIZE. 116ELEMENT COLOR. 116ELEMENT TRANSPARENCY.117SKIPPING ELEMENT DISPLAY. 117REPRINTING ELEMENTS ON SECTION OVERFLOWS.117SUPPRESSING REPEATING VALUES DISPLAY.117REMOVING BLANK SPACE.119STRETCH BEHAVIOR. 121CUSTOM ELEMENT PROPERTIES.121TEXT ELEMENTS.123HORIZONTAL ALIGNMENT.123VERTICAL ALIGNMENT. 123ROTATING TEXT. 123LINE SPACING. 124STYLED TEXT. 124FONTS AND UNICODE SUPPORT.124STATIC TEXTS. 130TEXT FIELDS. 131STYLED TEXT AND MARKUP TEXT.134TEXT MEASURING AND TRUNCATION.136GRAPHIC ELEMENTS.138STRETCH BEHAVIOR. 139BORDER STYLE. 139BACKGROUND FILL STYLE.140LINES. 140PAGE VII

THE JASPERREPORTS ULTIMATE GUIDERECTANGLES. 140ELLIPSES. 141IMAGES. 141CHARTS AND GRAPHICS. 148BOX ELEMENTS.149BORDER STYLE. 150BORDER COLOR. 150BOX PADDING. 150HYPERLINKS, ANCHORS, AND BOOKMARKS.150CUSTOM HYPERLINKS. 154ANCHORS. 155BOOKMARKS. 155ELEMENT GROUPS.155FRAMES.156PAGE BREAKS AND COLUMN BREAKS.157GENERIC ELEMENTS.157GENERIC ELEMENT PARAMETERS. 159GENERIC ELEMENT EXPORT HANDLERS.160SUBREPORTS.161SUBREPORT OVERVIEW.161CACHING SUBREPORTS. 163SUBREPORT PARAMETERS.163SUBREPORT DATA SOURCE.164RETURNING VALUES FROM SUBREPORTS.165MASTER REPORT VARIABLE. 166USING RETURNED VALUES.166CUSTOM INCREMENTERS.166SUBREPORT RUNNERS.166DATASETS.169MAIN DATASET.169SUBDATASETS.169DATASET RUNS.

the jasperreports ultimate guide table of contents getting started.1 installing jasperreports.1 requirements.1