Package com.inet.report

Class Box

    • Method Detail

      • getCornerEllipseHeight

        public int getCornerEllipseHeight()
        Returns the value of the property 'corner ellipse height'. This property allows you to round off the edges of the box. The result depends on the form of the box; if it was a square the result becomes more and more a circle with using greater values; if it was a rectangle it becomes an ellipse.
        Specified by:
        getCornerEllipseHeight in interface BoxProperties
        Returns:
        The current value of the property 'corner ellipse height'.
        Since:
        3.0

      • setCornerEllipseHeight

        public void setCornerEllipseHeight​(int newValue)
        Sets the value of the property 'corner ellipse height'. This property allows you to round off the edges of the box. The result depends on the form of the box; if it was a square the result becomes more and more a circle with using greater values; if it was a rectangle it becomes an ellipse.
        Specified by:
        setCornerEllipseHeight in interface BoxProperties
        Parameters:
        newValue - The new value of the property 'corner ellipse height'.
        Throws:
        java.lang.IllegalArgumentException - if newValue is negative
        Since:
        3.0

      • getCornerEllipseWidth

        public int getCornerEllipseWidth()
        Returns the value of the property 'corner ellipse width'. This property allows you to round off the edges of the box. The result depends on the form of the box; if it was a square the result becomes more and more a circle with using greater values; if it was a rectangle it becomes an ellipse.
        Specified by:
        getCornerEllipseWidth in interface BoxProperties
        Returns:
        The current value of the property 'corner ellipse width'.
        Since:
        3.0

      • setCornerEllipseWidth

        public void setCornerEllipseWidth​(int newValue)
        Sets the value of the property 'corner ellipse width'. This property allows you to round off the edges of the box. The result depends on the form of the box; if it was a square the result becomes more and more a circle with using greater values; if it was a rectangle it becomes an ellipse.
        Specified by:
        setCornerEllipseWidth in interface BoxProperties
        Parameters:
        newValue - The new value of the property 'corner ellipse width'.
        Throws:
        java.lang.IllegalArgumentException - if newValue is negative
        Since:
        3.0

      • isCloseBorderOnPageBreak

        public boolean isCloseBorderOnPageBreak()
        Returns the value of the property 'close border on page break'. If this property is enabled and if the element has a border and will break over two pages, then the border of both parts will be closed (on bottom of the first, on top of the second part). If not the borders of both parts will be partial (on bottom of the first, on top of the second part are no borders).
        Specified by:
        isCloseBorderOnPageBreak in interface BorderProperties
        Specified by:
        isCloseBorderOnPageBreak in interface BoxProperties
        Overrides:
        isCloseBorderOnPageBreak in class Element
        Returns:
        FormulaField The value of the property 'close border on page break'.

      • setCloseBorderOnPageBreak

        public void setCloseBorderOnPageBreak​(boolean newValue)
        Sets the value of the property 'close border on page break'. If this property is enabled and if the element has a border and will break over two pages, then the border of both parts will be closed (on bottom of the first, on top of the second part). If not the borders of both parts will be partial (on bottom of the first, on top of the second part are no borders).
        Specified by:
        setCloseBorderOnPageBreak in interface BorderProperties
        Specified by:
        setCloseBorderOnPageBreak in interface BoxProperties
        Overrides:
        setCloseBorderOnPageBreak in class Element
        Parameters:
        newValue - The new value of the property 'close border on page break'.

      • 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 FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY 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
        Overrides:
        parseElement in class AbstractLineElement
        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.

      • getSubComponents

        public java.util.List<? extends ReportComponent> getSubComponents()
        Returns all ReportComponents that are descendants of this one. E.G. this will return all Element of a Section. But it's as well useful for CrossTabs or Text elements which have additional elements.
        Specified by:
        getSubComponents in class ReportComponent
        Returns:
        a list with all sub components which can be empty as well; will be null if the component has no descendants