Interface RichTextArea.ExtendedFormatter

All Superinterfaces:
RichTextArea.BasicFormatter
All Known Subinterfaces:
RichTextArea.Formatter
Enclosing class:
RichTextArea

@Deprecated public static interface RichTextArea.ExtendedFormatter extends RichTextArea.BasicFormatter
Deprecated.

This interface is used to access full formatting options, when available. If the implementation supports full formatting, then RichTextArea.getExtendedFormatter() 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

    • createLink

      void createLink(String url)
      Deprecated.
      Creates a link to the supplied URL.
      Parameters:
      url - the URL to be linked to
    • insertHorizontalRule

      void insertHorizontalRule()
      Deprecated.
      Inserts a horizontal rule.
    • insertImage

      void insertImage(String url)
      Deprecated.
      Inserts an image element.
      Parameters:
      url - the url of the image to be inserted
    • insertOrderedList

      void insertOrderedList()
      Deprecated.
      Starts an numbered list. Indentation will create nested items.
    • insertUnorderedList

      void insertUnorderedList()
      Deprecated.
      Starts an bulleted list. Indentation will create nested items.
    • isStrikethrough

      boolean isStrikethrough()
      Deprecated.
      Is the current region strikethrough?
      Returns:
      true if the current region is strikethrough
    • leftIndent

      void leftIndent()
      Deprecated.
      Left indent.
    • removeFormat

      void removeFormat()
      Deprecated.
      Removes all formatting on the selected text.
    • removeLink

      void removeLink()
      Deprecated.
      Removes any link from the selected text.
    • rightIndent

      void rightIndent()
      Deprecated.
      Right indent.
    • toggleStrikethrough

      void toggleStrikethrough()
      Deprecated.
      Toggles strikethrough.