Package com.nomagic.magicreport.format.html

Interface StyledDocument

All Known Implementing Classes:
DOCXEngine, PPTXEngine, RTFEngine, XLSXEngine
@OpenApiAll public interface StyledDocument
The interface of object which support document format.
Since:
Jul 23, 2008 11:48:14 AM

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CHARACTER
    The type signature that is expected to be present on any attribute key that contributes to character level presentation.
    static final int
    COLOR
    The type signature that is expected to be present on any attribute key that contributes to presentation of color.
    static final int
    FONT
    The type signature that is expected to be present on any attribute key that contributes to the determination of what font to use to render some text.
    static final int
    PARAGRAPH
    The type signature that is expected to be present on any attribute key that contributes to the paragraph level presentation.
    static final int
    TABLE
    The type signature that is expected to be present on any attribute key that contributes to the table presentation.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    addColor(Color color)
    Appends the specified color to the document's color table.
    int
    addFont(Font font)
    Appends the specified font to the document's font table.
    int
    addList(List list)
    Appends the specified list item to the document's style table.
    int
    addObject(Object object)
    Appends object content into the document.
    int
    addStyle(Style style)
    Appends the specified style to the document's style table.

  • Field Details

    • CHARACTER

      static final int CHARACTER
      The type signature that is expected to be present on any attribute key that contributes to character level presentation.
      See Also:

    • COLOR

      static final int COLOR
      The type signature that is expected to be present on any attribute key that contributes to presentation of color.
      See Also:

    • FONT

      static final int FONT
      The type signature that is expected to be present on any attribute key that contributes to the determination of what font to use to render some text.
      See Also:

    • PARAGRAPH

      static final int PARAGRAPH
      The type signature that is expected to be present on any attribute key that contributes to the paragraph level presentation.
      See Also:

    • TABLE

      static final int TABLE
      The type signature that is expected to be present on any attribute key that contributes to the table presentation.
      See Also:

  • Method Details

    • addColor

      int addColor(Color color)
      Appends the specified color to the document's color table. Returns an index of color from table.
      Parameters:
      color - specified color.
      Returns:
      index of color from color table in document.

    • addFont

      int addFont(Font font)
      Appends the specified font to the document's font table. Returns an index of font from table.
      Parameters:
      font - specified font.
      Returns:
      index of font from font table in document.

    • addList

      int addList(List list)
      Appends the specified list item to the document's style table. Returns an index of list from table.
      Parameters:
      list - specified list.
      Returns:
      index of list from style table in document.

    • addStyle

      int addStyle(Style style)
      Appends the specified style to the document's style table. Return an index of style from table.
      Parameters:
      style - a style. Reproduce from StyleContext.NamedStyle
      Returns:
      index of style from style table in document.

    • addObject

      int addObject(Object object)
      Appends object content into the document.
      Parameters:
      object - adding object
      Returns:
      index to object