Package com.inet.report

Interface TextProperties

All Known Implementing Classes:
FieldElement, Subreport, Text
public interface TextProperties
Interface for all elements with text, i.e. for Text, Subreport, and FieldElement.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    GLYPH_DEFAULT
    This is the default glyph orientation, that is, the glyphs are to point towards the source of the block progression.
    static final int
    GLYPH_DOWN
    The glyphs are to always point downwards, regardless of text or block progression.
    static final int
    GLYPH_LEFT
    The glyphs are to always point to the left, regardless of text or block progression.
    static final int
    GLYPH_RIGHT
    The glyphs are to always point to the right, regardless of text or block progression.
    static final int
    GLYPH_UP
    The glyphs are to always point upwards, regardless of text or block progression.
    static final int
    ROTATE_0
    Do not rotate element.
    static final int
    ROTATE_180
    Rotate to 180 degrees counter-clockwise.
    static final int
    ROTATE_270
    Rotate to 270 degrees counter-clockwise.
    static final int
    ROTATE_90
    Rotate to 90 degrees counter-clockwise.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getGlyphOrientation()
    Returns the glyph orientation.
    FormulaField
    getGlyphOrientationFormula()
    Returns the formula whose return value determines the glyph orientation.
    int
    getTextRotation()
    Returns the value of the property 'text rotation'.
    FormulaField
    getTextRotationFormula()
    Returns the formula whose return value determines the property 'text rotation'.
    void
    setGlyphOrientation(int orientation)
    Sets the orientation of the glyphs.
    void
    setGlyphOrientationFormula(FormulaField formula)
    Sets the formula whose return value determines the glyph orientation.
    void
    setTextRotation(int rotation)
    Sets the value of the property 'text rotation'.
    void
    setTextRotationFormula(FormulaField formula)
    Sets the formula whose return value determines the property 'text rotation'.

  • Field Details

  • Method Details

    • setGlyphOrientation

      void setGlyphOrientation(int orientation) throws IllegalArgumentException
      Sets the orientation of the glyphs. This is the rotation of every individual character in the line. The default value is GLYPH_DEFAULT, that is, the glyphs point towards the source of the given block progression. Use the GLYPH constants for the orientation.
      Parameters:
      orientation - Orientation to be set for the glyphs (i.e. the rotation of every individual character of the line of text)
      Throws:
      IllegalArgumentException - if the orientation parameter is not allowed
      Since:
      7.1
      See Also:

    • getGlyphOrientation

      int getGlyphOrientation()
      Returns the glyph orientation. This is the rotation of every individual character in the line. The default value is GLYPH_DEFAULT, that is, the glyphs point towards the source of the given block progression. Use the GLYPH constants for the orientation.
      Returns:
      glyph orientation
      Since:
      7.1
      See Also:

    • setTextRotation

      void setTextRotation(int rotation)
      Sets the value of the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. For example, to have a text element have vertical text running from top to bottom and each line run from right to left, you'd set a glyph orientation of GLYPH_LEFT and a text rotation of ROTATE_270.
      Parameters:
      rotation - The new value of the property 'text rotation'. Rotation is done counter-clockwise.
      Since:
      7.1
      See Also:

    • getTextRotation

      int getTextRotation()
      Returns the value of the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. For example, to have a text element have vertical text running from top to bottom and each line run from right to left, you'd set a glyph orientation of GLYPH_LEFT and a text rotation of ROTATE_270.
      Returns:
      The value of the property 'text rotation'.
      Since:
      7.1
      See Also:

    • getTextRotationFormula

      FormulaField getTextRotationFormula()
      Returns the formula whose return value determines the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. This formula should return one of the formula constants Rotate0, Rotate90, Rotate180, or Rotate270.
      Returns:
      formula whose return value determines the property 'text rotation'.
      Since:
      8.0
      See Also:

    • setTextRotationFormula

      void setTextRotationFormula(FormulaField formula)
      Sets the formula whose return value determines the property 'text rotation'. This property defines a final rotation of the entire element after the text is laid out. This formula should return one of the formula constants Rotate0, Rotate90, Rotate180, or Rotate270.
      Parameters:
      formula - formula whose return value determines the property 'text rotation'.
      Since:
      8.0
      See Also:

    • getGlyphOrientationFormula

      FormulaField getGlyphOrientationFormula()
      Returns the formula whose return value determines the glyph orientation. This is the rotation of every individual character in each line. This formula should return one of the formula constants GlyphDefault, GlyphLeft, GlyphRight, or GlyphDown.
      Returns:
      the formula whose return value determines the glyph orientation
      Since:
      8.0

    • setGlyphOrientationFormula

      void setGlyphOrientationFormula(FormulaField formula)
      Sets the formula whose return value determines the glyph orientation. This is the rotation of every individual character in each line. This formula should return one of the formula constants GlyphDefault, GlyphLeft, GlyphRight, or GlyphDown.
      Parameters:
      formula - the formula whose return value determines the glyph orientation
      Since:
      8.0