Package com.inet.report

Class CrossTabDescriptionSection

  • All Implemented Interfaces:
    NodeParser, com.inet.report.ReferenceHolder, SimpleElementContainer, java.io.Serializable
    public class CrossTabDescriptionSection
extends ReportComponent
implements SimpleElementContainer
    Description section for the Crosstab. It can be used to insert elements into the upper left corner of the crosstab to add some additional information to the crosstab.
    Since:
    6.0
    See Also:
    Serialized Form

    • Method Detail

      • addBox

        public Box addBox​(int boxX,
                  int boxY,
                  int boxWidth,
                  int boxHeight)
        Adds a new box to the container and returns it.
        Specified by:
        addBox in interface SimpleElementContainer
        Parameters:
        boxX - The horizontal offset in twips.
        boxY - The vertical offset in twips.
        boxWidth - The width of the box in twips.
        boxHeight - The height of the box in twips.
        Returns:
        The created box element or null if the creation was not successful

      • addJavaBean

        public JavaBean addJavaBean​(java.lang.String className,
                            int beanX,
                            int beanY,
                            int beanWidth,
                            int beanHeight)
                     throws ReportException
        Add a new JavaBean to the container. The class of the Java Bean need to be extends form java.awt.Component.
        Specified by:
        addJavaBean in interface SimpleElementContainer
        Parameters:
        className - The class name of the Java Bean.
        beanX - The x-coordinate of the upper left corner in twips.
        beanY - The y-coordinate of the upper left corner in twips.
        beanWidth - The width of the new fieldElement in twips.
        beanHeight - The height of the new fieldElement in twips.
        Returns:
        The created JavaBean.
        Throws:
        ReportException - if the Java Bean cannot created.

      • addDatabasePicture

        public DatabasePicture addDatabasePicture​(Field field,
                                          int pictureX,
                                          int pictureY,
                                          int pictureWidth,
                                          int pictureHeight)
        Adds a new DatabasePicture to the container and returns it.
        Specified by:
        addDatabasePicture in interface SimpleElementContainer
        Parameters:
        field - Field which value type is Field.BINARY and that should be added to the container. This can be a database field, a formula field, a prompt field or a SQL field.
        pictureX - x-coordinate of the upper left corner in twips.
        pictureY - y-coordinate of the upper left corner in twips.
        pictureWidth - Width of the new fieldElement in twips.
        pictureHeight - Height of the new fieldElement in twips.
        Returns:
        new created DatabasePicture

      • addText

        public Text addText​(int textX,
                    int textY,
                    int textWidth,
                    int textHeight)
        Adds a new text element to the container. To fill a new line into this text element use addParagraph method. The returned text element is empty, that means it contains no paragraph object.
        Specified by:
        addText in interface SimpleElementContainer
        Parameters:
        textX - the x offset of the text element
        textY - the y offset of the text element
        textWidth - the width of the text element
        textHeight - the height of the text element
        Returns:
        the created text element.

      • addHorizontalLine

        public Line addHorizontalLine​(int xpos,
                              int ypos,
                              int lineLength)
        Adds a new horizontal line to the container and returns it.
        Specified by:
        addHorizontalLine in interface SimpleElementContainer
        Parameters:
        xpos - the horizontal offset of the start point in twips.
        ypos - the vertical offset of the start point in twips.
        lineLength - the width of the line in twips.
        Returns:
        the created line element

      • addVerticalLine

        public Line addVerticalLine​(int xpos,
                            int ypos,
                            int lineLength)
        Adds a new vertical line to the container and returns it.
        Specified by:
        addVerticalLine in interface SimpleElementContainer
        Parameters:
        xpos - the horizontal offset of the start point in twips.
        ypos - the vertical offset of the start point in twips.
        lineLength - the height of the line in twips.
        Returns:
        the created line element

      • remove

        public void remove​(Element elem)
        Removes the given report element from the container.
        Specified by:
        remove in interface SimpleElementContainer
        Parameters:
        elem - The Report Element which should be removed from the container (null is not permitted).

      • contains

        public boolean contains​(Element el)
        Tests if the specified element is a component in this section.
        Parameters:
        el - an element.
        Returns:
        true if and only if the specified element is the same as a component in this section, as determined by the equals method; false otherwise.
        Since:
        6.0

      • setX

        public void setX​(int x)
        This element can not be moved. Invoking this method will have no effect.
        Overrides:
        setX in class ReportComponent
        Parameters:
        x - has no effect
        Since:
        6.0

      • setY

        public void setY​(int y)
        This element can not be moved. Invoking this method will have no effect.
        Overrides:
        setY in class ReportComponent
        Parameters:
        y - has no effect
        Since:
        6.0

      • getX

        public int getX()
        Returns the x position of the left upper corner of the element in the report. Use the 'object x position' property the adjust the element position from the left side margin. The unit is in twips.
        Overrides:
        getX in class ReportComponent
        Returns:
        The x position in twips.

      • getY

        public int getY()
        Returns the y position of the left upper corner of the element in the report. Use the 'object y position' property the adjust the element position from the top margin. The unit is in twips.
        Overrides:
        getY in class ReportComponent
        Returns:
        The y position in twips.

      • setWidth

        public void setWidth​(int width)
        This element can not be resized. Invoking this method will have no effect. The size of this element depends on the row header width and the column header height.
        Overrides:
        setWidth in class ReportComponent
        Parameters:
        width - Cannot be set for this element.
        Since:
        6.0

      • setHeight

        public void setHeight​(int height)
        This element can not be resized. Invoking this method will have no effect. The size of this element depends on the row header width and the column header height.
        Overrides:
        setHeight in class ReportComponent
        Parameters:
        height - Cannot be set for this element.
        Since:
        6.0

      • setReferences

        public void setReferences()
        FOR INTERNAL USE ONLY
        Specified by:
        setReferences in interface com.inet.report.ReferenceHolder
        Overrides:
        setReferences in class ReportComponent

      • resetReferences

        public void resetReferences()
        FOR INTERNAL USE ONLY
        Specified by:
        resetReferences in interface com.inet.report.ReferenceHolder
        Overrides:
        resetReferences in class ReportComponent

      • indexOf

        public int indexOf()
            throws ReportException
        Returns the position of this object in the parent collection.
        Specified by:
        indexOf in class ReportComponent
        Returns:
        Position of this object in the parent collection.
        Throws:
        ReportException - If there is no parent or the object does not exist.

      • 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 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 ReportComponent
        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.

      • getReportElement

        public Element getReportElement​(int idx)
        Get a report Element. You can specify the returned Element with the idx parameter.
        Specified by:
        getReportElement in interface SimpleElementContainer
        Parameters:
        idx - The 0-based index of the element, which should be returned.
        Returns:
        in instance of some subclass of Element.

      • getReportElementsCount

        public int getReportElementsCount()
        Counts the number of Report Elements in this container and returns it.
        Specified by:
        getReportElementsCount in interface SimpleElementContainer
        Returns:
        The number of report elements in this container.

      • getSubComponents

        public java.util.List<Element> 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