Interface BorderProperties

    • Field Detail

      • NO_LINE

        static final int NO_LINE
        Line has no style, not visible. Not valid for line element.
        See Also:
        Constant Field Values
      • LINE_STYLE_SINGLE

        static final int LINE_STYLE_SINGLE
        Line has single line style.
        See Also:
        Constant Field Values
      • LINE_STYLE_DOUBLE

        static final int LINE_STYLE_DOUBLE
        Line has double line style. Not valid for line element.
        See Also:
        Constant Field Values
      • LINE_STYLE_DASHED

        static final int LINE_STYLE_DASHED
        Line has dashed line style.
        See Also:
        Constant Field Values
      • LINE_STYLE_DOTTED

        static final int LINE_STYLE_DOTTED
        Line has dotted line style.
        See Also:
        Constant Field Values
    • Method Detail

      • setCloseBorderOnPageBreak

        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

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

        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

        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

        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:
        7.0
      • isDropShadow

        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:
        7.0
      • setDropShadowFormula

        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:
        7.0
      • getDropShadowFormula

        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:
        7.0
      • getBottomLineStyle

        int getBottomLineStyle()
        Returns the value of the property 'bottom line style'. Returns one of the different line styles single line, double line, dashed line, dotted line or no line. If the property is set to one of the first four, a line will be drawn on the bottom of the element with the defined style.
        Returns:
        The value of the property 'bottom line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • setBottomLineStyle

        void setBottomLineStyle​(int newValue)
        Sets the value of the property 'bottom line style'. Choose one of the different line styles single line, double line, dashed line, dotted line or no line. If you have chosen one of the first four, a line will be drawn on the bottom of the element with the defined style.
        Parameters:
        newValue - The new value of the property 'bottom line style'.
        Throws:
        java.lang.IllegalArgumentException - if newValue is no valid line style
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • getBottomLineStyleFormula

        FormulaField getBottomLineStyleFormula()
        Returns the formula of the property 'bottom line style'. Returns the formula that results in one of the following line styles: single line, double line, dashed line, dotted line or no line. If it results in any of the first four a line will be drawn on the bottom of the element with the defined style.
        Returns:
        FormulaField The formula of the property 'bottom line style'.
        Since:
        6.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • setBottomLineStyleFormula

        void setBottomLineStyleFormula​(FormulaField newFormula)
        Sets the formula for the property 'bottom line style'. Give a formula that results in one of the following line styles: single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the bottom of the element with the defined style.
        Parameters:
        newFormula - The new formula for the property 'bottom line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • getTopLineStyle

        int getTopLineStyle()
        Returns the value of the property 'top line style'. Returns one of the different line styles single line, double line, dashed line, dotted line or no line. If the property is set to one of the first four, a line will be drawn on the top of the element with the defined style.
        Returns:
        The value of the property 'top line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • setTopLineStyle

        void setTopLineStyle​(int newValue)
        Sets the value of the property 'top line style'. Choose one of the different line styles single line, double line, dashed line, dotted line or no line. If you have chosen one of the first four, a line will be drawn on the top of the element with the defined style.
        Parameters:
        newValue - The new value of the property 'top line style'.
        Throws:
        java.lang.IllegalArgumentException - if newValue is no valid line style
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • getTopLineStyleFormula

        FormulaField getTopLineStyleFormula()
        Returns the formula of the property 'top line style'. Returns the formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the top of the element with the defined style.
        Returns:
        FormulaField The formula of the property 'top line style'.
        Since:
        6.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • setTopLineStyleFormula

        void setTopLineStyleFormula​(FormulaField newFormula)
        Sets the formula for the property 'top line style'. Give a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the top of the element with the defined style.
        Parameters:
        newFormula - The new formula for the property 'top line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • setLeftLineStyle

        void setLeftLineStyle​(int newValue)
        Sets the value of the property 'left line style'. Choose one of the different line styles single line, double line, dashed line, dotted line or no line. If you have chosen one of the first four, a line will be drawn on the left side of the element with the defined style.
        Parameters:
        newValue - The new value of the property 'left line style'
        Throws:
        java.lang.IllegalArgumentException - if newValue is no valid line style
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • getLeftLineStyle

        int getLeftLineStyle()
        Returns the value of the property 'left line style'. Returns one of the different line styles single line, double line, dashed line, dotted line or no line. If the property is set to one of the first four, a line will be drawn on the left side of the element with the defined style.
        Returns:
        The value of the property 'left line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • setLeftLineStyleFormula

        void setLeftLineStyleFormula​(FormulaField newFormula)
        Sets the formula for the property 'left line style'. Give a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the left side of the element with the defined style.
        Parameters:
        newFormula - The new formula for the property 'left line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • getLeftLineStyleFormula

        FormulaField getLeftLineStyleFormula()
        Returns the formula for the property 'left line style'. Returns a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the left side of the element with the defined style.
        Returns:
        FormulaField The formula for the property 'left line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • setRightLineStyle

        void setRightLineStyle​(int newValue)
        Sets the value of the property 'right line style'. Choose one of the different line styles single line, double line, dashed line, dotted line or no line. If you have chosen one of the first four, a line will be drawn on the right side of the element with the defined style.
        Parameters:
        newValue - The new value of the property 'right line style'.
        Throws:
        java.lang.IllegalArgumentException - if newValue is no valid line style
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • getRightLineStyle

        int getRightLineStyle()
        Returns the value of the property 'right line style'. Returns one of the different line styles single line, double line, dashed line, dotted line or no line. If the property is set to one of the first four, a line will be drawn on the right side of the element with the defined style.
        Returns:
        The value of the property 'right line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • setRightLineStyleFormula

        void setRightLineStyleFormula​(FormulaField newFormula)
        Sets the formula for the property 'right line style'. Give a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the right side of the element with the defined style.
        Parameters:
        newFormula - The new formula for the property 'right line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • getRightLineStyleFormula

        FormulaField getRightLineStyleFormula()
        Returns the formula for the property 'right line style'. Returns a formula that results in one of the different line styles single line, double line, dashed line, dotted line or no line. If it results in one of the first four, a line will be drawn on the right side of the element with the defined style.
        Returns:
        FormulaField The formula for the property 'right line style'.
        Since:
        7.0
        See Also:
        NO_LINE, LINE_STYLE_SINGLE, LINE_STYLE_DOUBLE, LINE_STYLE_DASHED, LINE_STYLE_DOTTED
      • setTightHorizontal

        void setTightHorizontal​(boolean newValue)
        Sets 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.
        Parameters:
        newValue - true if the value should be set, else false.
        Since:
        7.0
      • setTightHorizontalFormula

        void setTightHorizontalFormula​(FormulaField newFormula)
        Sets the formula for 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.
        Parameters:
        newFormula - The new formula for the property 'tight horizontal'.
        Since:
        7.0
      • isTightHorizontal

        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:
        7.0
      • getTightHorizontalFormula

        FormulaField getTightHorizontalFormula()
        Returns the formula for 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:
        FormulaField The formula for the property 'tight horizontal'.
        Since:
        7.0