Package com.inet.report

Class Element

    • Constructor Detail

      • Element

        protected Element​(int type,
                  com.inet.report.RendererBase renderer)
        Constructor of Element with necessary dependencies, calls the full constructor with parentSection=null
        Parameters:
        type - type of element (valid valus defined in subclasses)
        renderer - renderer responsible for this element
        Since:
        5.0

    • Method Detail

      • copy

        public java.lang.Object copy()
                      throws ReportException
        Creates a serializable copy of this Element. The returned Object is not an instance of Element. This method is used from i-net Designer for Copy and Paste.
        Returns:
        A serializable Object.
        Throws:
        ReportException - If accessing properties of this Element causes any errors.
        Since:
        6.0
        See Also:
        Section.pasteElement(java.lang.Object)

      • paramString

        public java.lang.String paramString()
        Creates and return a String representation for debugging.
        Overrides:
        paramString in class ReportComponent
        Returns:
        String representation of this Element for debugging purposes
        Since:
        4.0

      • getField

        public Field getField()
        Returns the field definition element (for example, database field element, prompt field element).
        Returns:
        Field The current value of the 'field' property.
        Since:
        3.0

      • setField

        public void setField​(Field newField)
        Sets the field definition element (for example, DatabaseField element, prompt field element).
        Parameters:
        newField - The new field element of the property 'field'.
        Since:
        3.0

      • getParent

        public java.lang.Object getParent()
        Returns the parent element in object hierarchie (here: Section or null).
        Returns:
        The parent element in object hierarchie.
        Since:
        3.0

      • getEngine

        public Engine getEngine()
        Returns the Engine this Element is associated with.
        Returns:
        The Engine responsible for this Element
        Since:
        6.0

      • indexOf

        public int indexOf()
        Returns the current index of this element in section (z-order). If this Element is not found in the parent section -1 is returned.
        Specified by:
        indexOf in class ReportComponent
        Returns:
        The index (z-order) of this Element in the parent section or -1 if the Element was not found in the parent section.
        Since:
        3.0
        See Also:
        setIndex(int)

      • setIndex

        public void setIndex​(int zPos)
              throws ReportException
        Changes the z-order position of this element in the section (0 is all the way in the back, greater numbers cause the elements to overlap elements with a lower z index).
        Parameters:
        zPos - z Index to set for this Element. 0 would be in the very back. If an Element's z index is greater than the z index of another Element, it will overlap that Element.
        Throws:
        ReportException - Thrown if this element was not found in parent section
        Since:
        3.0
        See Also:
        indexOf()

      • getTypeAsString

        public java.lang.String getTypeAsString()
        FOR INTERNAL USE ONLY
        Since:
        6.1

      • setForeColor

        public void setForeColor​(int newValue)
        Sets the value of the property 'fore color'. This property sets the fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.
        Parameters:
        newValue - the new Value for the property 'fore color'.
        Since:
        3.0
        See Also:
        ColorUtils.toCcColor(java.awt.Color), ColorUtils.toJavaColor(int)

      • getForeColor

        public int getForeColor()
        Returns the fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.
        Returns:
        The 'fore color' value of the element.
        Since:
        3.0
        See Also:
        ColorUtils.toCcColor(java.awt.Color), ColorUtils.toJavaColor(int)

      • setForeColorFormula

        public void setForeColorFormula​(FormulaField newFormula)
        Sets the formula fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.
        Parameters:
        newFormula - The new formula fore color of this element.
        Since:
        3.0
        See Also:
        ColorUtils.toCcColor(java.awt.Color), ColorUtils.toJavaColor(int)

      • getForeColorFormula

        public FormulaField getForeColorFormula()
        Returns the formula fore color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class CoderXML. In most cases this color represents the border color. More information about the usage of colors in RDC can be found in the RDC documentation.
        Returns:
        FormulaField The formula fore color of this element.
        Since:
        3.0
        See Also:
        ColorUtils.toCcColor(java.awt.Color), ColorUtils.toJavaColor(int)

      • setTightHorizontal

        public void setTightHorizontal​(boolean newValue)
        Sets the value of the property 'tight horizontal'. If this property is enabled the border of the element will be trimed to the size of the field. When this property is disabled the size will be the same for each record.
        Parameters:
        newValue - true if the value should be set, else false.
        Since:
        3.0

      • setTightHorizontalFormula

        public void setTightHorizontalFormula​(FormulaField newFormula)
        Sets the formula for the property 'tight horizontal'. If this property is enabled the border of the element will be trimed to the size of the field. When this property is disabled the size will be the same for each record.
        Parameters:
        newFormula - The new formula for the property 'tight horizontal'.
        Since:
        3.0

      • isTightHorizontal

        public boolean isTightHorizontal()
        Returns the value of the property 'tight horizontal'. If this property is enabled the border of the element will be trimmed to the size of the field. When this property is disabled the size will be the same for each record.
        Returns:
        true if the property is set, else false.
        Since:
        3.0

      • getTightHorizontalFormula

        public FormulaField getTightHorizontalFormula()
        Returns the formula for the property 'tight horizontal'. If this property is enabled the border of the element will be trimed to the size of the field. When this property is disabled the size will be the same for each record.
        Returns:
        FormulaField The formula for the property 'tight horizontal'.
        Since:
        3.0

      • getHyperlinkUrlFormula

        public FormulaField getHyperlinkUrlFormula()
        Returns the formula of the property 'hyperlink url'.
        Use this property to specify an url of a web site, an e-mail address or the url of a html-file. If formula is not empty a click on the element will open a webbrowser with the content of the web-site or the file, or an e-mail client will open.
        Returns:
        FormulaField The formula of the property 'hyperlink url'.
        Since:
        4.0

      • setHyperlinkUrlFormula

        public void setHyperlinkUrlFormula​(FormulaField newFormula)
        Sets the formula for the property 'hyperlink url'.
        Use this property to specify an url of a web site, an e-mail address or the url of a html-file. If formula is not empty a click on the element will open a webbrowser with the content of the web-site or the file, or an e-mail client will open.
        Parameters:
        newFormula - The new formula for the property 'hyperlink url'.
        Since:
        4.0

      • setHyperlinkUrl

        public void setHyperlinkUrl​(java.lang.String url)
        Sets the target location of a hyperlink which is assoziated with this element.
        This modify also the hyperlink type.
        Parameters:
        url - A string which starts with one of the following protocol types (followed by the target):
        mailto:
        file:///
        http://
        or an empty string.
        Since:
        4.0

      • getHyperlinkUrl

        public java.lang.String getHyperlinkUrl()
        Returns the target url of the hyperlink which is associated with this element.
        Returns:
        A string which starts with one of the following protocol types (followed by the target):
        mailto:
        file:///
        http://
        or an empty string.
        Since:
        4.0

      • setSuppressIfDuplicated

        public void setSuppressIfDuplicated​(boolean newValue)
        Sets the value of the property 'suppress if duplicated'.
        If this property is enabled values of the field that are duplicated will not be printed.
        Specified by:
        setSuppressIfDuplicated in interface GeneralProperties
        Parameters:
        newValue - The new value of the property 'suppress if duplicated'.

      • isSuppressIfDuplicated

        public boolean isSuppressIfDuplicated()
        Returns the value of the property 'suppress if duplicated'.
        If this property is enabled, values of the field that are duplicated will not be printed.
        Specified by:
        isSuppressIfDuplicated in interface GeneralProperties
        Returns:
        The value of the property 'suppress if duplicated'.

      • setSuppressIfDuplicatedFormula

        public void setSuppressIfDuplicatedFormula​(FormulaField newFormula)
        Sets the formula for the property 'suppress if duplicated'.
        If this property is enabled, values of the field that are duplicated will not be printed.
        Specified by:
        setSuppressIfDuplicatedFormula in interface GeneralProperties
        Parameters:
        newFormula - The new formula for the property 'suppress if duplicated'.

      • getSuppressIfDuplicatedFormula

        public FormulaField getSuppressIfDuplicatedFormula()
        Returns the formula for the property 'suppress if duplicated'.
        If this property is enabled, values of the field that are duplicated will not be printed.
        Specified by:
        getSuppressIfDuplicatedFormula in interface GeneralProperties
        Returns:
        FormulaField The formula for the property 'suppress if duplicated'.

      • getCanGrowCount

        public final int getCanGrowCount()
        Returns the value of the property 'can grow count'.
        This property gives the maximum numbers of lines that a Text or a FieldElement can grow. Give 0 if you do not want to set a limit.
        Specified by:
        getCanGrowCount in interface GeneralProperties
        Returns:
        The current value of the property 'can grow count'.

      • setCanGrowCount

        public void setCanGrowCount​(int newValue)
        Sets the value of the property 'can grow count'.
        This property gives the maximum numbers of lines that a Text or a FieldElement can grow. Give 0 if you do not want to set a limit.
        Specified by:
        setCanGrowCount in interface GeneralProperties
        Parameters:
        newValue - The new value of the property 'can grow count'.
        Throws:
        java.lang.IllegalArgumentException - when newValue < 0

      • getHorAlignFormula

        public FormulaField getHorAlignFormula()
        Returns the formula for the property 'horizontal alignment'.
        Possible alignments are default, left, center, right or justified.
        Specified by:
        getHorAlignFormula in interface GeneralProperties
        Returns:
        FormulaField The formula for the property 'horizontal alignment'.

      • isCanGrow

        public boolean isCanGrow()
        Returns the value of the property 'can grow'.
        If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.
        Specified by:
        isCanGrow in interface GeneralProperties
        Returns:
        The value of the property 'can grow'.

      • setCanGrow

        public void setCanGrow​(boolean canGrow)
        Sets the value of the property 'can grow'.
        If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.
        Specified by:
        setCanGrow in interface GeneralProperties
        Parameters:
        canGrow - The new value of the property 'can grow'

      • getCanGrowFormula

        public FormulaField getCanGrowFormula()
        Returns the formula of the property 'can grow'.
        If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.
        Specified by:
        getCanGrowFormula in interface GeneralProperties
        Returns:
        FormulaField The formula of the property 'can grow'.

      • setCanGrowFormula

        public void setCanGrowFormula​(FormulaField newFormula)
        Sets the formula for the property 'can grow'.
        If this property is enabled, elements with dynamic state will be expanded vertically if its content is larger than its container. If this property is disabled the content will be truncated when its size is larger than the container.
        Specified by:
        setCanGrowFormula in interface GeneralProperties
        Parameters:
        newFormula - The new formula for the property 'can grow'.

      • 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).
        Parameters:
        newValue - The new value of the property 'close border on page break'.
        Since:
        10.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).
        Returns:
        FormulaField The value of the property 'close border on page break'.
        Since:
        10.0

      • isCloseBorderOnPageBreakInternal

        protected boolean isCloseBorderOnPageBreakInternal()
        FOR INTERNAL USE ONLY
        Returns:
        The value of the property 'close border on page break'.

      • setCloseBorderOnPageBreakFormula

        public void setCloseBorderOnPageBreakFormula​(FormulaField newFormula)
        Sets the formula for 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).
        Parameters:
        newFormula - The new formula for the property 'close border on page break'.
        Since:
        10.0

      • getCloseBorderOnPageBreakFormula

        public FormulaField getCloseBorderOnPageBreakFormula()
        Returns the formula for 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).
        Returns:
        FormulaField The formula for the property 'close border on page break'.
        Since:
        10.0

      • setDropShadow

        public void setDropShadow​(boolean newValue)
        Sets the value of the property 'drop shadow'. If this property is enabled, a shadow will be printed (below and on the right side). Otherwise no shadow will be printed.
        Parameters:
        newValue - true - shadow will be displayed, false - no shadow.
        Since:
        3.0

      • isDropShadow

        public boolean isDropShadow()
        Returns the value of the property 'drop shadow'. If this property is enabled, a shadow will be printed (below and on the right side). Otherwise no shadow will be printed.
        Returns:
        true if the shadow will be displayed else false.
        Since:
        3.0

      • setDropShadowFormula

        public void setDropShadowFormula​(FormulaField newFormula)
        Sets the formula for the property 'drop shadow'. If this property is enabled, a shadow will be printed (below and on the right side). Otherwise no shadow will be printed.
        Parameters:
        newFormula - The new formula for the property 'drop shadow'.
        Since:
        3.0

      • getDropShadowFormula

        public FormulaField getDropShadowFormula()
        Returns the formula for the property 'drop shadow'. If this property is enabled, a shadow will be printed (below and on the right side). Otherwise no shadow will be printed.
        Returns:
        FormulaField The formula for the property 'drop shadow'.
        Since:
        3.0

      • getToolTipsText

        public java.lang.String getToolTipsText()
        Returns the value of the property 'tool tips text'.
        The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.
        Specified by:
        getToolTipsText in interface GeneralProperties
        Returns:
        The value of the property 'tool tips text'.

      • setToolTipsText

        public void setToolTipsText​(java.lang.String newValue)
        Sets the value of the property 'tool tips text'.
        The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.
        Specified by:
        setToolTipsText in interface GeneralProperties
        Parameters:
        newValue - The new value of the property 'tool tips text'.

      • getToolTipsTextFormula

        public FormulaField getToolTipsTextFormula()
        Returns the formula of the property 'tool tips text'.
        The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.
        Specified by:
        getToolTipsTextFormula in interface GeneralProperties
        Returns:
        FormulaField The formula of the property 'tool tips text'.

      • setToolTipsTextFormula

        public void setToolTipsTextFormula​(FormulaField newFormula)
        Sets the formula for the property 'tool tips text'.
        The 'tool tips text' specifies a text which appear after short time slice when you move your mouse on the element. Use it for little notes.
        Specified by:
        setToolTipsTextFormula in interface GeneralProperties
        Parameters:
        newFormula - The new formula for the property 'tool tips text'.

      • addListener

        public void addListener​(RDC.ElementRemoveListener erl)
        Adds a listener. All added listeners will get an remove call if this element is removed from engine.
        Parameters:
        erl - An object which implements the CoderXML.ElementRemoveListener and should handle the call-back for this element.
        Since:
        4.0

      • removeListener

        public void removeListener​(RDC.ElementRemoveListener erl)
        Removes a previously added listener.
        Parameters:
        erl - An object which implements the CoderXML.ElementRemoveListener interface and should handle the call-back for this element.
        Since:
        4.0

      • setReferences

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

      • isInCrossTab

        public boolean isInCrossTab()
        FOR INTERNAL USE ONLY
        Since:
        6.1

      • setListStack

        public final void setListStack​(com.inet.lib.list.IntStack listStack)
        FOR INTERNAL USE ONLY
        Since:
        6.1

      • setBulletValueStack

        public final void setBulletValueStack​(com.inet.lib.list.IntStack bulletValueStack)
        FOR INTERNAL USE ONLY
        Since:
        6.1

      • getBulletValueStack

        public final com.inet.lib.list.IntStack getBulletValueStack()
        FOR INTERNAL USE ONLY
        Since:
        6.1

      • getListStack

        public final com.inet.lib.list.IntStack getListStack()
        FOR INTERNAL USE ONLY
        Since:
        6.1

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

      • parseText

        public void parseText​(java.lang.String textData,
                      java.util.Map<java.lang.String,​java.lang.Object> parserMap)
        FOR INTERNAL USE ONLY 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
        Overrides:
        parseText in class ReportComponent
        Parameters:
        textData - text encountered and to be stored
        parserMap - The map of current Parser.