Class ReportProperties

  • All Implemented Interfaces:
    NodeParser, java.io.Serializable

    public class ReportProperties
    extends java.lang.Object
    implements java.io.Serializable, NodeParser
    The report properties describes global options for a report or sub report.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static int findPaperFormat​(int x, int y, boolean isLandscape)
      Find the best best match for paper format.
      java.lang.String[] getEnabledFormats()
      Returns the valid output formats for this report.
      int getHorizontal()
      Returns the horizontal gap between multi-column labels.
      int getLabelHeight()
      Returns the height of a multi-column label.
      java.lang.String getLabelName()
      Returns the name of a multi-column label.
      This will return the complete name for predefined labels of the i-net designer or the name you set before with setLabelName(String).
      int getLabelWidth()
      Returns the width of a multi-column label.
      int getMarginBottom()
      Returns the bottom margin of the page in twips.
      int getMarginLeft()
      Returns the left margin of the page in twips.
      int getMarginRight()
      Returns the right margin of the page in twips.
      int getMarginTop()
      Returns the top margin of the page in twips.
      int getPaperFormat()
      Returns the format of the paper as a constant.
      int getPaperHeight()
      Returns the height of the report page in twips.
      int getPaperOrient()
      Returns the orientation of the paper.
      int getPaperWidth()
      Returns the width of the report page in twips.
      java.util.Locale getReportLocale()
      Returns the default formula/resource locale defined for the current report.
      int getRowBufferSize()
      Returns the number of rows which will be cached in the row buffer.
      int getVertical()
      Returns the vertical gap between multi-column labels.
      int getXMLMajorVersion()
      Returns the major version of the report XML of the template underlying this report.
      int getXMLMinorVersion()
      Returns the minor version of the report XML of the template underlying this report.
      boolean isAcrossThenDown()
      Returns the printing direction of a multi-column report.
      boolean isCCFormat()
      Returns true if the report comes from i-net Clear Reports file format, else false.
      boolean isClipboardEnabled()
      Returns whether the clipboard is enabled for the Java Viewer, that is, whether it is possible to copy text from the Viewer to the clipboard.
      boolean isConvertNullValuesToDefault()
      If convertNullValuesToDefault is set to true the report will convert null values from the database to a 0 (for numeric fields) or a blank (for non-numeric fields).
      boolean isDistinct()
      Returns the value of the property 'distinct'.
      boolean isDOMParser()
      FOR INTERNAL USE ONLY Internal method for reading report XML
      boolean isExportEnabled()
      Returns the flag ExportEnabled for this report.
      boolean isFormatGroupsWithMultipleColumn()
      Should be group header/footer be treated as an ordinary label in a multi-column report?
      boolean isFormatWithMultipleColumns()
      Test if the detail section of the report should be formatted in multiple columns of variable or fixed (labels) length.
      boolean isFormPrint()
      Returns the flag FormPrint for this report.
      boolean isGroupTreeVisible()
      Returns the flag GroupTreeVisible for this report.
      boolean isHidePageFooterInsideReportHeader()
      Returns the value of the flag "Hide PageFooter inside ReportHeader".
      boolean isIgnoreFiltering()
      Deprecated.
      As of i-net Clear Reports 15, instead remove the record selection from the report with Report.setRecordSelectionFormula(FormulaField)
      boolean isIgnoreSorting()
      Deprecated.
      As of i-net Clear Reports 15, instead remove sort fields from the report with Fields.removeSortField(int)
      boolean isPrintingEnabled()
      Returns if printing is enabled for this report.
      boolean isSaveDatasource()
      Returns true if the used datasource configurations should save in the report file.
      boolean isShowSuppressedGroupTreeNodes()
      Returns the flag that controls the group tree nodes of suppressed group areas will be shown.
      boolean isSuppressIfNoRows()
      If suppressIfNoRows is set to true the (sub)report will only be printed if rows are fetched from the database.
      boolean isValidForRowBuffer()
      Returns whether or not this report is suited for buffering of rows.
      void parseDOM​(org.w3c.dom.Node node, java.util.Map<java.lang.String,​java.lang.Object> parserMap)
      FOR INTERNAL USE ONLY Internal method for reading report XML
      NodeParser parseElement​(com.inet.report.parser.XMLTag group, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map<java.lang.String,​java.lang.Object> parserMap)
      FOR INTERNAL USE ONLY Internal method for reading report XML
      void parseEndElement​(com.inet.report.parser.XMLTag group, java.lang.String tag, java.util.Map<java.lang.String,​java.lang.Object> parserMap)
      FOR INTERNAL USE ONLY Internal method for reading report XML
      void parseText​(java.lang.String text, java.util.Map<java.lang.String,​java.lang.Object> parserMap)
      FOR INTERNAL USE ONLY Internal method for reading report XML
      void setAcrossThenDown​(boolean acrossThenDown)
      Sets the printing direction of a multi-column report.
      void setClipboardEnabled​(boolean value)
      Enable the clipboard of the new Java Viewer.
      void setConvertNullValuesToDefault​(boolean convertNullValuesToDefault)
      If convertNullValuesToDefault is set to true the report will convert null values from the database to a 0 (for numeric fields) or a blank (for non-numeric fields).
      void setDistinct​(boolean distinct)
      Set the value of the property 'distinct'.
      void setEnabledFormats​(java.lang.String[] formats)
      Sets a list of valid formats, that is, which formats it is possible to render.
      void setExportEnabled​(boolean value)
      Enable or disable the export button and the export API of the new Java Viewer.
      void setFormatGroupsWithMultipleColumn​(boolean formatGroupsWithMultipleColumn)
      Should be group header/footer be treated as an ordinary label in a multi-column report?
      void setFormatWithMultipleColumns​(boolean val)
      Sets if the detail section of the report should be formatted in multiple columns of variable or fixed (labels) length.
      void setFormPrint​(boolean value)
      Determines whether this report is a form - forms are never automatically resized if the designed margins are larger than the printable area, rather, the area which is not printable is truncated instead.
      void setGroupTreeVisible​(boolean value)
      Enable or disable the GroupTree of the Java Viewer.
      void setHidePageFooterInsideReportHeader​(boolean hidePageFooterInsideReportHeader)
      Set value of the flag "Hide PageFooter inside ReportHeader".
      void setHorizontal​(int horizontal)
      Sets the horizontal gap between multi-column labels.
      void setIgnoreFiltering​(boolean ignoreFiltering)
      Deprecated.
      As of i-net Clear Reports 15, instead remove the record selection from the report with Report.setRecordSelectionFormula(FormulaField)
      void setIgnoreSorting​(boolean ignoreSorting)
      Deprecated.
      As of i-net Clear Reports 15, instead remove sort fields from the report with Fields.removeSortField(int)
      void setLabelHeight​(int labelHeight)
      Sets the height of a multi-column label.
      void setLabelName​(java.lang.String s)
      Sets the label name, such as "User Defined Label" or "Address"
      void setLabelWidth​(int labelWidth)
      Sets the width of a multi-column label.
      void setMarginBottom​(int margin)
      Sets the bottom margin of the page in twips.
      void setMarginLeft​(int margin)
      Sets the left margin of the page in twips.
      void setMarginRight​(int margin)
      Sets the right margin of the page in twips.
      void setMarginTop​(int margin)
      Sets the top margin of the page in twips.
      void setPaperHeight​(int height)
      Sets the height of the report page in twips.
      1 pica = 1/6 inch
      1 point = 1/12 pica
      1 twip = 1/20 point or 20 twips = 1 point
      1 twip = 1/567 centimeter or 567 twips = 1 centimeter
      1 twip = 1/1440 inch or 1440 twips = 1 inch
      void setPaperOrient​(int paperOrientation, int paperSize)
      Sets the orientation and size of the report for printing.
      void setPaperSize​(int paperOrient, int paperFormat)
      Sets the paper width and paper height depending on the supplied paper format and orientation.
      void setPaperWidth​(int width)
      Sets the width of the report page in twips.
      1 pica = 1/6 inch
      1 point = 1/12 pica
      1 twip = 1/20 point or 20 twips = 1 point
      1 twip = 1/567 centimeter or 567 twips = 1 centimeter
      1 twip = 1/1440 inch or 1440 twips = 1 inch
      void setPrintingEnabled​(boolean value)
      Enable or disable the print button and the print API of the Java Viewer.
      void setReportLocale​(java.util.Locale reportLocale)
      Sets the formula/resource default locale for the current report.
      void setRowBufferSize​(int rowCount)
      Sets the row count which will be cached during the rendering process.
      void setSaveDatasource​(boolean save)
      Set the flag if a copy of the datasource configuration should be saved in the report file.
      void setShowSuppressedGroupTreeNodes​(boolean showSuppressedGroupTreeNodes)
      Sets the flag that controls the group tree nodes of suppressed group areas will be shown.
      void setSuppressIfNoRows​(boolean suppressIfNoRows)
      If suppressIfNoRows is set to true the (sub)report will only be printed if rows are fetched from the database.
      void setVertical​(int vertical)
      Sets the vertical gap between multi-column labels.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • DEFAULT_PAPER_ORIENTATION

        public static final int DEFAULT_PAPER_ORIENTATION
        Paper orientation is system default.
        See Also:
        Constant Field Values
      • PORTRAIT

        public static final int PORTRAIT
        Paper orientation is portrait.
        See Also:
        Constant Field Values
      • LANDSCAPE

        public static final int LANDSCAPE
        Paper orientation is landscape.
        See Also:
        Constant Field Values
      • DEFAULT_PAPERSIZE

        public static final int DEFAULT_PAPERSIZE
        Paper size is system default.
        See Also:
        Constant Field Values
      • PAPER_LETTER

        public static final int PAPER_LETTER
        Paper size is LETTER, 8 1/2 x 11 in.
        See Also:
        Constant Field Values
      • PAPER_LETTER_SMALL

        public static final int PAPER_LETTER_SMALL
        Paper size is Letter Small, 8 1/2 x 11 in.
        See Also:
        Constant Field Values
      • PAPER_TABLOID

        public static final int PAPER_TABLOID
        Paper size is Tabloid, 11 x 17 in.
        See Also:
        Constant Field Values
      • PAPER_LEDGER

        public static final int PAPER_LEDGER
        Paper size is Ledger, 17 x 11 in.
        See Also:
        Constant Field Values
      • PAPER_LEGAL

        public static final int PAPER_LEGAL
        Paper size is Legal, 8 1/2 x 14 in.
        See Also:
        Constant Field Values
      • PAPER_STATEMENT

        public static final int PAPER_STATEMENT
        Paper size is Statement, 5 1/2 x 8 1/2 in.
        See Also:
        Constant Field Values
      • PAPER_EXECUTIVE

        public static final int PAPER_EXECUTIVE
        Paper size is Executive, 7 1/4 x 10 1/2 in.
        See Also:
        Constant Field Values
      • PAPER_A3

        public static final int PAPER_A3
        Paper size is A3, 297 x 420 mm.
        See Also:
        Constant Field Values
      • PAPER_A4

        public static final int PAPER_A4
        Paper size is A4, 210 x 297 mm.
        See Also:
        Constant Field Values
      • PAPER_A4_SMALL

        public static final int PAPER_A4_SMALL
        Paper size is A4 SMALL, 210 x 297 mm.
        See Also:
        Constant Field Values
      • PAPER_A5

        public static final int PAPER_A5
        Paper size is A5, 148 x 210 mm.
        See Also:
        Constant Field Values
      • PAPER_B4

        public static final int PAPER_B4
        Paper size is B4 (JIS), 257 x 364 mm.
        See Also:
        Constant Field Values
      • PAPER_B5

        public static final int PAPER_B5
        Paper size is B5 (JIS), 182 x 257 mm.
        See Also:
        Constant Field Values
      • PAPER_FOLIO

        public static final int PAPER_FOLIO
        Paper size is Folio, 8 1/2 x 13 in.
        See Also:
        Constant Field Values
      • PAPER_QUATRO

        public static final int PAPER_QUATRO
        Paper size is Quarto, 215 x 275 mm.
        See Also:
        Constant Field Values
      • PAPER_10_X_14

        public static final int PAPER_10_X_14
        Paper size is 10 x 14 in.
        See Also:
        Constant Field Values
      • PAPER_11_X_17

        public static final int PAPER_11_X_17
        Paper size is 11 x 17 in.
        See Also:
        Constant Field Values
      • PAPER_NOTE

        public static final int PAPER_NOTE
        Paper size is Note, 8 1/2 x 11 in.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_9

        public static final int PAPER_ENVELOPE_9
        Paper size is Envelope #9, 3 7/8 x 8 7/8 in.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_10

        public static final int PAPER_ENVELOPE_10
        Paper size is Envelope #10, 4 1/8 x 9 1/2 in.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_11

        public static final int PAPER_ENVELOPE_11
        Paper size is Envelope #11, 4 1/2 x 10 3/8 in.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_12

        public static final int PAPER_ENVELOPE_12
        Paper size is Envelope #12, 4 3/4 x 11 in.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_14

        public static final int PAPER_ENVELOPE_14
        Paper size is Envelope #14, 5 x 11 1/2 in.
        See Also:
        Constant Field Values
      • PAPER_C_SHEET

        public static final int PAPER_C_SHEET
        Paper size is C size sheet, 431,7 x 558,7 mm.
        See Also:
        Constant Field Values
      • PAPER_D_SHEET

        public static final int PAPER_D_SHEET
        Paper size is D size sheet, 558,7 x 863,4 mm .
        See Also:
        Constant Field Values
      • PAPER_E_SHEET

        public static final int PAPER_E_SHEET
        Paper size is E size sheet, 863,4 x 1117,4 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_DL

        public static final int PAPER_ENVELOPE_DL
        Paper size is Envelope DL, 110 x 220 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_C5

        public static final int PAPER_ENVELOPE_C5
        Paper size is Envelope C5, 162 x 229 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_C3

        public static final int PAPER_ENVELOPE_C3
        Paper size is Envelope C3, 324 x 458 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_C4

        public static final int PAPER_ENVELOPE_C4
        Paper size is Envelope C4, 229 x 324 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_C6

        public static final int PAPER_ENVELOPE_C6
        Paper size is Envelope C6, 114 x 162 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_C65

        public static final int PAPER_ENVELOPE_C65
        Paper size is Envelope C65, 114 x 229 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_B4

        public static final int PAPER_ENVELOPE_B4
        Paper size is Envelope B4, 250 x 353 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_B5

        public static final int PAPER_ENVELOPE_B5
        Paper size is Envelope B5, 176 x 250 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_B6

        public static final int PAPER_ENVELOPE_B6
        Paper size is Envelope B6, 176 x 125 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_ITALY

        public static final int PAPER_ENVELOPE_ITALY
        Paper size is Envelope Italy, 110 x 230 mm.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_MONARCH

        public static final int PAPER_ENVELOPE_MONARCH
        Paper size is Envelope Monarch, 3 7/8 x 7 1/2 in.
        See Also:
        Constant Field Values
      • PAPER_ENVELOPE_PERSONAL

        public static final int PAPER_ENVELOPE_PERSONAL
        Paper size is 6 3/4 Envelope, 3 5/8 x 6 1/2 in.
        See Also:
        Constant Field Values
      • PAPER_FANFOLD_US

        public static final int PAPER_FANFOLD_US
        Paper size is US Standard Fanfold, 14 7/8 x 11 in.
        See Also:
        Constant Field Values
      • PAPER_FANFOLD_STD_GERMAN

        public static final int PAPER_FANFOLD_STD_GERMAN
        Paper size is German Standard Fanfold, 8 1/2 x 12 in.
        See Also:
        Constant Field Values
      • PAPER_FANFOLD_LEGAL_GERMAN

        public static final int PAPER_FANFOLD_LEGAL_GERMAN
        Paper size is German Legal Fanfold, 8 1/2 x 13 in.
        See Also:
        Constant Field Values
      • PAPER_B4_ISO

        public static final int PAPER_B4_ISO
        Paper size is B4 (ISO), 250 x 353 mm.
        See Also:
        Constant Field Values
      • PAPER_JAPANESE_POSTCARD

        public static final int PAPER_JAPANESE_POSTCARD
        Paper size is Japanese Postcard, 100 x 148 mm.
        See Also:
        Constant Field Values
      • PAPER_9_X_11

        public static final int PAPER_9_X_11
        Paper size is 9 x 11 in.
        See Also:
        Constant Field Values
      • PAPER_10_X_11

        public static final int PAPER_10_X_11
        Paper size is 10 x 11 in.
        See Also:
        Constant Field Values
      • PAPER_15_X_11

        public static final int PAPER_15_X_11
        Paper size is 15 x 11 in.
        See Also:
        Constant Field Values
      • pageSizes

        public static final int[] pageSizes
        The sizes of all currently supported page formats in twips. Returns the size of a page according to a symbol (i.e. ReportProperties.PAPER_A4) with
        ReportProperties.pageSizes[2*(ReportProperties.PAPER_A4-1)]; or
        ReportProperties.pageSizes[(2*(ReportProperties.PAPER_A4-1))+1];
      • PAPER_A2

        public static final int PAPER_A2
        Paper size is A2, 420 x 594 mm.
        See Also:
        Constant Field Values
      • USERDEFINED_PAPER

        public static final int USERDEFINED_PAPER
        User Defined Paper Size
        See Also:
        Constant Field Values
    • Method Detail

      • isSuppressIfNoRows

        public boolean isSuppressIfNoRows()
        If suppressIfNoRows is set to true the (sub)report will only be printed if rows are fetched from the database. Otherwise nothing will be printed.
        Returns:
        Returns the suppressIfNoRows.
        Since:
        6.0
      • setSuppressIfNoRows

        public void setSuppressIfNoRows​(boolean suppressIfNoRows)
        If suppressIfNoRows is set to true the (sub)report will only be printed if rows are fetched from the database. Otherwise nothing will be printed.
        Parameters:
        suppressIfNoRows - The suppressIfNoRows to set.
        Since:
        6.0
      • setDistinct

        public void setDistinct​(boolean distinct)
        Set the value of the property 'distinct'. If it is true then duplicated records will not be fetched.
        Parameters:
        distinct - true if distinct records should be fetched only, else false.
        Since:
        6.1
      • isDistinct

        public boolean isDistinct()
        Returns the value of the property 'distinct'. If true duplicated records will not be fetched.
        Returns:
        true if distinct records should be fetched only, else false.
        Since:
        7.0
      • isConvertNullValuesToDefault

        public boolean isConvertNullValuesToDefault()
        If convertNullValuesToDefault is set to true the report will convert null values from the database to a 0 (for numeric fields) or a blank (for non-numeric fields).
        Returns:
        Returns the convertNullValuesToDefault
        Since:
        6.0
      • setConvertNullValuesToDefault

        public void setConvertNullValuesToDefault​(boolean convertNullValuesToDefault)
        If convertNullValuesToDefault is set to true the report will convert null values from the database to a 0 (for numeric fields) or a blank (for non-numeric fields).
        Parameters:
        convertNullValuesToDefault - The convertNullValuesToDefault to set.
        Since:
        6.0
      • isShowSuppressedGroupTreeNodes

        public boolean isShowSuppressedGroupTreeNodes()
        Returns the flag that controls the group tree nodes of suppressed group areas will be shown.
        Returns:
        the flag
        Since:
        8.1
        See Also:
        setShowSuppressedGroupTreeNodes(boolean)
      • setShowSuppressedGroupTreeNodes

        public void setShowSuppressedGroupTreeNodes​(boolean showSuppressedGroupTreeNodes)
        Sets the flag that controls the group tree nodes of suppressed group areas will be shown.
        Parameters:
        showSuppressedGroupTreeNodes - the flag
        Since:
        8.1
        See Also:
        isShowSuppressedGroupTreeNodes()
      • setRowBufferSize

        public void setRowBufferSize​(int rowCount)
        Sets the row count which will be cached during the rendering process. We advise to set this at 30000 rows. The minimum size of buffer is 3 rows. A row count of 0 disables the row buffer. Decrease this value if the engine throws OutOfMemoryError but note that this increases the rendering time.
        Parameters:
        rowCount - The amount of rows to be cached during the rendering process. 30000 is usually a good value.
        Since:
        6.1
        See Also:
        isValidForRowBuffer(), getRowBufferSize()
      • getRowBufferSize

        public int getRowBufferSize()
        Returns the number of rows which will be cached in the row buffer.
        Returns:
        Number of rows or 0 if row buffer is disabled.
        Since:
        6.1
        See Also:
        isValidForRowBuffer(), setRowBufferSize(int)
      • isValidForRowBuffer

        public boolean isValidForRowBuffer()
        Returns whether or not this report is suited for buffering of rows. Buffering rows causes the engine to only fetch parts of the data at a time, reducing memory usage, but raising the rendering time. Row buffering is intended for rendering large amounts of data. In order to use row buffering, the report should not contain groups, summary functions, charts, or crosstabs. To use row buffering, set the buffer size with setRowBufferSize.
        Returns:
        true if this report is suited for row buffering
        Since:
        6.1
        See Also:
        setRowBufferSize(int)
      • getPaperHeight

        public int getPaperHeight()
        Returns the height of the report page in twips.
        Returns:
        the paper height value
        Since:
        6.0
      • setPaperHeight

        public void setPaperHeight​(int height)
        Sets the height of the report page in twips.
        1 pica = 1/6 inch
        1 point = 1/12 pica
        1 twip = 1/20 point or 20 twips = 1 point
        1 twip = 1/567 centimeter or 567 twips = 1 centimeter
        1 twip = 1/1440 inch or 1440 twips = 1 inch
        Parameters:
        height - the new paper height
        Throws:
        java.lang.IllegalArgumentException - if height is negative or if margin top and margin bottom are greater than height.
        Since:
        6.0
      • getPaperWidth

        public int getPaperWidth()
        Returns the width of the report page in twips.
        Returns:
        the paper width value
        Since:
        6.0
      • setPaperWidth

        public void setPaperWidth​(int width)
                           throws ReportException
        Sets the width of the report page in twips.
        1 pica = 1/6 inch
        1 point = 1/12 pica
        1 twip = 1/20 point or 20 twips = 1 point
        1 twip = 1/567 centimeter or 567 twips = 1 centimeter
        1 twip = 1/1440 inch or 1440 twips = 1 inch
        Parameters:
        width - the new paper width
        Throws:
        java.lang.IllegalArgumentException - if width is negative or if margin left and margin right are greater than width.
        ReportException - The currently used Engine isn't valid anymore.
        Since:
        6.0
      • getPaperFormat

        public int getPaperFormat()
        Returns the format of the paper as a constant. See the various PAPER constants.
        Returns:
        the paper format of this report
        Since:
        6.0
      • findPaperFormat

        public static int findPaperFormat​(int x,
                                          int y,
                                          boolean isLandscape)
        Find the best best match for paper format.
        Parameters:
        x - width in Twips
        y - height in Twips
        isLandscape - true for landscape page orientation
        Returns:
        constant for paper format
        Throws:
        java.lang.IllegalArgumentException - if x or y is less than 1
        Since:
        14.0
      • getLabelWidth

        public int getLabelWidth()
        Returns the width of a multi-column label.
        Returns:
        width of multi-column label
        Since:
        6.0
      • setLabelWidth

        public void setLabelWidth​(int labelWidth)
        Sets the width of a multi-column label.
        Parameters:
        labelWidth - new label width
        Throws:
        java.lang.IllegalArgumentException - if labelWidth is negative
        Since:
        6.0
      • getLabelHeight

        public int getLabelHeight()
        Returns the height of a multi-column label.
        Returns:
        height of multi-column label
        Since:
        6.0
      • setLabelHeight

        public void setLabelHeight​(int labelHeight)
        Sets the height of a multi-column label.
        Parameters:
        labelHeight - new height
        Throws:
        java.lang.IllegalArgumentException - if labelHeight is negative
        Since:
        6.0
      • getHorizontal

        public int getHorizontal()
        Returns the horizontal gap between multi-column labels.
        Returns:
        horizontal gap between labels
        Since:
        6.0
      • setHorizontal

        public void setHorizontal​(int horizontal)
        Sets the horizontal gap between multi-column labels.
        Parameters:
        horizontal - new gap
        Throws:
        java.lang.IllegalArgumentException - if horizontal is negative
        Since:
        6.0
      • getVertical

        public int getVertical()
        Returns the vertical gap between multi-column labels.
        Returns:
        vertical gap between labels
        Since:
        6.0
      • setVertical

        public void setVertical​(int vertical)
        Sets the vertical gap between multi-column labels.
        Parameters:
        vertical - new gap
        Throws:
        java.lang.IllegalArgumentException - if vertical is negative
        Since:
        6.0
      • setLabelName

        public void setLabelName​(java.lang.String s)
        Sets the label name, such as "User Defined Label" or "Address"
        Parameters:
        s - label name to set.
        Since:
        6.0
        See Also:
        getLabelName()
      • getLabelName

        public java.lang.String getLabelName()
        Returns the name of a multi-column label.
        This will return the complete name for predefined labels of the i-net designer or the name you set before with setLabelName(String).
        Returns:
        String type of the multi-column label
        Since:
        6.0
      • isAcrossThenDown

        public boolean isAcrossThenDown()
        Returns the printing direction of a multi-column report.
        Returns:
        true if printing goes first across the page (left-right-top-down), false otherwise.
        Since:
        7.0
      • setAcrossThenDown

        public void setAcrossThenDown​(boolean acrossThenDown)
        Sets the printing direction of a multi-column report.
        Parameters:
        acrossThenDown - true if printing goes first across the page (left-right-top-down)
        Since:
        6.0
      • isFormatGroupsWithMultipleColumn

        public boolean isFormatGroupsWithMultipleColumn()
        Should be group header/footer be treated as an ordinary label in a multi-column report?
        Returns:
        true if the group's header/footer are lined up with the other fields in a multi-column report, false otherwise.
        Since:
        7.0
      • setFormatGroupsWithMultipleColumn

        public void setFormatGroupsWithMultipleColumn​(boolean formatGroupsWithMultipleColumn)
        Should be group header/footer be treated as an ordinary label in a multi-column report?
        Parameters:
        formatGroupsWithMultipleColumn - true if the group's header/footer should be lined up with the other fields in a multi-column report
        Since:
        6.0
      • setMarginTop

        public void setMarginTop​(int margin)
        Sets the top margin of the page in twips.
        Parameters:
        margin - the new top margin
        Throws:
        java.lang.IllegalArgumentException - if margin is negative or if top and bottom margin are greater than page height
        Since:
        6.0
      • getMarginTop

        public int getMarginTop()
        Returns the top margin of the page in twips.
        Returns:
        the top margin value
        Since:
        6.0
      • setMarginBottom

        public void setMarginBottom​(int margin)
        Sets the bottom margin of the page in twips.
        Parameters:
        margin - the new bottom margin
        Throws:
        java.lang.IllegalArgumentException - if margin is negative or if top and bottom margin are greater than page height
        Since:
        6.0
      • getMarginBottom

        public int getMarginBottom()
        Returns the bottom margin of the page in twips.
        Returns:
        the bottom margin value
        Since:
        6.0
      • setMarginLeft

        public void setMarginLeft​(int margin)
                           throws ReportException
        Sets the left margin of the page in twips.
        Parameters:
        margin - the new left margin
        Throws:
        java.lang.IllegalArgumentException - if margin is negative
        ReportException - if left and right margin are greater than page width
        Since:
        6.0
      • getMarginLeft

        public int getMarginLeft()
        Returns the left margin of the page in twips.
        Returns:
        the left margin value
        Since:
        6.0
      • setMarginRight

        public void setMarginRight​(int margin)
                            throws ReportException
        Sets the right margin of the page in twips.
        Parameters:
        margin - the new right margin
        Throws:
        ReportException - if left and right margin are greater than page width
        java.lang.IllegalArgumentException - if margin is negative
        Since:
        6.0
      • getMarginRight

        public int getMarginRight()
        Returns the right margin of the page in twips.
        Returns:
        the right margin value
        Since:
        6.0
      • isFormatWithMultipleColumns

        public boolean isFormatWithMultipleColumns()
        Test if the detail section of the report should be formatted in multiple columns of variable or fixed (labels) length.
        Returns:
        true if the detail section should be formatted with multiple columns, false otherwise.
        Since:
        6.0
      • setFormatWithMultipleColumns

        public void setFormatWithMultipleColumns​(boolean val)
        Sets if the detail section of the report should be formatted in multiple columns of variable or fixed (labels) length.
        Parameters:
        val - true if the detail section should be formatted with multiple columns, false otherwise.
        Since:
        6.0
      • setPaperSize

        public void setPaperSize​(int paperOrient,
                                 int paperFormat)
                          throws ReportException
        Sets the paper width and paper height depending on the supplied paper format and orientation. If the paper format is one of the pre-defined like PAPER_A4 then the paper width smaller side of the paper for PORTRAIT orientation and the paper height the wider side or vise versa for LANDSCAPE. If the paper format is USERDEFINED_PAPER then the width and height are not changed as they have to be set manually. In case the paper format is DEFAULT_PAPERSIZE the width and height will be set using the default paper size defined in the i-net Clear Reports configuration regarding the supplied paper orientation. If an unknown paper format is supplied a warning will be written to the log and paper format PAPER_LETTER will be set.
        Parameters:
        paperOrient - The paper orientation to set for this report.
        paperFormat - The paper format to set for this report.
        Throws:
        ReportException - If an invalid page width shall be set.
        Since:
        6.0
      • isHidePageFooterInsideReportHeader

        public boolean isHidePageFooterInsideReportHeader()
        Returns the value of the flag "Hide PageFooter inside ReportHeader".
        Returns:
        true if the page footer will be hidden inside the report header, false otherwise.
        Since:
        6.0
        See Also:
        setHidePageFooterInsideReportHeader(boolean)
      • setHidePageFooterInsideReportHeader

        public void setHidePageFooterInsideReportHeader​(boolean hidePageFooterInsideReportHeader)
        Set value of the flag "Hide PageFooter inside ReportHeader". If the flag is true and the ReportHeader span over multiple pages then no PageFooter is printed before the ReportHeader is finish.
        Parameters:
        hidePageFooterInsideReportHeader - true if the page footer will be hidden inside the report header, false otherwise.
        Since:
        6.0
        See Also:
        isHidePageFooterInsideReportHeader()
      • setFormPrint

        public void setFormPrint​(boolean value)
        Determines whether this report is a form - forms are never automatically resized if the designed margins are larger than the printable area, rather, the area which is not printable is truncated instead. The default value is false.
        Parameters:
        value - true if form print will be enabled for this report, false otherwise.
        Since:
        7.0
      • isFormPrint

        public boolean isFormPrint()
        Returns the flag FormPrint for this report.
        Returns:
        true if form print is enabled for this report, false otherwise.
        Since:
        7.0
        See Also:
        setFormPrint(boolean)
      • setPrintingEnabled

        public void setPrintingEnabled​(boolean value)
        Enable or disable the print button and the print API of the Java Viewer.
        • Disabled, Viewer API print methods will have no effect.
        • Enabled, the button can be modified with the API.
        The default value is false.
        Parameters:
        value - true if printing will be enabled, false otherwise.
        Since:
        7.0
        See Also:
        isPrintingEnabled()
      • isPrintingEnabled

        public boolean isPrintingEnabled()
        Returns if printing is enabled for this report.
        Returns:
        true if printing is enabled for this report, false otherwise.
        Since:
        7.0
        See Also:
        setPrintingEnabled(boolean)
      • setEnabledFormats

        public void setEnabledFormats​(java.lang.String[] formats)
        Sets a list of valid formats, that is, which formats it is possible to render. All values that can be used in the Engine Constructor are valid.
        Parameters:
        formats - export formats which are valid for this report, null if all formats are valid
        Since:
        7.0
        See Also:
        Engine(String), getEnabledFormats()
      • getEnabledFormats

        public java.lang.String[] getEnabledFormats()
        Returns the valid output formats for this report.
        Returns:
        the export formats which are valid for this report or null if all formats are valid
        Since:
        7.0
        See Also:
        setEnabledFormats(String[])
      • setClipboardEnabled

        public void setClipboardEnabled​(boolean value)
        Enable the clipboard of the new Java Viewer. If disabled, then the user can't copy text from the viewer to the clipboard. This setting is on by default.
        Parameters:
        value - true if the clipboard will be enabled for this report, false otherwise.
        Since:
        7.0
        See Also:
        isClipboardEnabled()
      • isClipboardEnabled

        public boolean isClipboardEnabled()
        Returns whether the clipboard is enabled for the Java Viewer, that is, whether it is possible to copy text from the Viewer to the clipboard.
        Returns:
        true if the clipboard is enabled for this report, false otherwise.
        Since:
        7.0
        See Also:
        setClipboardEnabled(boolean)
      • setExportEnabled

        public void setExportEnabled​(boolean value)
        Enable or disable the export button and the export API of the new Java Viewer. If disabled, the viewer API export methods will have no effect. If enabled, the button can be modified with the API.
        Parameters:
        value - true if the export will be enabled for this report, false otherwise.
        Since:
        7.0
        See Also:
        isExportEnabled()
      • isExportEnabled

        public boolean isExportEnabled()
        Returns the flag ExportEnabled for this report.
        Returns:
        true if the export is enabled for this report, false otherwise.
        Since:
        7.0
        See Also:
        setExportEnabled(boolean)
      • setGroupTreeVisible

        public void setGroupTreeVisible​(boolean value)
        Enable or disable the GroupTree of the Java Viewer. If disabled, the viewer API group tree methods will have no effect. If enabled, the button can be modified with the API.
        Parameters:
        value - true if the group tree will be visible for this report, false otherwise.
        Since:
        7.0
        See Also:
        isGroupTreeVisible()
      • isGroupTreeVisible

        public boolean isGroupTreeVisible()
        Returns the flag GroupTreeVisible for this report.
        Returns:
        true if the group tree is visible for this report, false otherwise.
        Since:
        7.0
        See Also:
        setGroupTreeVisible(boolean)
      • isIgnoreSorting

        @Deprecated
        public boolean isIgnoreSorting()
        Deprecated.
        As of i-net Clear Reports 15, instead remove sort fields from the report with Fields.removeSortField(int)
        Returns the flag that indicates whether or not the sorting performed on engine.
        Returns:
        true if sorting is not performed on engine, false otherwise.
        Since:
        7.7
        See Also:
        setIgnoreSorting(boolean)
      • setIgnoreSorting

        @Deprecated
        public void setIgnoreSorting​(boolean ignoreSorting)
        Deprecated.
        As of i-net Clear Reports 15, instead remove sort fields from the report with Fields.removeSortField(int)
        Sets the flag that deactivates the sorting on engine. You can use this flag to deactivate the sorting on engine by setSQL, setData, Command. Note this flag do not takes effect if your report contains a group with specified, by summary or hierarchical sort order.
        Parameters:
        ignoreSorting - the flag, default false.
        Since:
        7.7
        See Also:
        isIgnoreSorting(), setIgnoreFiltering(boolean)
      • isIgnoreFiltering

        @Deprecated
        public boolean isIgnoreFiltering()
        Deprecated.
        As of i-net Clear Reports 15, instead remove the record selection from the report with Report.setRecordSelectionFormula(FormulaField)
        Returns whether the data filtering performed on engine or not.
        Returns:
        true if data filtering is not performed on engine, false otherwise.
        Since:
        7.7
        See Also:
        setIgnoreFiltering(boolean)
      • setIgnoreFiltering

        @Deprecated
        public void setIgnoreFiltering​(boolean ignoreFiltering)
        Deprecated.
        As of i-net Clear Reports 15, instead remove the record selection from the report with Report.setRecordSelectionFormula(FormulaField)
        Set if the data filtering on engine should be deactivated or not. You can use this flag to deactivate the filtering on engine by setSQL, setData, Command.
        Parameters:
        ignoreFiltering - true if data filtering on engine should be deactivated, false otherwise.
        Since:
        7.7
        See Also:
        isIgnoreFiltering(), setIgnoreSorting(boolean)
      • parseElement

        public NodeParser parseElement​(com.inet.report.parser.XMLTag group,
                                       java.lang.String tag,
                                       org.xml.sax.Attributes atts,
                                       java.util.Map<java.lang.String,​java.lang.Object> parserMap)
                                throws FatalParserException
        FOR INTERNAL USE ONLY Internal method for reading report XML

        Parses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.

        Specified by:
        parseElement in interface NodeParser
        Parameters:
        group - XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.
        tag - The XMLTag to be parsed
        atts - The set of attributes in the current XMLTag
        parserMap - The map of current Parser.
        Returns:
        The NodeParser sub-element if one needed to be created, or null if none was created.
        Throws:
        FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
      • parseText

        public void parseText​(java.lang.String text,
                              java.util.Map<java.lang.String,​java.lang.Object> parserMap)
        FOR INTERNAL USE ONLY Internal method for reading report XML

        This method is called if text was encountered in the context of this node. (Examples would be a formula's text or a text element's text)

        Specified by:
        parseText in interface NodeParser
        Parameters:
        text - text encountered and to be stored
        parserMap - The map of current Parser.
      • parseEndElement

        public void parseEndElement​(com.inet.report.parser.XMLTag group,
                                    java.lang.String tag,
                                    java.util.Map<java.lang.String,​java.lang.Object> parserMap)
                             throws FatalParserException
        FOR INTERNAL USE ONLY Internal method for reading report XML

        Receive notification of the end of an XML tag.

        Specified by:
        parseEndElement in interface NodeParser
        Parameters:
        group - XMLTag of the current node to be parsed, or null if there is no such current group.
        tag - The XMLTag to be parsed
        parserMap - The map of current Parser.
        Throws:
        FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
      • isDOMParser

        public boolean isDOMParser()
        FOR INTERNAL USE ONLY Internal method for reading report XML

        Returns whether this node is to be read via a DOM parser.

        Specified by:
        isDOMParser in interface NodeParser
        Returns:
        true if this node is to be read via a DOM parser, false otherwise.
      • parseDOM

        public void parseDOM​(org.w3c.dom.Node node,
                             java.util.Map<java.lang.String,​java.lang.Object> parserMap)
                      throws FatalParserException
        FOR INTERNAL USE ONLY Internal method for reading report XML

        Parses the node.

        Specified by:
        parseDOM in interface NodeParser
        Parameters:
        node - the node
        parserMap - The map of current Parser.
        Throws:
        FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
      • setReportLocale

        public void setReportLocale​(java.util.Locale reportLocale)
        Sets the formula/resource default locale for the current report. If the report locale is set, any call to get the servers default locale will return the report locale instead, while the report gets rendered.
        Invoking Engine.setLocale(Locale) or Engine.setClientLocale(Locale) will override the report locale, because the report locale only replaces the default locale.
        Parameters:
        reportLocale - The new default locale for the current report. If null, the locale of the Java Virtual Machine will be used as default locale.
        Since:
        8.2
        See Also:
        getReportLocale(), Engine.setLocale(Locale), Engine.setClientLocale(Locale)
      • getReportLocale

        public java.util.Locale getReportLocale()
        Returns the default formula/resource locale defined for the current report. If this property is not set, it will return null.
        This locale does not reflect, which locale is used to render the report because it might be overridden by Engine.setLocale(Locale) or Engine.setClientLocale(Locale). It only indicates, which default will be used.
        Returns:
        The default locale set by the report or null, if this property is not set.
        Since:
        8.2
        See Also:
        setReportLocale(Locale)
      • isCCFormat

        public boolean isCCFormat()
        Returns true if the report comes from i-net Clear Reports file format, else false.
        Returns:
        Whether or not the report is based on a template in i-net Clear Reports RPT format.
        Since:
        9.0
      • getXMLMajorVersion

        public int getXMLMajorVersion()
        Returns the major version of the report XML of the template underlying this report. Note: returns -1 if the report template underlying this report is not XML-based. For example, a report created with i-net Crystal-Clear 8.2 would return 8.
        Returns:
        the major version of the XML of the template underlying this report. -1 if not XML-based
        Since:
        9.0
      • getXMLMinorVersion

        public int getXMLMinorVersion()
        Returns the minor version of the report XML of the template underlying this report. Note: returns -1 if the report template underlying this report is not XML-based. For example, a report created with i-net Crystal-Clear 8.2 would return 2.
        Returns:
        the minor version of the XML of the template underlying this report. -1 if not XML-based
        Since:
        9.0
      • setSaveDatasource

        public void setSaveDatasource​(boolean save)
        Set the flag if a copy of the datasource configuration should be saved in the report file. NOTE: THIS WILL ENABLE ANYONE WITH THIS REPORT TEMPLATE TO ACCESS THE DATA IN YOUR DATA SOURCE.
        Parameters:
        save - true, save the datasource configuration with next save
        Since:
        9.2
      • isSaveDatasource

        public boolean isSaveDatasource()
        Returns true if the used datasource configurations should save in the report file. This is helpful if the report is used on different computers in a intranet.
        Returns:
        true, if a copy is saved.
        Since:
        9.2