gov.nih.nlm.swing
Class IdealWhitespaceDocument

java.lang.Object
  javax.swing.text.AbstractDocument
      javax.swing.text.PlainDocument
          gov.nih.nlm.swing.IdealWhitespaceDocument

All Implemented Interfaces:

Serializable, Document

public class IdealWhitespaceDocument
extends PlainDocument

PlainDocument implementation that prevents leading, training, duplicate, and redundant whitespace.

Author:

Brian Carlsen (bcarlsen@apelon.com)

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

IdealWhitespaceDocument()
Instantiates an empty IdealWhitespaceDocument.

Method Summary

void	insertString(int offset, String str, AttributeSet a) Overrides PlainDocument.insertString(int,String,AttributeSet) to disallow: leading whitespace trailing whitespace any non-space character whitespace duplicate spaces
void	setText(String text, AttributeSet a) Sets the text of the document.

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

IdealWhitespaceDocument

public IdealWhitespaceDocument()

Instantiates an empty IdealWhitespaceDocument.

Method Detail

setText

public void setText(String text,
                    AttributeSet a)
             throws BadLocationException

Sets the text of the document.

Parameters:

text - the text

a - the AttributeSet

Throws:

BadLocationException - if anything goes wrong

insertString

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

Overrides PlainDocument.insertString(int,String,AttributeSet) to disallow:

1. leading whitespace
2. trailing whitespace
3. any non-space character whitespace
4. duplicate spaces

Specified by:

insertString in interface Document

Overrides:

insertString in class PlainDocument

Parameters:

offset - the offset

str - the string to insert

a - the AttributeSet

Throws:

BadLocationException - if anything goes wrong