com.jaxfront.swing.helpers
Class StringDocument

java.lang.Object
  extended by javax.swing.text.AbstractDocument
      extended by javax.swing.text.PlainDocument
          extended by com.jaxfront.swing.helpers.StringDocument
All Implemented Interfaces:
JAXFrontDocument, java.io.Serializable, javax.swing.text.Document

public class StringDocument
extends javax.swing.text.PlainDocument
implements JAXFrontDocument

The class StringDocumentation is an implementation of the PlainDocument. It is responsible for limiting the input capacity of a JTextComponent.

Version:
1.60
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
BidiElementName, ContentElementName, ElementNameAttribute, ParagraphElementName, SectionElementName
 
Fields inherited from interface javax.swing.text.Document
StreamDescriptionProperty, TitleProperty
 
Constructor Summary
StringDocument(boolean useErrorSound, long maxLengthOfCharacter)
          StringDocument constructor.
 
Method Summary
 void insertString(int offset, java.lang.String string, javax.swing.text.AttributeSet attributeSet)
           
 boolean isBypassing()
           
 void setBypassing(boolean bypass)
           
 
Methods inherited from class javax.swing.text.PlainDocument
getDefaultRootElement, getParagraphElement
 
Methods inherited from class javax.swing.text.AbstractDocument
addDocumentListener, addUndoableEditListener, createPosition, dump, getAsynchronousLoadPriority, getBidiRootElement, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, putProperty, readLock, readUnlock, remove, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringDocument

public StringDocument(boolean useErrorSound,
                      long maxLengthOfCharacter)
StringDocument constructor.

Parameters:
useErrorSound - true, if the system should give out an error sound (beep)
maxLengthOfCharacter - the maximum allowed length of the input character
Method Detail

insertString

public void insertString(int offset,
                         java.lang.String string,
                         javax.swing.text.AttributeSet attributeSet)
                  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
See Also:
Document.insertString(int, java.lang.String, javax.swing.text.AttributeSet)

isBypassing

public boolean isBypassing()
Specified by:
isBypassing in interface JAXFrontDocument

setBypassing

public void setBypassing(boolean bypass)
Specified by:
setBypassing in interface JAXFrontDocument