Package net.sf.jasperreports.engine

Class JasperPrint

  • All Implemented Interfaces:
    java.io.Serializable, JRChangeEventsSupport, JRPropertiesHolder
    Direct Known Subclasses:
    ReadOnlyPartJasperPrint
    public class JasperPrint
extends java.lang.Object
implements java.io.Serializable, JRPropertiesHolder, JRChangeEventsSupport
    An instance of this class represents a page-oriented document that can be viewed, printed or exported to other formats.

    When filling report designs with data, the engine produces instances of this class and these can be transferred over the network, stored in a serialized form on disk or exported to various other formats like PDF, HTML, XLS, CSV or XML.

    Author:
    Teodor Danciu (teodord@users.sourceforge.net)
    See Also:
    Serialized Form

    • Constructor Detail

      • JasperPrint

        public JasperPrint()
        Creates a new empty document.

      • JasperPrint

        protected JasperPrint​(java.util.List<JRPrintPage> pages)

    • Method Detail

      • setJasperReportsContext

        public void setJasperReportsContext​(JasperReportsContext jasperReportsContext)

      • getName

        public java.lang.String getName()
        Returns:
        Returns the name of the document

      • setName

        public void setName​(java.lang.String name)
        Sets the name of the document.
        Parameters:
        name - name of the document

      • getPageFormat

        public PrintPageFormat getPageFormat​(int pageIndex)
        Returns:
        Returns the page format for specified page index.

      • getPageWidth

        public int getPageWidth()
        Returns:
        Returns the page width

      • setPageWidth

        public void setPageWidth​(int pageWidth)
        Sets the page width.
        Parameters:
        pageWidth - page width

      • getPageHeight

        public int getPageHeight()
        Returns:
        Returns the page height.

      • setPageHeight

        public void setPageHeight​(int pageHeight)
        Sets the page height.
        Parameters:
        pageHeight - page height

      • getTopMargin

        public java.lang.Integer getTopMargin()
        Returns:
        Returns the top page margin

      • setTopMargin

        public void setTopMargin​(java.lang.Integer topMargin)
        Sets the top page margin.
        Parameters:
        topMargin - top page margin

      • getLeftMargin

        public java.lang.Integer getLeftMargin()
        Returns:
        Returns the left page margin

      • setLeftMargin

        public void setLeftMargin​(java.lang.Integer leftMargin)
        Sets the left page margin.
        Parameters:
        leftMargin - left page margin

      • getBottomMargin

        public java.lang.Integer getBottomMargin()
        Returns:
        Returns the bottom page margin

      • setBottomMargin

        public void setBottomMargin​(java.lang.Integer bottomMargin)
        Sets the bottom page margin.
        Parameters:
        bottomMargin - bottom page margin

      • getRightMargin

        public java.lang.Integer getRightMargin()
        Returns:
        Returns the right page margin

      • setRightMargin

        public void setRightMargin​(java.lang.Integer rightMargin)
        Sets the right page margin.
        Parameters:
        rightMargin - right page margin

      • hasProperties

        public boolean hasProperties()
        Description copied from interface: JRPropertiesHolder
        Checks whether the object has any properties.
        Specified by:
        hasProperties in interface JRPropertiesHolder
        Returns:
        whether the object has any properties

      • getPropertyNames

        public java.lang.String[] getPropertyNames()

      • getProperty

        public java.lang.String getProperty​(java.lang.String propName)

      • setProperty

        public void setProperty​(java.lang.String propName,
                        java.lang.String value)

      • removeProperty

        public void removeProperty​(java.lang.String propName)

      • getDefaultStyle

        public JRStyle getDefaultStyle()
        Returns the default report style.

      • setDefaultStyle

        public void setDefaultStyle​(JRStyle style)
        Sets the default report style.

      • getDefaultStyleProvider

        public JRDefaultStyleProvider getDefaultStyleProvider()
        When we want to virtualize pages, we want a style provider that is not the print object itself.

      • getStyles

        public JRStyle[] getStyles()
        Gets an array of report styles.

      • getStylesList

        public java.util.List<JRStyle> getStylesList()
        Gets a list of report styles.

      • getStylesMap

        public java.util.Map<java.lang.String,​JRStyle> getStylesMap()
        Gets a map of report styles.

      • addStyle

        public void addStyle​(JRStyle style,
                     boolean isIgnoreDuplicate)
              throws JRException
        Adds a new style to the report styles.
        Throws:
        JRException

      • removeStyle

        public JRStyle removeStyle​(java.lang.String styleName)

      • getOrigins

        public JROrigin[] getOrigins()
        Gets an array of report origins.

      • getOriginsList

        public java.util.List<JROrigin> getOriginsList()
        Gets a list of report origins.

      • getOriginsMap

        public java.util.Map<JROrigin,​java.lang.Integer> getOriginsMap()
        Gets a map of report origins.

      • addOrigin

        public void addOrigin​(JROrigin origin)
        Adds a new style to the report origins.

      • hasParts

        public boolean hasParts()
        Determines whether this document contains parts.
        Returns:
        whether this document contains parts
        See Also:
        getParts()

      • getParts

        public PrintParts getParts()
        Returns a list of all parts in the filled report.

      • addPart

        public void addPart​(int pageIndex,
                    PrintPart part)
        Adds a new part to the document.

      • removePart

        public PrintPart removePart​(int pageIndex)
        Removes a part from the document.

      • getPages

        public java.util.List<JRPrintPage> getPages()
        Returns a list of all pages in the filled report.

      • addPage

        public void addPage​(JRPrintPage page)
        Adds a new page to the document.

      • addPage

        public void addPage​(int index,
                    JRPrintPage page)
        Adds a new page to the document, placing it at the specified index.

      • removePage

        public JRPrintPage removePage​(int index)
        Removes a page from the document.

      • getBookmarks

        public java.util.List<PrintBookmark> getBookmarks()

      • addBookmark

        public void addBookmark​(PrintBookmark bookmark)
        Adds a new page to the document.

      • setBookmarks

        public void setBookmarks​(java.util.List<PrintBookmark> bookmarks)

      • getAnchorIndexes

        public java.util.Map<java.lang.String,​JRPrintAnchorIndex> getAnchorIndexes()

      • collectAnchors

        protected void collectAnchors​(java.util.Collection<JRPrintElement> elements,
                              int pageIndex,
                              int offsetX,
                              int offsetY)

      • getFormatFactoryClass

        public java.lang.String getFormatFactoryClass()
        Returns the name of the class implementing the FormatFactory interface to use with this document.

      • setFormatFactoryClass

        public void setFormatFactoryClass​(java.lang.String formatFactoryClass)
        Sets the name of the class implementing the FormatFactory interface to use with this document.

      • getLocaleCode

        public java.lang.String getLocaleCode()
        Returns the code of the default java.util.Locale to be used for the elements of this print object.

        When filling a report, the value of the REPORT_LOCALE parameter (or the default locale if the parameter has no explicit value) is saved using this attribute. Some elements (e.g. elements rendered by a subreport) in the print object can override this default locale.

        Returns:
        the code of the default java.util.Locale for this object
        See Also:
        JRPrintText.getLocaleCode()

      • setLocaleCode

        public void setLocaleCode​(java.lang.String localeCode)
        Sets the the code of the default java.util.Locale to be used for this object.
        Parameters:
        localeCode - the locale code, using the java.util.Locale.toString() convention.
        See Also:
        getLocaleCode(), Locale.toString()

      • getTimeZoneId

        public java.lang.String getTimeZoneId()
        Returns the ID of the default java.util.TimeZone to be used for the elements of this print object.

        When filling a report, the value of the REPORT_TIME_ZONE parameter (or the default time zine if the parameter has no explicit value) is saved using this attribute. Some elements (e.g. elements rendered by a subreport) in the print object can override this default time zone.

        Returns:
        the ID of the default java.util.TimeZone for this object
        See Also:
        JRPrintText.getTimeZoneId()

      • setTimeZoneId

        public void setTimeZoneId​(java.lang.String timeZoneId)
        Sets the the ID of the default java.util.TimeZone to be used for this object.
        Parameters:
        timeZoneId - the time zone ID
        See Also:
        getTimeZoneId(), TimeZone.getID()

      • copyFrom

        public void copyFrom​(JasperPrint jasperPrint)

      • hasEventSupport

        protected boolean hasEventSupport()