org.tentackle.swing

Class FormFieldDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

org.tentackle.swing.FormFieldDocument

All Implemented Interfaces:

Serializable, Document

public class FormFieldDocument
extends PlainDocument

Document for FormFieldComponents.

Author:

harald

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

Modifier and Type	Field and Description
static Function<String,String>	defaultConverter The default converter that applies to all components. Default is null.

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
FormFieldDocument(FormFieldComponent field) Creates a form field document.

Method Summary

Modifier and Type	Method and Description
Function<String,String>	getConverter() Gets the current converter.
Function<String,String>	getEffectiveConverter() Gets the effective converter.
void	insertString(int offs, String str, AttributeSet a)
void	remove(int offs, int len)
void	setConverter(Function<String,String> converter) Sets the string converter.

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, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Field Detail

defaultConverter

public static Function<String,String> defaultConverter

The default converter that applies to all components.
Default is null.

Constructor Detail

FormFieldDocument

public FormFieldDocument(FormFieldComponent field)

Creates a form field document.

Parameters:

field - the form field component

Method Detail

getConverter

public Function<String,String> getConverter()

Gets the current converter. Default is null.

Returns:

the converter.

setConverter

public void setConverter(Function<String,String> converter)

Sets the string converter.

Parameters:

converter - the string converter

getEffectiveConverter

public Function<String,String> getEffectiveConverter()

Gets the effective converter.

Returns the defaultConverter if there is no converter for this component. Otherwise the component-specific converter applies.

Returns:

the converter, null if none

insertString

public void insertString(int offs,
                         String str,
                         AttributeSet a)
                  throws BadLocationException

Overridden to implement autoSelect, character conversion, valid and invalid character check, filler, insert/override, maxColumns, adjustment, etc...

Specified by:

insertString in interface Document

Overrides:

insertString in class PlainDocument

Throws:

BadLocationException

remove

public void remove(int offs,
                   int len)
            throws BadLocationException

Specified by:

remove in interface Document

Overrides:

remove in class AbstractDocument

Throws:

BadLocationException