Class RichTextValue

java.lang.Object
com.jgraph.components.labels.RichTextValue
All Implemented Interfaces:
Serializable, Cloneable
public class RichTextValue extends Object implements Serializable, Cloneable
Rich text replacement for string values in RichTextBusinessObject. This requirs the MultiLineVertexView to provide a rich text editor and renderer.
See Also:

  • Field Details

    • editorKit

      public static RTFEditorKit editorKit
      Holds the shared editor kit for creating new documents.

    • richText

      protected String richText
      Holds the rich text as an RTF encoded text.

    • plainText

      protected String plainText
      A plain-text representation of the rich text is always keps along with the rich text value to speedup the toString() method.

  • Constructor Details

    • RichTextValue

      public RichTextValue()
      Constructs a new empty rich text value.

    • RichTextValue

      public RichTextValue(Document document)
      Constructs a new rich text value using the specified document.
      Parameters:
      document - The document to obtain the rich text from.

    • RichTextValue

      public RichTextValue(String stringValue)
      Constructs a new rich text document using the string text.
      Parameters:
      stringValue - The string to use as the initial value.

  • Method Details

    • insertInto

      public void insertInto(Document document)
      Inserts this rich text into the specified component. This implementation silently ignores all exceptions.
      Parameters:
      document - The document to insert the rich text into.

    • getRichText

      public String getRichText()
      Returns the richt text value as an RTF encoded string.
      Returns:
      Returns the rich text.

    • setRichText

      public void setRichText(String richText)
      Sets the richt text value as an RTF encoded string and updates plainText.
      Parameters:
      richText - The rich text to set.

    • toString

      public String toString()
      Returns the plain text representation of this rich text value.
      Overrides:
      toString in class Object
      Returns:
      Returns plainText.

    • getRichText

      public static String getRichText(Document document)
      Returns the rich text encoded RTF string from the specified document.
      Parameters:
      document - The document to be converted.
      Returns:
      Returns the RTF encoded document.

    • getPlainText

      public static String getPlainText(RichTextValue richText)
      Returns a plain text representation of the specified rich text value. If an exception occurs during conversion then the RTF encoded string is returned instead.
      Parameters:
      richText - The rich text value to be converted.
      Returns:
      Returns the plain text representation.

    • createDefaultDocument

      protected static Document createDefaultDocument()
      Hook for subclassers to create a default document. This implementation uses createDefaultDocument(String) with a value of null.
      Returns:
      Returns a new empty default document.

    • createDefaultDocument

      public static Document createDefaultDocument(String value)
      Hook for subclassers to create a default document. This implementation uses editorKit to create the document and sets its value.
      Returns:
      Returns a new empty default document.