Package org.pentaho.reporting.engine.classic.core.elementfactory

Class ElementFactory

  • Direct Known Subclasses:
    AbstractContentElementFactory, TextElementFactory
    public abstract class ElementFactory
extends Object
    The class element factory is the base class for all Element Factories. Element factories can be used to create predefined element types. The properties allow null values, if a property is null, it will not be defined. Undefined properties can inherit their values from the element's parent bands or the default-stylesheet. Whether a property is inheritable from the parent is defined in the style-key itself.
    Author:
    Thomas Morgner

    • Constructor Detail

      • ElementFactory

        protected ElementFactory()
        Default Constructor.

    • Method Detail

      • getPadding

        public Float getPadding()
        Returns the defined global padding of this box. Padding defines the empty area between the border and the content of an element. This property defines a short-hand property for all other padding properties. Paddings cannot have relative sizes.
        Returns:
        the padding or null, if none is defined here.

      • setPadding

        public void setPadding​(Float padding)
        Defines the global padding of this box. Padding defines the empty area between the border and the content of an element. This property defines a short-hand property for all other padding properties. Paddings cannot have relative sizes.
        Parameters:
        padding - the padding or null, if the default should be used.

      • getBorderWidth

        public Float getBorderWidth()
        Returns the defined global border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element). This property defines a short-hand property for all other border-width properties.
        Returns:
        the defined border-width or null, if none is defined here.

      • setBorderWidth

        public void setBorderWidth​(Float borderWidth)
        Defines the global border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element). This property defines a short-hand property for all other border-width properties.
        Parameters:
        borderWidth - the defined border width or null, if the default should be used.

      • getBorderStyle

        public BorderStyle getBorderStyle()
        Returns the defined global border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered. This property defines a short-hand property for all other border-style properties.
        Returns:
        the defined border-style or null, if the default should be used.

      • setBorderStyle

        public void setBorderStyle​(BorderStyle borderStyle)
        Defines the global border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered. This property defines a short-hand property for all other border-style properties.
        Parameters:
        borderStyle - the defined border-style or null, if none is defined here.

      • getBorderColor

        public Color getBorderColor()
        Returns the defined global border-color. This property defines a short-hand property for all other border-color properties.
        Returns:
        the border-color for all borders or null, if no global color is defined.

      • setBorderColor

        public void setBorderColor​(Color borderColor)
        Defines the global border-color. This property defines a short-hand property for all other border-color properties.
        Parameters:
        borderColor - the defined color for all borders or null, if no global color is defined.

      • getBorderRadius

        public Dimension2D getBorderRadius()
        Returns the defined global border-radius for this element. If the border radius has a non-zero width and height, the element's border will have rounded corners. This property is a short-hand property for all other border-radius properties.
        Returns:
        the defined border-radius for all corners of this element or null, if no global default is defined here.

      • setBorderRadius

        public void setBorderRadius​(Dimension2D borderRadius)
        Defines the global border-radius for this element. If the border radius has a non-zero width and height, the element's border will have rounded corners. This property is a short-hand property for all other border-radius properties.

        Parameters:
        borderRadius - the defined border-radius for all corners of this element or null, if no global default should be defined here.

      • getBorderRadiusWidth

        public Float getBorderRadiusWidth()
        Returns the defined global width of the border-radius for this element. If the border radius has a non-zero width and height, the element's border will have rounded corners. This property is a short-hand property for all other border-radius properties.
        Returns:
        the defined width of the border-radius for all corners of this element or null, if no global default is defined here.

      • setBorderRadiusWidth

        public void setBorderRadiusWidth​(Float borderRadiusWidth)
        Defines the global width of the border-radius for this element. If the border radius has a non-zero width and height, the element's border will have rounded corners. This property is a short-hand property for all other border-radius properties.

        Parameters:
        borderRadiusWidth - the defined width of the border-radius for all corners of this element or null, if no global default should be defined here.

      • getBorderRadiusHeight

        public Float getBorderRadiusHeight()
        Returns the defined global height of the border-radius for this element. If the border radius has a non-zero width and height, the element's border will have rounded corners. This property is a short-hand property for all other border-radius properties.
        Returns:
        the defined height of the border-radius for all corners of this element or null, if no global default is defined here.

      • setBorderRadiusHeight

        public void setBorderRadiusHeight​(Float borderRadiusHeight)
        Defines the global height of the border-radius for this element. If the border radius has a non-zero width and height, the element's border will have rounded corners. This property is a short-hand property for all other border-radius properties.

        Parameters:
        borderRadiusHeight - the defined height of the border-radius for all corners of this element or null, if no global default should be defined here.

      • getBorderBottomLeftRadius

        public Dimension2D getBorderBottomLeftRadius()
        Returns the defined bottom-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-left corner.
        Returns:
        the defined border-radius for the bottom-left corner of this element or null, if this property is undefined.

      • setBorderBottomLeftRadius

        public void setBorderBottomLeftRadius​(Dimension2D borderRadius)
        Defines the bottom-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-left corner.
        Parameters:
        borderRadius - the defined border-radius for the bottom-left corner of this element or null, if this property should be undefined.

      • getBorderBottomLeftRadiusWidth

        public Float getBorderBottomLeftRadiusWidth()
        Returns width of the defined bottom-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-left corner.
        Returns:
        the defined width of the border-radius for the bottom-left corner of this element or null, if this property is undefined.

      • setBorderBottomLeftRadiusWidth

        public void setBorderBottomLeftRadiusWidth​(Float borderBottomLeftRadiusWidth)
        Defines width of the bottom-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-left corner.
        Parameters:
        borderBottomLeftRadiusWidth - the width of the defined border-radius for the bottom-left corner of this element or null, if this property should be undefined.

      • getBorderBottomLeftRadiusHeight

        public Float getBorderBottomLeftRadiusHeight()
        Returns height of the defined bottom-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-left corner.
        Returns:
        the defined height of the border-radius for the bottom-left corner of this element or null, if this property is undefined.

      • setBorderBottomLeftRadiusHeight

        public void setBorderBottomLeftRadiusHeight​(Float borderBottomLeftRadiusHeight)
        Defines height of the bottom-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-left corner.
        Parameters:
        borderBottomLeftRadiusHeight - the height of the defined border-radius for the bottom-left corner of this element or null, if this property should be undefined.

      • getBorderBottomRightRadius

        public Dimension2D getBorderBottomRightRadius()
        Returns the defined bottom-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-right corner.
        Returns:
        the defined border-radius for the bottom-right corner of this element or null, if this property is undefined.

      • setBorderBottomRightRadius

        public void setBorderBottomRightRadius​(Dimension2D borderRadius)
        Defines the bottom-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-right corner.
        Parameters:
        borderRadius - the defined border-radius for the bottom-right corner of this element or null, if this property should be undefined.

      • getBorderBottomRightRadiusWidth

        public Float getBorderBottomRightRadiusWidth()
        Returns the width of the defined bottom-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-right corner.
        Returns:
        the width of the defined border-radius for the bottom-right corner of this element or null, if this property is undefined.

      • setBorderBottomRightRadiusWidth

        public void setBorderBottomRightRadiusWidth​(Float borderBottomRightRadiusWidth)
        Defines the width of the bottom-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-right corner.
        Parameters:
        borderBottomRightRadiusWidth - the width of the defined border-radius for the bottom-right corner of this element or null, if this property should be undefined.

      • getBorderBottomRightRadiusHeight

        public Float getBorderBottomRightRadiusHeight()
        Returns the height of the defined bottom-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-right corner.
        Returns:
        the height of the defined border-radius for the bottom-right corner of this element or null, if this property is undefined.

      • setBorderBottomRightRadiusHeight

        public void setBorderBottomRightRadiusHeight​(Float borderBottomRightRadiusHeight)
        Defines the height of the bottom-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded bottom-right corner.
        Parameters:
        borderBottomRightRadiusHeight - the height of the defined border-radius for the bottom-right corner of this element or null, if this property should be undefined.

      • getBorderTopLeftRadius

        public Dimension2D getBorderTopLeftRadius()
        Returns the defined top-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-left corner.
        Returns:
        the defined border-radius for the top-left corner of this element or null, if this property is undefined.

      • setBorderTopLeftRadius

        public void setBorderTopLeftRadius​(Dimension2D borderRadius)
        Defines the top-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-left corner.
        Parameters:
        borderRadius - the defined border-radius for the top-left corner of this element or null, if this property should be undefined.

      • getBorderTopLeftRadiusWidth

        public Float getBorderTopLeftRadiusWidth()
        Returns the width of the defined top-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-left corner.
        Returns:
        the width of the defined border-radius for the top-left corner of this element or null, if this property is undefined.

      • setBorderTopLeftRadiusWidth

        public void setBorderTopLeftRadiusWidth​(Float borderTopLeftRadiusWidth)
        Defines the width of the top-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-left corner.
        Parameters:
        borderTopLeftRadiusWidth - the width of the defined border-radius for the top-left corner of this element or null, if this property should be undefined.

      • getBorderTopLeftRadiusHeight

        public Float getBorderTopLeftRadiusHeight()
        Returns the height of the defined top-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-left corner.
        Returns:
        the height of the defined border-radius for the top-left corner of this element or null, if this property is undefined.

      • setBorderTopLeftRadiusHeight

        public void setBorderTopLeftRadiusHeight​(Float borderTopLeftRadiusHeight)
        Defines the height of the top-left border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-left corner.
        Parameters:
        borderTopLeftRadiusHeight - the height of the defined border-radius for the top-left corner of this element or null, if this property should be undefined.

      • getBorderTopRightRadius

        public Dimension2D getBorderTopRightRadius()
        Returns the defined top-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-right corner.
        Returns:
        the defined border-radius for the top-right corner of this element or null, if this property is undefined.

      • setBorderTopRightRadius

        public void setBorderTopRightRadius​(Dimension2D borderRadius)
        Defines the top-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-right corner.
        Parameters:
        borderRadius - the defined border-radius for the top-right corner of this element or null, if this property should be undefined.

      • getBorderTopRightRadiusWidth

        public Float getBorderTopRightRadiusWidth()
        Returns the width of the defined top-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-right corner.
        Returns:
        the width of the defined border-radius for the top-right corner of this element or null, if this property is undefined.

      • setBorderTopRightRadiusWidth

        public void setBorderTopRightRadiusWidth​(Float borderTopRightRadiusWidth)
        Defines the width of the top-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-right corner.
        Parameters:
        borderTopRightRadiusWidth - the width of the defined border-radius for the top-right corner of this element or null, if this property should be undefined.

      • getBorderTopRightRadiusHeight

        public Float getBorderTopRightRadiusHeight()
        Returns the height of the defined top-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-right corner.
        Returns:
        the height of the defined border-radius for the top-right corner of this element or null, if this property is undefined.

      • setBorderTopRightRadiusHeight

        public void setBorderTopRightRadiusHeight​(Float borderTopRightRadiusHeight)
        Defines the height of the top-right border-radius for this element. If the border radius has a non-zero width and height, the element's border will have a rounded top-right corner.
        Parameters:
        borderTopRightRadiusHeight - the height of the defined border-radius for the top-right corner of this element or null, if this property should be undefined.

      • getColor

        public Color getColor()
        Returns the text color for the new element.
        Returns:
        the text color.

      • setColor

        public void setColor​(Color color)
        Defines the text color for the new element.
        Parameters:
        color - the text color.

      • getVerticalAlignment

        public ElementAlignment getVerticalAlignment()
        Returns the vertical alignment for the content of this element.
        Returns:
        the vertical alignment.

      • setVerticalAlignment

        public void setVerticalAlignment​(ElementAlignment verticalAlignment)
        Defines the vertical alignment for the content of this element.
        Parameters:
        verticalAlignment - the vertical alignment.

      • getHorizontalAlignment

        public ElementAlignment getHorizontalAlignment()
        Returns the horizontal alignment for the content of this element.
        Returns:
        the horizontal alignment.

      • setHorizontalAlignment

        public void setHorizontalAlignment​(ElementAlignment horizontalAlignment)
        Defines the horizontal alignment for the content of this element.
        Parameters:
        horizontalAlignment - the vertical alignment.

      • getFontSmooth

        public FontSmooth getFontSmooth()
        Returns the defined font smoothing (also known as text-aliasing) is applied to the element. If the font-smooth property is undefined or auto, the actual value will be comptued depending on the element's font size.
        Returns:
        the font-smooth constant or null, if this property is undefined.

      • setFontSmooth

        public void setFontSmooth​(FontSmooth fontSmooth)
        Defines, whether font smoothing (also known as text-aliasing) is applied to the element. If the font-smooth property is undefined or auto, the actual value will be comptued depending on the element's font size.
        Parameters:
        fontSmooth - the font-smooth constant or null, if this property should be left undefined.

      • getBorderTopWidth

        public Float getBorderTopWidth()
        Returns the defined top border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the border width for the top edge or null if the property should be left undefined.

      • setBorderTopWidth

        public void setBorderTopWidth​(Float borderTopWidth)
        Defines the top border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        borderTopWidth - the border width for the top edge or null if the property should be left undefined.

      • getBorderLeftWidth

        public Float getBorderLeftWidth()
        Returns the defined left border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the border width for the left edge or null if the property should be left undefined.

      • setBorderLeftWidth

        public void setBorderLeftWidth​(Float borderLeftWidth)
        Defines the left border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        borderLeftWidth - the border width for the left edge or null if the property should be left undefined.

      • getBorderBottomWidth

        public Float getBorderBottomWidth()
        Returns the defined left border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the border width for the left edge or null if the property should be left undefined.

      • setBorderBottomWidth

        public void setBorderBottomWidth​(Float borderBottomWidth)
        Defines the bottom border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        borderBottomWidth - the border width for the bottom edge or null if the property should be left undefined.

      • getBorderRightWidth

        public Float getBorderRightWidth()
        Returns the defined right border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the border width for the right edge or null if the property should be left undefined.

      • setBorderRightWidth

        public void setBorderRightWidth​(Float borderRightWidth)
        Defines the right border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        borderRightWidth - the border width for the right edge or null if the property should be left undefined.

      • getBorderBreakWidth

        public Float getBorderBreakWidth()
        Returns the defined break border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).

        The break border is applied to all inner border-edges of elements that got split on a pagebreak.

        Returns:
        the width of the break edge of the border or null, if not defined.

      • setBorderBreakWidth

        public void setBorderBreakWidth​(Float borderBreakWidth)
        Defines the break border width of this box. A border width of zero effectively disables the border. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).

        The break border is applied to all inner border-edges of elements that got split on a pagebreak.

        Parameters:
        borderBreakWidth - the width of the break edge of the border or null, if not defined.

      • getBorderTopStyle

        public BorderStyle getBorderTopStyle()
        Returns the defined top border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Returns:
        the border style for the top edge or null, if the style should remain undefined.

      • setBorderTopStyle

        public void setBorderTopStyle​(BorderStyle borderTopStyle)
        Defines the top border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Parameters:
        borderTopStyle - the border style for the top edge or null, if the style should remain undefined.

      • getBorderLeftStyle

        public BorderStyle getBorderLeftStyle()
        Returns the defined left border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Returns:
        the border style for the left edge or null, if the style should remain undefined.

      • setBorderLeftStyle

        public void setBorderLeftStyle​(BorderStyle borderLeftStyle)
        Defines the left border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Parameters:
        borderLeftStyle - the border style for the left edge or null, if the style should remain undefined.

      • getBorderBottomStyle

        public BorderStyle getBorderBottomStyle()
        Returns the defined bottom border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Returns:
        the border style for the bottom edge or null, if the style should remain undefined.

      • setBorderBottomStyle

        public void setBorderBottomStyle​(BorderStyle borderBottomStyle)
        Defines the bottom border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Parameters:
        borderBottomStyle - the border style for the bottom edge or null, if the style should remain undefined.

      • getBorderRightStyle

        public BorderStyle getBorderRightStyle()
        Returns the defined right border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Returns:
        the border style for the right edge or null, if the style should remain undefined.

      • setBorderRightStyle

        public void setBorderRightStyle​(BorderStyle borderRightStyle)
        Defines the right border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Parameters:
        borderRightStyle - the border style for the right edge or null, if the style should remain undefined.

      • getBorderBreakStyle

        public BorderStyle getBorderBreakStyle()
        Returns the defined break border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Returns:
        the border style for the break edge or null, if the style should remain undefined.

      • setBorderBreakStyle

        public void setBorderBreakStyle​(BorderStyle borderBreakStyle)
        Defines the break border-style for the element. If the border-style is set to NONE or undefined, the border-size property will be ignored and no border is rendered.
        Parameters:
        borderBreakStyle - the border style for the break edge or null, if the style should remain undefined.

      • getBorderTopColor

        public Color getBorderTopColor()
        Returns the defined top border-color.
        Returns:
        the color for the top edge or null, if the value should be left undefined here.

      • setBorderTopColor

        public void setBorderTopColor​(Color borderTopColor)
        Defines the top border-color.
        Parameters:
        borderTopColor - the color for the top edge or null, if the value should be left undefined here.

      • getBorderLeftColor

        public Color getBorderLeftColor()
        Returns the defined left border-color.
        Returns:
        the color for the left edge or null, if the value should be left undefined here.

      • setBorderLeftColor

        public void setBorderLeftColor​(Color borderLeftColor)
        Defines the left border-color.
        Parameters:
        borderLeftColor - the color for the left edge or null, if the value should be left undefined here.

      • getBorderBottomColor

        public Color getBorderBottomColor()
        Returns the defined bottom border-color.
        Returns:
        the color for the bottom edge or null, if the value should be left undefined here.

      • setBorderBottomColor

        public void setBorderBottomColor​(Color borderBottomColor)
        Defines the bottom border-color.
        Parameters:
        borderBottomColor - the color for the bottom edge or null, if the value should be left undefined here.

      • getBorderRightColor

        public Color getBorderRightColor()
        Returns the defined right border-color.
        Returns:
        the color for the right edge or null, if the value should be left undefined here.

      • setBorderRightColor

        public void setBorderRightColor​(Color borderRightColor)
        Defines the right border-color.
        Parameters:
        borderRightColor - the color for the right edge or null, if the value should be left undefined here.

      • getBorderBreakColor

        public Color getBorderBreakColor()
        Returns the defined break border-color.
        Returns:
        the color for the break edge or null, if the value should be left undefined here.

      • setBorderBreakColor

        public void setBorderBreakColor​(Color borderBreakColor)
        Defines the break border-color.
        Parameters:
        borderBreakColor - the color for the break edge or null, if the value should be left undefined here.

      • getPaddingTop

        public Float getPaddingTop()
        Returns the defined top padding of this box. Padding defines the empty area between the border and the content of an element. Paddings cannot have relative sizes.
        Returns:
        the padding or null, if the padding remains undefined here.

      • setPaddingTop

        public void setPaddingTop​(Float paddingTop)
        Defines the top padding of this box. Padding defines the empty area between the border and the content of an element. Paddings cannot have relative sizes.
        Parameters:
        paddingTop - the padding or null, if the padding remains undefined here.

      • getPaddingLeft

        public Float getPaddingLeft()
        Returns the defined left padding of this box. Padding defines the empty area between the border and the content of an element. Paddings cannot have relative sizes.
        Returns:
        the padding or null, if the padding remains undefined here.

      • setPaddingLeft

        public void setPaddingLeft​(Float paddingLeft)
        Defines the left padding of this box. Padding defines the empty area between the border and the content of an element. Paddings cannot have relative sizes.
        Parameters:
        paddingLeft - the padding or null, if the padding remains undefined here.

      • getPaddingBottom

        public Float getPaddingBottom()
        Returns the defined bottom padding of this box. Padding defines the empty area between the border and the content of an element. Paddings cannot have relative sizes.
        Returns:
        the padding or null, if the padding remains undefined here.

      • setPaddingBottom

        public void setPaddingBottom​(Float paddingBottom)
        Defines the bottom padding of this box. Padding defines the empty area between the border and the content of an element. Paddings cannot have relative sizes.
        Parameters:
        paddingBottom - the padding or null, if the padding remains undefined here.

      • getPaddingRight

        public Float getPaddingRight()
        Returns the defined right padding of this box. Padding defines the empty area between the border and the content of an element. Paddings cannot have relative sizes.
        Returns:
        the padding or null, if the padding remains undefined here.

      • setPaddingRight

        public void setPaddingRight​(Float paddingRight)
        Defines the right padding of this box. Padding defines the empty area between the border and the content of an element. Paddings cannot have relative sizes.
        Parameters:
        paddingRight - the padding or null, if the padding remains undefined here.

      • getWidows

        public Integer getWidows()
        Returns the defined number of widow-lines in this element. This avoids pagebreaks inside the first number of lines of a paragraph. If a pagebreak would occur inside the widow-segment, the whole box will be shifted to the next page.
        Returns:
        the number of widow-lines that control the pagebreak inside the paragraph.

      • setWidows

        public void setWidows​(Integer widows)
        Defines the number of widow-lines in this element. This avoids pagebreaks inside the first number of lines of a paragraph. If a pagebreak would occur inside the widow-segment, the whole box will be shifted to the next page.
        Parameters:
        widows - the number of widow-lines that control the pagebreak inside the paragraph.

      • getOrphans

        public Integer getOrphans()
        Returns the defined number of orphan-lines in this element. This avoids pagebreaks inside the last number of lines of a paragraph. If a pagebreak would occur inside the orphan-segment, the whole number of orphan lines or the whole box will be shifted to the next page.
        Returns:
        the number of orphan-lines that control the pagebreak inside the paragraph.

      • setOrphans

        public void setOrphans​(Integer orphans)
        Defines the number of orphan-lines in this element. This avoids pagebreaks inside the last number of lines of a paragraph. If a pagebreak would occur inside the orphan-segment, the whole number of orphan lines or the whole box will be shifted to the next page.
        Parameters:
        orphans - the number of orphan-lines that control the pagebreak inside the paragraph.

      • getWidowOrphanOptOut

        public Boolean getWidowOrphanOptOut()

      • setWidowOrphanOptOut

        public void setWidowOrphanOptOut​(Boolean widowOrphanOptOut)

      • getBackgroundColor

        public Color getBackgroundColor()
        Returns the defined background color of the box.
        Returns:
        the background color or null, if undefined.

      • setBackgroundColor

        public void setBackgroundColor​(Color backgroundColor)
        Defines the background color of the box.
        Parameters:
        backgroundColor - the background color or null, if undefined.

      • getOverflowY

        public Boolean getOverflowY()
        Returns, whether text contained in this element will overflow vertically. This will generate overlapping text in the pageable outputs without increasing the total size of the element. Activating this property may cause rendering artifacts.
        Returns:
        a boolean whether text can overflow the box boundaries or null, if this property is left undefined.

      • setOverflowY

        public void setOverflowY​(Boolean overflowY)
        Defines, whether text contained in this element will overflow vertically. This will generate overlapping text in the pageable outputs without increasing the total size of the element. Activating this property may cause rendering artifacts.
        Parameters:
        overflowY - defines, whether text can overflow the box boundaries or null, to leave this property undefined.

      • getOverflowX

        public Boolean getOverflowX()
        Returns, whether text contained in this element will overflow horizontally. This will generate overlapping text in the pageable outputs without increasing the total size of the element. Activating this property may cause rendering artifacts.
        Returns:
        a boolean whether text can overflow the box boundaries or null, if this property is left undefined.

      • setOverflowX

        public void setOverflowX​(Boolean overflowX)
        Defines, whether text contained in this element will overflow horizontally. This will generate overlapping text in the pageable outputs without increasing the total size of the element. Activating this property may cause rendering artifacts.
        Parameters:
        overflowX - defines, whether text can overflow the box boundaries or null, to leave this property undefined.

      • getAvoidPagebreaks

        public Boolean getAvoidPagebreaks()
        Returns whether the layouter will try to avoid to generate pagebreaks inside this element. If the element does not fit on the current page, it will be moved to the next page. Only if this next page does not have enough space to hold this element, a pagebreak will be generated inside the element.
        Returns:
        a boolean defining whether pagebreaks are allowed inside the box or null, if this property has been left undefined.

      • setAvoidPagebreaks

        public void setAvoidPagebreaks​(Boolean avoidPagebreaks)
        Defines whether the layouter will try to avoid to generate pagebreaks inside this element. If the element does not fit on the current page, it will be moved to the next page. Only if this next page does not have enough space to hold this element, a pagebreak will be generated inside the element.
        Parameters:
        avoidPagebreaks - a boolean defining whether pagebreaks are allowed inside the box or null, if this property should be left undefined.

      • getHRefTarget

        public String getHRefTarget()
        Returns the link target for this element. The link-target usually specifies the URL for a hyper-link.
        Returns:
        the link target.

      • setHRefTarget

        public void setHRefTarget​(String hRefTarget)
        Defines the link target for the element. The link-target usually specifies the URL for a hyper-link.
        Parameters:
        hRefTarget - the link target.

      • getName

        public String getName()
        Returns the name of the new element.
        Returns:
        the name of the element.

      • setName

        public void setName​(String name)
        Defines the name of the element. If the name is null, the default (anonymous) name will be used.
        Parameters:
        name - the element name.

      • getPreferredSize

        public Dimension2D getPreferredSize()
        Returns the element's preferred size.
        Returns:
        the element's preferred size.
        See Also:
        getWidth(), getHeight()

      • setPreferredSize

        public void setPreferredSize​(Dimension2D preferredSize)
        Returns the element's preferred size.
        Parameters:
        preferredSize - the element's preferred size.
        See Also:
        setWidth(Float), setHeight(Float)

      • getAbsolutePosition

        public Point2D getAbsolutePosition()
        Returns the element's absolute position. This property is only used if the band containing this element uses a canvas-layout strategy.
        Returns:
        the element's absolute position.
        See Also:
        getX(), getY()

      • setAbsolutePosition

        public void setAbsolutePosition​(Point2D absolutePosition)
        Returns the element's absolute position. This property is only used if the band containing this element uses a canvas-layout strategy.
        Parameters:
        absolutePosition - the element's absolute position.
        See Also:
        setX(Float), setY(Float)

      • getDynamicHeight

        public Boolean getDynamicHeight()
        Returns whether the element's height should be adjusted automaticly.
        Returns:
        the state of the dynamic feature or null, if the feature is undefined.

      • setDynamicHeight

        public void setDynamicHeight​(Boolean dynamicHeight)
        Defines whether the element's height should be adjusted automaticly.
        Parameters:
        dynamicHeight - the new value of the elements dynamic height feature.

      • getLayoutCachable

        public Boolean getLayoutCachable()
        Deprecated.
        The layout cachable flag is no longer used.
        Returns, whether the layout for the element is cachable. If you intend to modify the element's properties from within a function, you should mark the element as non-cachable, or the layout may look funny.

        This property is no longer used. This method will be removed in version 1.0.

        Returns:
        the layout-cachable flag.

      • setLayoutCachable

        public void setLayoutCachable​(Boolean layoutCachable)
        Deprecated.
        The layout cachable flag is no longer used.
        Returns, whether the layout for the element is cachable. If you intend to modify the element's properties from within a function, you should mark the element as non-cachable, or the layout may look funny. Set this value to null if this value should be inherited from the parent.

        This property is no longer used. This method will be removed in version 1.0.

        Parameters:
        layoutCachable - the layout-cachable flag.

      • getVisible

        public Boolean getVisible()
        Returns, whether the element will be visible.
        Returns:
        the visibility of the element.

      • setVisible

        public void setVisible​(Boolean visible)
        Defines, whether the element will be visible.
        Parameters:
        visible - the visibility flag of the element.

      • applyElementName

        protected void applyElementName​(Element e)
        Applies the defined name to the created element.
        Parameters:
        e - the element which was created.

      • getHRefWindow

        public String getHRefWindow()
        Returns the 'window' parameter for hyperlink references. This property will only make sense in HTML-exports, as all other export targets that support Hyperlinks will open up in a new window anyway.
        Returns:
        the href-window string.

      • setHRefWindow

        public void setHRefWindow​(String hRefWindow)
        Defines the 'window' parameter for hyperlink references. This property will only make sense in HTML-exports, as all other export targets that support Hyperlinks will open up in a new window anyway.
        Parameters:
        hRefWindow - the href-window string.

      • getMinimumWidth

        public Float getMinimumWidth()
        Returns the elements minimum width. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the minimum width or null, if no minimum width is defined.

      • setMinimumWidth

        public void setMinimumWidth​(Float minimumWidth)
        Defines the elements minimum width. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        minimumWidth - the minimum width or null, to leave this property undefined.

      • getMinimumHeight

        public Float getMinimumHeight()
        Returns the elements minimum height. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the minimum height or null, if no minimum height is defined.

      • setMinimumHeight

        public void setMinimumHeight​(Float minimumHeight)
        Defines the elements minimum height. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        minimumHeight - the minimum height or null, to leave this property undefined.

      • getMaximumWidth

        public Float getMaximumWidth()
        Returns the elements maximum width. The maximum width cannot have relative values.
        Returns:
        the maximum width or null, if no maximum width is defined.

      • setMaximumWidth

        public void setMaximumWidth​(Float maximumWidth)
        Defines the elements maximum width. The maximum width cannot have relative values.
        Parameters:
        maximumWidth - the maximum width or null, if no maximum width should be defined.

      • getMaximumHeight

        public Float getMaximumHeight()
        Returns the elements maximum height. The maximum height cannot have relative values.
        Returns:
        the maximum height or null, if no maximum height is defined.

      • setMaximumHeight

        public void setMaximumHeight​(Float maximumHeight)
        Defines the elements maximum height. The maximum height cannot have relative values.
        Parameters:
        maximumHeight - the maximum width or null, if no maximum height should be defined.

      • getWidth

        public Float getWidth()
        Returns the elements defined preferred width. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the preferred width or null, if left undefined.

      • setWidth

        public void setWidth​(Float width)
        Defines the elements preferred width. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        width - the preferred width or null, if left undefined.

      • getHeight

        public Float getHeight()
        Returns the elements defined preferred height. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the preferred height or null, if left undefined.

      • setHeight

        public void setHeight​(Float height)
        Defines the elements preferred height. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        height - the preferred height or null, if left undefined.

      • getX

        public Float getX()
        Returns the elements defined absolute horizontal position for the canvas-layout. The position is relative to the parents upper left corner of the content-area. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the elements horizontal position or null, if not defined.

      • setX

        public void setX​(Float x)
        Defines the elements absolute horizontal position for the canvas-layout. The position is relative to the parents upper left corner of the content-area. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        x - the elements horizontal position or null, if not defined.

      • getY

        public Float getY()
        Returns the elements defined absolute vertical position for the canvas-layout. The position is relative to the parents upper left corner of the content-area. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Returns:
        the elements vertical position or null, if not defined.

      • setY

        public void setY​(Float y)
        Defines the elements absolute vertical position for the canvas-layout. The position is relative to the parents upper left corner of the content-area. A number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the layout model of the band that contains this element).
        Parameters:
        y - the elements vertical position or null, if not defined.

      • getHRefTitle

        public String getHRefTitle()
        Returns the defined HREF-Title. This title is only valid during the HTML export.
        Returns:
        the href-title as string.

      • setHRefTitle

        public void setHRefTitle​(String hRefTitle)
        Defines the defined HREF-Title. This title is only valid during the HTML export.
        Parameters:
        hRefTitle - the href-title as string.

      • applyStyle

        protected void applyStyle​(ElementStyleSheet style)
        Applies the style definition to the elements stylesheet.
        Parameters:
        style - the element stylesheet which should receive the style definition.

      • createElement

        public abstract Element createElement()
        Creates a new instance of the element. Override this method to return a concrete subclass of the element.
        Returns:
        the newly generated instance of the element.

      • getBooleanValue

        protected static Boolean getBooleanValue​(boolean b)
        Converts the given primitive boolean into a Boolean object.
        Parameters:
        b - the primitive value.
        Returns:
        Boolean.TRUE or Boolean.FALSE.

      • setUseMinChunkWidth

        public void setUseMinChunkWidth​(Boolean useMinChunkWidth)

      • getUseMinChunkWidth

        public Boolean getUseMinChunkWidth()