Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.component.text

Class SizedDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

is.codion.swing.common.ui.component.text.SizedDocument

All Implemented Interfaces:

Serializable, Document

public final class SizedDocument
extends PlainDocument

A Document implementation which allows for setting the max text length and automatic conversion to upper or lower case. For instances use the sizedDocument() or sizedDocument(int) factory methods.

See Also:

• sizedDocument()
• sizedDocument(int)
• 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

Method Summary

Modifier and Type	Method	Description
CaseDocumentFilter	getDocumentFilter()
int	getMaximumLength()
void	setDocumentFilter(DocumentFilter filter)
void	setMaximumLength(int maximumLength)
static SizedDocument	sizedDocument()
static SizedDocument	sizedDocument(int maximumLength)

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, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Method Details

setDocumentFilter

public void setDocumentFilter(DocumentFilter filter)

Overrides:

setDocumentFilter in class AbstractDocument

Parameters:

filter - the filter

Throws:

UnsupportedOperationException - always

getDocumentFilter

public CaseDocumentFilter getDocumentFilter()

Overrides:

getDocumentFilter in class AbstractDocument

getMaximumLength

public int getMaximumLength()

Returns:

the maximum length of the text to allow, -1 if unlimited

setMaximumLength

public void setMaximumLength(int maximumLength)

Parameters:

maximumLength - the maximum length of the text to allow, -1 if unlimited

sizedDocument

public static SizedDocument sizedDocument()

Returns:

a new SizedDocument

sizedDocument

public static SizedDocument sizedDocument(int maximumLength)

Parameters:

maximumLength - the maximum text length

Returns:

a new SizedDocument