Package ch.rabanti.nanoxlsx4j.styles

Class Font

java.lang.Object
ch.rabanti.nanoxlsx4j.styles.AbstractStyle
ch.rabanti.nanoxlsx4j.styles.Font
All Implemented Interfaces:
Comparable<AbstractStyle>
public class Font extends AbstractStyle
Class representing a Font entry. The Font entry is used to define text formatting
Author:
Raphael Stoeckli

  • Field Details

  • Constructor Details

    • Font

      public Font()
      Default constructor

  • Method Details

    • isBold

      public boolean isBold()
      Gets the bold parameter of the font
      Returns:
      If true, the font is bold

    • setBold

      public void setBold(boolean bold)
      Sets the bold parameter of the font
      Parameters:
      bold - If true, the font is bold

    • isItalic

      public boolean isItalic()
      Gets the italic parameter of the font
      Returns:
      If true, the font is italic

    • setItalic

      public void setItalic(boolean italic)
      Sets the italic parameter of the font
      Parameters:
      italic - If true, the font is italic

    • isStrike

      public boolean isStrike()
      Gets whether the font is struck through
      Returns:
      If true, the font is declared as strike-through

    • setStrike

      public void setStrike(boolean strike)
      Sets whether the font is struck through
      Parameters:
      strike - If true, the font is declared as strike-through

    • getUnderline

      public Font.UnderlineValue getUnderline()
      Gets the underline style of the font
      API Note:
      If set to Font.UnderlineValue.none no underline will be applied (default)
      Returns:
      Underline value

    • setUnderline

      public void setUnderline(Font.UnderlineValue underline)
      Sets the underline style of the font
      API Note:
      If set to Font.UnderlineValue.none no underline will be applied (default)
      Parameters:
      underline - Underline value

    • getSize

      public float getSize()
      Gets the font size. Valid range is from 1.0 to 409.0
      Returns:
      Font size

    • setSize

      public void setSize(float size)
      Sets the Font size. Valid range is from 1 to 409
      Parameters:
      size - Font size

    • getName

      public String getName()
      Gets the font name (Default is Calibri)
      Returns:
      Font name

    • setName

      public void setName(String name)
      Sets the font name (Default is Calibri)
      API Note:
      Note that the font name is not validated whether it is a valid or existing font. The font name may not exceed more than 31 characters
      Parameters:
      name - Font name
      Throws:
      StyleException - thrown if the name is null or empty.

    • getFamily

      public String getFamily()
      Gets the font family (Default is 2)
      Returns:
      Font family

    • setFamily

      public void setFamily(String family)
      Sets the font family (Default is 2 = Swiss)
      Parameters:
      family - Font family

    • getColorTheme

      public int getColorTheme()
      Gets the font color theme (Default is 1 = Light)
      Returns:
      Font color theme

    • setColorTheme

      public void setColorTheme(int colorTheme)
      Sets the font color theme (Default is 1)
      Parameters:
      colorTheme - Font color theme
      Throws:
      StyleException - thrown if the number is below 0

    • getColorValue

      public String getColorValue()
      Gets the Font color (default is empty)
      Returns:
      Font color

    • setColorValue

      public void setColorValue(String colorValue)
      Sets the color code of the font color. The value is expressed as hex string with the format AARRGGBB. AA (Alpha) is usually FF.
      To omit the color, an empty string can be set. Empty is also default.
      Parameters:
      colorValue - Font color
      Throws:
      StyleException - thrown if the passed ARGB value is not valid

    • getScheme

      public Font.SchemeValue getScheme()
      Gets the font scheme (Default is minor)
      Returns:
      Font scheme

    • setScheme

      public void setScheme(Font.SchemeValue scheme)
      Sets the Font scheme (Default is minor)
      Parameters:
      scheme - Font scheme

    • getVerticalAlign

      public Font.VerticalAlignValue getVerticalAlign()
      Gets the alignment of the font (Default is none)
      Returns:
      Alignment of the font

    • setVerticalAlign

      public void setVerticalAlign(Font.VerticalAlignValue verticalAlign)
      Sets the Alignment of the font (Default is none)
      Parameters:
      verticalAlign - Alignment of the font

    • getCharset

      public String getCharset()
      Gets the charset of the Font (Default is empty)
      Returns:
      Charset of the Font

    • setCharset

      public void setCharset(String charset)
      Sets the charset of the Font (Default is empty)
      Parameters:
      charset - Charset of the Font

    • isDefaultFont

      public boolean isDefaultFont()
      Gets whether this object is the default font
      Returns:
      In true the font is equals the default font

    • toString

      public String toString()
      Override toString method
      Overrides:
      toString in class Object
      Returns:
      String of a class instance

    • copy

      public Font copy()
      Method to copy the current object to a new one
      Specified by:
      copy in class AbstractStyle
      Returns:
      Copy of the current object without the internal ID

    • hashCode

      public int hashCode()
      Override method to calculate the hash of this component
      Overrides:
      hashCode in class Object
      Implementation Note:
      Note that autogenerated hashcode algorithms may cause collisions. Do not use 0 as fallback value for every field
      Returns:
      Calculated hash as string