no.g9.client.support

Class G9Document

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

no.g9.client.support.G9Document

All Implemented Interfaces:

Serializable, Document, G9FieldValue

Direct Known Subclasses:

DateDocument, DateMidnightDocument, DateTimeDocument, EnumeratorDocument, LocalDateDocument, LocalDateTimeDocument, LocalTimeDocument, NumberDocument, TextDocument

public class G9Document
extends PlainDocument
implements G9FieldValue

Superclass for Document models with output formats.

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
G9Document() (missing javadoc)
G9Document(int datatype, String inputFormat, String outputFormat, int maxLength)

Method Summary

Modifier and Type	Method and Description
String	format() Default implementation is to return getValue().toString
String	format(Object o) Formats the specified object to the string representation of that object.
int	getDatatype() Access method for the datatype property.
String	getInputFormat() Access method for the inputFormat property.
boolean	getInputMode() Determines if the inputMode property is true.
int	getMaxLength() Access method for the maxLength property.
String	getName()
String	getOutputFormat() Access method for the outputFormat property.
String	getOutputText() Returns the output text representation of the value object when display rules are applied.
Object	getValue()
Object	parse(String str) Default implementation is to return the input string.
void	setInputFormat(String aInputFormat) Sets the value of the inputFormat property.
void	setInputMode(boolean aInputMode) Sets the value of the inputMode property.
void	setMaxLength(int aMaxLength) Sets the value of the maxLength property.
void	setName(String name)
void	setOutputFormat(String aOutputFormat) Sets the value of the outputFormat property.
void	setValue(Object value)
String	toString()
Object	transform(Object o) Internal use! Transform an object to the text version and back.

Methods inherited from class javax.swing.text.PlainDocument

createDefaultRoot, getDefaultRootElement, getParagraphElement, insertString, 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

G9Document

public G9Document(int datatype,
                  String inputFormat,
                  String outputFormat,
                  int maxLength)

Parameters:

datatype - (missing javadoc)

inputFormat - (missing javadoc)

outputFormat - (missing javadoc)

maxLength - (missing javadoc)

G9Document

public G9Document()

(missing javadoc)

Method Detail

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getDatatype

public int getDatatype()

Access method for the datatype property.

Returns:

the current value of the datatype property

getInputFormat

public String getInputFormat()

Access method for the inputFormat property.

Returns:

the current value of the inputFormat property

setInputFormat

public void setInputFormat(String aInputFormat)

Sets the value of the inputFormat property.

Parameters:

aInputFormat - the new value of the inputFormat property

getOutputFormat

public String getOutputFormat()

Access method for the outputFormat property.

Returns:

the current value of the outputFormat property

setOutputFormat

public void setOutputFormat(String aOutputFormat)

Sets the value of the outputFormat property.

Parameters:

aOutputFormat - the new value of the outputFormat property

getMaxLength

public int getMaxLength()

Access method for the maxLength property.

Returns:

the current value of the maxLength property

setMaxLength

public void setMaxLength(int aMaxLength)

Sets the value of the maxLength property.

Parameters:

aMaxLength - the new value of the maxLength property

getInputMode

public boolean getInputMode()

Determines if the inputMode property is true.

Returns:

true if the inputMode property is true

setInputMode

public void setInputMode(boolean aInputMode)

Sets the value of the inputMode property.

Parameters:

aInputMode - the new value of the inputMode property

setValue

public void setValue(Object value)

Specified by:

setValue in interface G9FieldValue

Parameters:

value - (missing javadoc)

getValue

public Object getValue()

Specified by:

getValue in interface G9FieldValue

Returns:

(missing javadoc)

format

public String format()

Default implementation is to return getValue().toString

Specified by:

format in interface G9FieldValue

Returns:

the formatted value according to the internal format.

See Also:

G9FieldValue.format()

format

public String format(Object o)

Formats the specified object to the string representation of that object. Default implementation is to invoke o.toString.

Parameters:

o - the object to format

Returns:

the string representation of the specified object

parse

public Object parse(String str)
             throws ParseException

Default implementation is to return the input string.

Specified by:

parse in interface G9FieldValue

Parameters:

str - (missing javadoc)

Returns:

(missing javadoc)

Throws:

ParseException - (missing javadoc)

See Also:

G9FieldValue.parse(java.lang.String)

getOutputText

public String getOutputText()

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

Returns:

the output text representation of the value object.

transform

public Object transform(Object o)

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

Parameters:

o - the object to transform

Returns:

the transformed object

toString

public String toString()

Overrides:

toString in class Object