Class AbstractFontElement

All Implemented Interfaces:
FontProperties, GeneralProperties, NodeParser, com.inet.report.ReferenceHolder, Serializable, Cloneable
Direct Known Subclasses:
AbstractValueElement, JavaBean, Subreport, TextPart

public abstract class AbstractFontElement extends Element implements FontProperties
The abstract class AbstractFontElement implements FontProperties class and extends Element. Inherit from this class to support Elements that receive Font properties.
Since:
6.0
See Also:
  • Method Details

    • setFontSize

      public final void setFontSize(int newValue)
      Sets the value of the property 'font size'. Use this property to change the font format of the labels in this field element.
      Specified by:
      setFontSize in interface FontProperties
      Parameters:
      newValue - The font size in points, e.g. 8.
      Throws:
      IllegalArgumentException - if newValue is negative
      Since:
      6.0
    • getFontSize

      public int getFontSize()
      Returns the value of the property 'font size', rounded to an integer(!). For full accuracy you will want to use getFontSizeTwips() instead. Use this property to change the font format of the labels in this field element.
      Specified by:
      getFontSize in interface FontProperties
      Returns:
      The font size in points, rounded to an integer. For full accuracy you will want to use getFontSizeTwips() instead.
      Since:
      6.0
    • setFontSizeFormula

      public final void setFontSizeFormula(FormulaField newFormula)
      Sets the formula for the property 'font size'. Use this property to change the font format of the labels in this field element.
      Specified by:
      setFontSizeFormula in interface FontProperties
      Parameters:
      newFormula - The new formula for the property 'font size'.
      Since:
      6.0
    • getFontSizeFormula

      public FormulaField getFontSizeFormula()
      Returns the formula for the property 'font size'. Use this property to change the font format of the labels in this field element.
      Specified by:
      getFontSizeFormula in interface FontProperties
      Returns:
      FormulaField The formula for the property 'font size'.
      Since:
      6.0
      See Also:
    • getFontName

      public String getFontName()
      Returns the value of the property 'font name'. Use this property to change the name of the font, used by the labels in this field element.
      Specified by:
      getFontName in interface FontProperties
      Returns:
      The value of the property 'font name'.
      Since:
      6.0
    • setFontName

      public final void setFontName(String newValue)
      Sets the value of the property 'font name'. Use this property to change the name of the font, used by the labels in this field element.
      The font name will be used when the font-mapping to symbolic fonts is switched off in the i-net Clear Reports configuration (see UseNativeFonts and FontPath= for PDF export)
      Specified by:
      setFontName in interface FontProperties
      Parameters:
      newValue - The new value of the property 'font name'.
      Since:
      6.0
    • setFontNameFormula

      public final void setFontNameFormula(FormulaField newFormula)
      Sets the formula for the property 'font name'. Use this property to change the name of the font, used by the labels in this field element.
      Specified by:
      setFontNameFormula in interface FontProperties
      Parameters:
      newFormula - The formula for the property 'font name'.
      Since:
      6.0
    • getFontNameFormula

      public FormulaField getFontNameFormula()
      Returns the formula for the property 'font name'. Use this property to change the name of the font, used by the labels in this field element.
      Specified by:
      getFontNameFormula in interface FontProperties
      Returns:
      FormulaField The formula for the property 'font name'.
      Since:
      6.0
    • getFontStyle

      public int getFontStyle()
      Returns the value of the property 'font style'. The 'font style' property represents the different styles of a font, which can be italic, underline and/or strike out.
      Specified by:
      getFontStyle in interface FontProperties
      Returns:
      The value of the property 'font style', where
      italic is represented by second bit of newValue,
      underline by the third bit of newValue,
      strikeout by the fourth bit of newValue.
      Since:
      6.0
      See Also:
    • setFontStyle

      public final void setFontStyle(int fontStyle)
      Sets the value of the property 'font style'. The 'font style' property represents the different styles of a font, which can be cursive, underline and/or strike out.
      Specified by:
      setFontStyle in interface FontProperties
      Parameters:
      fontStyle - The new font style, where
      bold is represented by the first bit,
      cursive is represented by the second bit,
      underline by the third bit,
      strikeout by the fourth bit.
      Since:
      6.0
      See Also:
    • setFontStyleFormula

      public final void setFontStyleFormula(FormulaField newFormula)
      Sets the formula for the property 'font style'. The 'font style' property represents the different styles of a font, which can be cursive, underline and/or strike out.
      Specified by:
      setFontStyleFormula in interface FontProperties
      Parameters:
      newFormula - The new formula for the property 'font style'. The result of the formula should be within the range from 0 to 15, where
      bold is represented by the first bit,
      cursive is represented by the second bit,
      underline by the third bit,
      strikeout by the fourth bit.
      Since:
      6.0
    • getFontStyleFormula

      public FormulaField getFontStyleFormula()
      Returns the formula for the property 'font style'. The 'font style' property represents the different styles of a font, which can be cursive, underline and/or strike out.
      Specified by:
      getFontStyleFormula in interface FontProperties
      Returns:
      FormulaField The formula for the property 'font style'.
      Since:
      6.0
    • setItalic

      public final void setItalic(boolean newValue)
      Sets the value of the property 'italic'. Use this property to toggle the font style of a text.
      Specified by:
      setItalic in interface FontProperties
      Parameters:
      newValue - true if the property should be set, else false
      Since:
      6.0
      See Also:
    • isItalic

      public boolean isItalic()
      Returns whether the text in this element is italic or not.
      Specified by:
      isItalic in interface FontProperties
      Returns:
      true if the text is italic, false otherwise.
      Since:
      7.0
      See Also:
    • isUnderline

      public boolean isUnderline()
      Returns whether the text in this element is underlined or not.
      Specified by:
      isUnderline in interface FontProperties
      Returns:
      true if the text is underlined, false otherwise.
      Since:
      7.0
      See Also:
    • getUnderlineFormula

      public FormulaField getUnderlineFormula()
      Returns the formula field for the property 'underline'.
      Specified by:
      getUnderlineFormula in interface FontProperties
      Returns:
      the formula field for the property 'underline'.
      Since:
      6.0
    • isStrikeout

      public boolean isStrikeout()
      Returns whether the text in this element is struck through or not.
      Specified by:
      isStrikeout in interface FontProperties
      Returns:
      true if the text is struck through, false otherwise.
      Since:
      7.0
      See Also:
    • getStrikeoutFormula

      public FormulaField getStrikeoutFormula()
      Returns The formula field for the property 'strike out'.
      Specified by:
      getStrikeoutFormula in interface FontProperties
      Returns:
      The formula field for the property 'strike out'.
      Since:
      6.0
    • setUnderline

      public final void setUnderline(boolean newValue)
      Sets the value of the property 'underline'. Use this property to underline a text.
      Specified by:
      setUnderline in interface FontProperties
      Parameters:
      newValue - true if the property should be set, else false
      Since:
      6.0
      See Also:
    • setUnderlineFormula

      public final void setUnderlineFormula(FormulaField newFormula)
      Sets the formula field for the property 'underline'.
      Specified by:
      setUnderlineFormula in interface FontProperties
      Parameters:
      newFormula - the formula field for the property 'underline'.
      Since:
      6.0
    • setStrikeout

      public final void setStrikeout(boolean newValue)
      Sets the value of the property 'strike out'. Use this property to strike out a text.
      Specified by:
      setStrikeout in interface FontProperties
      Parameters:
      newValue - true if the property should be set, else false
      Since:
      6.0
      See Also:
    • setStrikeoutFormula

      public final void setStrikeoutFormula(FormulaField newFormula)
      Set the formula field for the property 'strike out'.
      Specified by:
      setStrikeoutFormula in interface FontProperties
      Parameters:
      newFormula - The formula field for the property 'strike out'.
      Since:
      6.0
    • isBold

      public boolean isBold()
      Returns whether the text in this element is bold or not.
      Specified by:
      isBold in interface FontProperties
      Returns:
      true if the text is bold, false otherwise.
      Since:
      7.0
      See Also:
    • setBold

      public void setBold(boolean newValue)
      Sets the value of the property 'font bold'. Use this property to toggle the font style of a text.
      Specified by:
      setBold in interface FontProperties
      Parameters:
      newValue - Whether or not this font element is to be set as bold. Note that this property can be overridden if a property formula is defined.
      Since:
      6.0
      See Also:
    • setFontColor

      public void setFontColor(int newValue)
      Sets the value of the property 'font color'. Use this property to change the color of the font.
      Specified by:
      setFontColor in interface FontProperties
      Parameters:
      newValue - The new value of the property 'font color'.
      Since:
      6.0
    • setFontColorFormula

      public void setFontColorFormula(FormulaField newFormula)
      Sets the formula of the property 'font color'. Use this property to change the color of the font.
      Specified by:
      setFontColorFormula in interface FontProperties
      Parameters:
      newFormula - The new formula for the property 'font color'.
      Since:
      6.0
    • getFontColor

      public int getFontColor()
      Returns the value of the property 'font color'. Use this property to change the color of the font.
      Specified by:
      getFontColor in interface FontProperties
      Returns:
      The value of the property 'font color'.
      Since:
      6.0
    • getFontColorFormula

      public FormulaField getFontColorFormula()
      Returns the formula for the property 'font color'. Use this property to change the color of the font.
      Specified by:
      getFontColorFormula in interface FontProperties
      Returns:
      FormulaField The formula for the property 'font color'.
      Since:
      6.0
    • setFontSizeTwips

      public void setFontSizeTwips(int newValue)
      Sets the value of the property 'font size'.
      Specified by:
      setFontSizeTwips in interface FontProperties
      Parameters:
      newValue - The font size in Twips.
      Throws:
      IllegalArgumentException - if newValue is negative
      Since:
      6.0
    • getFontSizeTwips

      public int getFontSizeTwips()
      Returns the value of the property 'font size' in Twips.
      Specified by:
      getFontSizeTwips in interface FontProperties
      Returns:
      The font size in Twips.
      Since:
      6.0
    • getPropertyFormulas

      public List<FormulaField> getPropertyFormulas()
      Returns a list with all property formulas that are set for this report element. This includes property formulas for any type of sub-component but excludes formulas for any descendant ReportComponent of this one. To get the property formulas for descendant ReportComponent use ReportComponent.getSubComponents()
      Overrides:
      getPropertyFormulas in class Element
      Returns:
      List of property formulas
    • parseElement

      public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String,Object> parserMap) throws FatalParserException
      FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

      Parses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.

      Specified by:
      parseElement in interface NodeParser
      Overrides:
      parseElement in class Element
      Parameters:
      group - XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.
      tag - The XMLTag to be parsed
      atts - The set of attributes in the current XMLTag
      parserMap - The map of current Parser.
      Returns:
      The NodeParser sub-element if one needed to be created, or null if none was created.
      Throws:
      FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.