Package ch.rabanti.nanoxlsx4j.styles

Class NumberFormat

java.lang.Object
ch.rabanti.nanoxlsx4j.styles.AbstractStyle
ch.rabanti.nanoxlsx4j.styles.NumberFormat
All Implemented Interfaces:
Comparable<AbstractStyle>
public class NumberFormat extends AbstractStyle
Class representing a NumberFormat entry. The NumberFormat entry is used to define cell formats like currency or date
Author:
Raphael Stoeckli

  • Field Details

    • CUSTOMFORMAT_START_NUMBER

      public static final int CUSTOMFORMAT_START_NUMBER
      Start ID for custom number formats as constant (value 164)
      See Also:

    • DEFAULT_NUMBER

      public static final NumberFormat.FormatNumber DEFAULT_NUMBER
      Default format number as constant

  • Constructor Details

    • NumberFormat

      public NumberFormat()
      Default constructor

  • Method Details

    • getNumber

      public NumberFormat.FormatNumber getNumber()
      Gets the format number. Set it to custom (164) in case of custom number formats
      Returns:
      Format number

    • setNumber

      public void setNumber(NumberFormat.FormatNumber number)
      Sets the format number. Set it to custom (164) in case of custom number formats
      Parameters:
      number - Format number

    • getCustomFormatID

      public int getCustomFormatID()
      Gets the format number of the custom format. Must be higher or equal then predefined custom number (164)
      Returns:
      Format number of the custom format

    • setCustomFormatID

      public void setCustomFormatID(int customFormatID)
      Sets the format number of the custom format. Must be higher or equal then predefined custom number (164)
      Parameters:
      customFormatID - Format number of the custom format

    • getCustomFormatCode

      public String getCustomFormatCode()
      Gets the custom format code in the notation of Excel
      Returns:
      Custom format code

    • setCustomFormatCode

      public void setCustomFormatCode(String customFormatCode)
      Sets the raw custom format code in the notation of Excel. The code is not escaped or un-escaped (on workbook loading)
      API Note:
      Currently, there is no auto-escaping applied to custom format strings. For instance, to add a white space, internally it is escaped by a backspace (\ ). To get a valid custom format code, this escaping must be applied manually, according to OOXML specs: Part 1 - Fundamentals And Markup Language Reference, Chapter 18.8.31
      Parameters:
      customFormatCode - Custom format code
      Throws:
      FormatException - thrown if the passed value is null or empty

    • isCustomFormat

      public boolean isCustomFormat()
      Gets whether this object is a custom format
      Returns:
      Returns true in case of a custom format (higher or equals 164)

    • toString

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

    • copy

      public NumberFormat 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

    • tryParseFormatNumber

      public static NumberFormat.NumberFormatEvaluation tryParseFormatNumber(int number)
      Tries to parse registered format numbers. If the parsing fails, it is assumed that the number is a custom format number (164 or higher) and 'custom' is returned
      Parameters:
      number - Raw number to parse
      Returns:
      Format range. Will return 'invalid' if out of any range (e.g. negative value)

    • isDateFormat

      public static boolean isDateFormat(NumberFormat.FormatNumber number)
      Determines whether a defined style format number represents a date (or date and time).
      Note: Custom number formats (higher than 164), as well as not officially defined numbers (below 164) are currently not considered during the check and will return false
      Parameters:
      number - Format number to check
      Returns:
      True if the format represents a date, otherwise false

    • isTimeFormat

      public static boolean isTimeFormat(NumberFormat.FormatNumber number)
      Determines whether a defined style format number represents a time.
      Note: Custom number formats (higher than 164), as well as not officially defined numbers (below 164) are currently not considered during the check and will return false
      Parameters:
      number - Format number to check
      Returns:
      True if the format represents a time, otherwise false