Interface RichTextArea.BasicFormatter

All Known Subinterfaces:
RichTextArea.ExtendedFormatter, RichTextArea.Formatter
Enclosing class:
RichTextArea

@Deprecated public static interface RichTextArea.BasicFormatter
Deprecated.

This interface is used to access basic formatting options, when available. If the implementation supports basic formatting, then RichTextArea.getBasicFormatter() will return an instance of this class.

The formatter will format the user selected text in the RichTextArea. As a result, it will only work reliably if the RichTextArea is attached, visible to on the page, and has been focused at least once. If you just want to initialize the content of the RichTextArea, use RichTextArea.setHTML(String) instead.

  • Method Details

    • getBackColor

      String getBackColor()
      Deprecated.
      Gets the background color.
      Returns:
      the background color
    • getForeColor

      String getForeColor()
      Deprecated.
      Gets the foreground color.
      Returns:
      the foreground color
    • isBold

      boolean isBold()
      Deprecated.
      Is the current region bold?
      Returns:
      true if the current region is bold
    • isItalic

      boolean isItalic()
      Deprecated.
      Is the current region italic?
      Returns:
      true if the current region is italic
    • isSubscript

      boolean isSubscript()
      Deprecated.
      Is the current region subscript?
      Returns:
      true if the current region is subscript
    • isSuperscript

      boolean isSuperscript()
      Deprecated.
      Is the current region superscript?
      Returns:
      true if the current region is superscript
    • isUnderlined

      boolean isUnderlined()
      Deprecated.
      Is the current region underlined?
      Returns:
      true if the current region is underlined
    • selectAll

      void selectAll()
      Deprecated.
      Selects all the text.
    • setBackColor

      void setBackColor(String color)
      Deprecated.
      Sets the background color.
      Parameters:
      color - the new background color
    • setFontName

      void setFontName(String name)
      Deprecated.
      Sets the font name.
      Parameters:
      name - the new font name
    • setFontSize

      void setFontSize(RichTextArea.FontSize fontSize)
      Deprecated.
      Sets the font size.
      Parameters:
      fontSize - the new font size
    • setForeColor

      void setForeColor(String color)
      Deprecated.
      Sets the foreground color.
      Parameters:
      color - the new foreground color
    • setJustification

      void setJustification(RichTextArea.Justification justification)
      Deprecated.
      Sets the justification.
      Parameters:
      justification - the new justification
    • toggleBold

      void toggleBold()
      Deprecated.
      Toggles bold.
    • toggleItalic

      void toggleItalic()
      Deprecated.
      Toggles italic.
    • toggleSubscript

      void toggleSubscript()
      Deprecated.
      Toggles subscript.
    • toggleSuperscript

      void toggleSuperscript()
      Deprecated.
      Toggles superscript.
    • toggleUnderline

      void toggleUnderline()
      Deprecated.
      Toggles underline.