Interface IFormatter

All Known Implementing Classes:
DefaultFormatter, DocBookFormatter, DOCXFormatter, HTMLFormatter, LaTeXFormatter, PPTXFormatter, RTFFormatter, TextFormatter, XLSXFormatter, XMLFormatter

@OpenApiAll public interface IFormatter
This interface provides support for object layout, common formats for numeric, string, date/time and data.
Since:
Jun 11, 2007 10:49:57 PM
Version:
1.0 Jun 11, 2007
  • Field Details

    • DOT_PER_INCH

      static final int DOT_PER_INCH
      Default dot per inch value.
      See Also:
  • Method Details

    • format

      Object format(Object value)
      Convert an Object value into desire format.
      Parameters:
      value - Object value
      Returns:
      formatted object
    • registerObjectFormatter

      void registerObjectFormatter(Class<?> targetType, IFormatter formatter)
      Register an object formatter to be used to format values of a given target class.
      Parameters:
      targetType - the Class object of the type to be formatted
      formatter - the instance of object of the IFormatter class. If this is null, then any existing definition will be removed.
    • getObjectFormater

      IFormatter getObjectFormater(Class<?> targetType)
      Returns the formatter for the target type class or current formatter if target type class is not registered.
      Parameters:
      targetType - the Class object of the type to be formatted
      Returns:
      the instance of object of the IFormatter class.
    • setStyledDocument

      void setStyledDocument(StyledDocument styledDocument)
      Set a StyledDocument to be used with this formatter.
      Parameters:
      styledDocument - A {link StyledDocument}