com.alee.utils.swing
Class LimitedDocument

java.lang.Object
  javax.swing.text.AbstractDocument
      javax.swing.text.PlainDocument
          com.alee.utils.swing.LimitedDocument

All Implemented Interfaces:

java.io.Serializable, javax.swing.text.Document

public class LimitedDocument
extends javax.swing.text.PlainDocument

Plain document limited by characters number.

Author:

Mikle Garin

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.text.AbstractDocument.AbstractElement, javax.swing.text.AbstractDocument.AttributeContext, javax.swing.text.AbstractDocument.BranchElement, javax.swing.text.AbstractDocument.Content, javax.swing.text.AbstractDocument.DefaultDocumentEvent, javax.swing.text.AbstractDocument.ElementEdit, javax.swing.text.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

LimitedDocument()
Constructs new limited document.

LimitedDocument(int limit)
Constructs new limited document.

LimitedDocument(int limit, boolean upper)
Constructs new limited document.

Method Summary

int	getLimit() Returns document characters limit.
void	insertString(int offset, java.lang.String str, javax.swing.text.AttributeSet attr)
boolean	isToUppercase() Returns whether should translate all characters to upper case or not.

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, toString, wait, wait, wait

Constructor Detail

LimitedDocument

public LimitedDocument()

Constructs new limited document.

LimitedDocument

public LimitedDocument(int limit)

Constructs new limited document.

Parameters:

limit - characters limit

LimitedDocument

public LimitedDocument(int limit,
                       boolean upper)

Constructs new limited document.

Parameters:

limit - characters limit

upper - whether should translate all characters to upper case or not

Method Detail

getLimit

public int getLimit()

Returns document characters limit.

Returns:

document characters limit

isToUppercase

public boolean isToUppercase()

Returns whether should translate all characters to upper case or not.

Returns:

true if should translate all characters to upper case, false otherwise

insertString

public void insertString(int offset,
                         java.lang.String str,
                         javax.swing.text.AttributeSet attr)
                  throws javax.swing.text.BadLocationException

Specified by:

insertString in interface javax.swing.text.Document

Overrides:

insertString in class javax.swing.text.PlainDocument

Throws:

javax.swing.text.BadLocationException