public class RichTextValue
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
RichTextBusinessObject
.
This requirs the MultiLineVertexView
to provide a rich text editor
and renderer.RichTextGraphModel
,
VertexRenderer
,
RTFEditorKit
,
Serialized FormModifier and Type | Field and Description |
---|---|
static javax.swing.text.rtf.RTFEditorKit |
editorKit
Holds the shared editor kit for creating new documents.
|
protected java.lang.String |
plainText
A plain-text representation of the rich text is always keps along with
the rich text value to speedup the
toString() method. |
protected java.lang.String |
richText
Holds the rich text as an RTF encoded text.
|
Constructor and Description |
---|
RichTextValue()
Constructs a new empty rich text value.
|
RichTextValue(javax.swing.text.Document document)
Constructs a new rich text value using the specified document.
|
RichTextValue(java.lang.String stringValue)
Constructs a new rich text document using the string text.
|
Modifier and Type | Method and Description |
---|---|
protected static javax.swing.text.Document |
createDefaultDocument()
Hook for subclassers to create a default document.
|
static javax.swing.text.Document |
createDefaultDocument(java.lang.String value)
Hook for subclassers to create a default document.
|
static java.lang.String |
getPlainText(RichTextValue richText)
Returns a plain text representation of the specified rich text value.
|
java.lang.String |
getRichText()
Returns the richt text value as an RTF encoded string.
|
static java.lang.String |
getRichText(javax.swing.text.Document document)
Returns the rich text encoded RTF string from the specified document.
|
void |
insertInto(javax.swing.text.Document document)
Inserts this rich text into the specified component.
|
void |
setRichText(java.lang.String richText)
Sets the richt text value as an RTF encoded string and updates
plainText . |
java.lang.String |
toString()
Returns the plain text representation of this rich text value.
|
public static javax.swing.text.rtf.RTFEditorKit editorKit
protected java.lang.String richText
protected java.lang.String plainText
toString()
method.public RichTextValue()
public RichTextValue(javax.swing.text.Document document)
document
- The document to obtain the rich text from.public RichTextValue(java.lang.String stringValue)
stringValue
- The string to use as the initial value.public void insertInto(javax.swing.text.Document document)
document
- The document to insert the rich text into.public java.lang.String getRichText()
public void setRichText(java.lang.String richText)
plainText
.richText
- The rich text to set.public java.lang.String toString()
toString
in class java.lang.Object
plainText
.public static java.lang.String getRichText(javax.swing.text.Document document)
document
- The document to be converted.public static java.lang.String getPlainText(RichTextValue richText)
richText
- The rich text value to be converted.protected static javax.swing.text.Document createDefaultDocument()
createDefaultDocument(String)
with a value of null.public static javax.swing.text.Document createDefaultDocument(java.lang.String value)
editorKit
to create the document and sets its value.Copyright (C) 2001-2009 JGraph Ltd. All rights reserved.