no.g9.client.support

Class TextDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

no.g9.client.support.G9Document

no.g9.client.support.TextDocument

All Implemented Interfaces:

Serializable, Document, G9FieldValue

public class TextDocument
extends G9Document

Document model for fields with text formatting.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Field Summary

Fields inherited from class javax.swing.text.PlainDocument

lineLimitAttribute, tabSizeAttribute

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

Constructors

Constructor and Description
TextDocument(int datatype, String inputFormat, String outputFormat, int maxLength, int caseConvertion)

Method Summary

Modifier and Type	Method and Description
String	getOutputText() Returns the output text representation of the value object when display rules are applied.
Object	getValue()
void	insertString(int offset, String str, AttributeSet attr)
Object	parse(String s) Default implementation is to return the input string.
void	setValue(Object value)
Object	transform(Object o) Internal use! Transform an object to the text version and back.

Methods inherited from class no.g9.client.support.G9Document

format, format, getDatatype, getInputFormat, getInputMode, getMaxLength, getName, getOutputFormat, setInputFormat, setInputMode, setMaxLength, setName, setOutputFormat, toString

Methods inherited from class javax.swing.text.PlainDocument

createDefaultRoot, getDefaultRootElement, getParagraphElement, insertUpdate, removeUpdate

Methods inherited from class javax.swing.text.AbstractDocument

addDocumentListener, addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TextDocument

public TextDocument(int datatype,
                    String inputFormat,
                    String outputFormat,
                    int maxLength,
                    int caseConvertion)

Parameters:

datatype - (missing javadoc)

inputFormat - (missing javadoc)

outputFormat - (missing javadoc)

maxLength - (missing javadoc)

caseConvertion - -1: lowercase, 0: nocase, 1: uppercase

Roseuid:

44325EED024A

Method Detail

insertString

public void insertString(int offset,
                         String str,
                         AttributeSet attr)
                  throws BadLocationException

Specified by:

insertString in interface Document

Overrides:

insertString in class PlainDocument

Throws:

BadLocationException

setValue

public void setValue(Object value)

Specified by:

setValue in interface G9FieldValue

Overrides:

setValue in class G9Document

Parameters:

value - (missing javadoc)

getValue

public Object getValue()

Specified by:

getValue in interface G9FieldValue

Overrides:

getValue in class G9Document

Returns:

(missing javadoc)

parse

public Object parse(String s)

Description copied from class: G9Document

Default implementation is to return the input string.

Specified by:

parse in interface G9FieldValue

Overrides:

parse in class G9Document

Parameters:

s - (missing javadoc)

Returns:

(missing javadoc)

See Also:

G9FieldValue.parse(java.lang.String)

transform

public Object transform(Object o)

Description copied from class: G9Document

Internal use! Transform an object to the text version and back. This ensures that when comparing to objects they are equally formatted.

Overrides:

transform in class G9Document

Parameters:

o - the object to transform

Returns:

the transformed object

getOutputText

public String getOutputText()

Description copied from class: G9Document

Returns the output text representation of the value object when display rules are applied. Default implementation is to return getValue().toString().

Overrides:

getOutputText in class G9Document

Returns:

the output text representation of the value object.