Package com.inet.report

Interface BorderProperties

All Known Implementing Classes:
AbstractLineElement, AbstractPictureElement, Box, Chart2, CrossTab, DatabasePicture, FieldElement, JavaBean, Line, Picture, SignatureForm, Subreport, Text
public interface BorderProperties
Interface for elements that support properties like line style for borders, fore- and back color of the element.

This class is part of the RDC.
Since:
7.0

  • Field Details

    • NO_LINE

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

    • LINE_STYLE_SINGLE

      static final int LINE_STYLE_SINGLE
      Line has single line style.
      See Also:

    • LINE_STYLE_DOUBLE

      static final int LINE_STYLE_DOUBLE
      Line has double line style. Not valid for line element.
      See Also:

    • LINE_STYLE_DASHED

      static final int LINE_STYLE_DASHED
      Line has dashed line style.
      See Also:

    • LINE_STYLE_DOTTED

      static final int LINE_STYLE_DOTTED
      Line has dotted line style.
      See Also:

  • Method Details

    • 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

    • setBackColor

      void setBackColor(int backColor)
      Sets the value of the property 'back color'. This property sets the background color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class RDC. You can find a documentation about the use of colors in RDC here.
      Parameters:
      backColor - the new value of the property 'backColor'.
      Since:
      7.0
      See Also:

    • getBackColor

      int getBackColor()
      Returns the value of the property 'back color'. This property sets the background color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class RDC. You can find a documentation about the use of colors in RDC here.
      Returns:
      The value of the property 'backColor'.
      Since:
      7.0
      See Also:

    • setBackColorFormula

      void setBackColorFormula(FormulaField newFormula)
      Sets the formula for the property 'back color'. This property sets the background color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class RDC. You can find a documentation about the use of colors in RDC here.
      Parameters:
      newFormula - The new fromula for the property 'back color'.
      Since:
      7.0
      See Also:

    • getBackColorFormula

      FormulaField getBackColorFormula()
      Returns the formula for the property 'back color'. This property sets the background color of the element. Set the value as ABGR, i.e. 0x000000FF for red or use the color constants in class RDC. You can find a documentation about the use of colors in RDC here.
      Returns:
      FormulaField The formula of the property 'back color'.
      Since:
      7.0
      See Also:

    • setForeColor

      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 RDC. In most cases this color represents the border color. You can find a documentation about the use of colors in RDC here.
      Parameters:
      newValue - the new Value for the property 'fore color'.
      Since:
      7.0
      See Also:

    • getForeColor

      int getForeColor()
      Returns 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 RDC. In most cases this color represents the border color. You can find a documentation about the use of colors in RDC here.
      Returns:
      The value of the property 'fore color'.
      Since:
      7.0
      See Also:

    • setForeColorFormula

      void setForeColorFormula(FormulaField newFormula)
      Sets the formula 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 RDC. In most cases this color represents the border color. You can find a documentation about the use of colors in RDC here.
      Parameters:
      newFormula - The new formula for the property 'fore color'.
      Since:
      7.0
      See Also:

    • getForeColorFormula

      FormulaField getForeColorFormula()
      Returns the formula 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 RDC. In most cases this color represents the border color. You can find a documentation about the use of colors in RDC here.
      Returns:
      FormulaField The formula of the property 'fore color'.
      Since:
      7.0
      See Also:

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

    • 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:
      IllegalArgumentException - if newValue is no valid line style
      Since:
      7.0
      See Also:

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

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

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

    • 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:
      IllegalArgumentException - if newValue is no valid line style
      Since:
      7.0
      See Also:

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

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

    • 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:
      IllegalArgumentException - if newValue is no valid line style
      Since:
      7.0
      See Also:

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

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

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

    • 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:
      IllegalArgumentException - if newValue is no valid line style
      Since:
      7.0
      See Also:

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

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

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

    • 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