javax.swing.text
Class PlainDocument

java.lang.Object
  extended by javax.swing.text.AbstractDocument
      extended by javax.swing.text.PlainDocument
All Implemented Interfaces:
Serializable, Document

public class PlainDocument
extends AbstractDocument

A simple document class which maps lines to Elements.

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
static String lineLimitAttribute
           
static String 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
PlainDocument()
           
PlainDocument(AbstractDocument.Content content)
           
 
Method Summary
protected  AbstractDocument.AbstractElement createDefaultRoot()
           
 Element getDefaultRootElement()
          Returns the default root Element of this Document.
 Element getParagraphElement(int pos)
          Returns the paragraph Element that holds the specified position.
 void insertString(int offs, String str, AttributeSet atts)
          Inserts a string into the document.
protected  void insertUpdate(AbstractDocument.DefaultDocumentEvent event, AttributeSet attributes)
          Called to indicate that text has been inserted into this Document.
protected  void removeUpdate(AbstractDocument.DefaultDocumentEvent event)
          Called before some content gets removed from this Document.
 
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
 

Field Detail

lineLimitAttribute

public static final String lineLimitAttribute
See Also:
Constant Field Values

tabSizeAttribute

public static final String tabSizeAttribute
See Also:
Constant Field Values
Constructor Detail

PlainDocument

public PlainDocument()

PlainDocument

public PlainDocument(AbstractDocument.Content content)
Method Detail

createDefaultRoot

protected AbstractDocument.AbstractElement createDefaultRoot()

insertUpdate

protected void insertUpdate(AbstractDocument.DefaultDocumentEvent event,
                            AttributeSet attributes)
Description copied from class: AbstractDocument
Called to indicate that text has been inserted into this Document. The default implementation does nothing. This method is executed within a write lock.

Overrides:
insertUpdate in class AbstractDocument
Parameters:
event - the DefaultDocumentEvent describing the change
attributes - the attributes of the changed content

removeUpdate

protected void removeUpdate(AbstractDocument.DefaultDocumentEvent event)
Description copied from class: AbstractDocument
Called before some content gets removed from this Document. The default implementation does nothing but may be overridden by subclasses to modify the Document structure in response to a remove request. The method is executed within a write lock.

Overrides:
removeUpdate in class AbstractDocument
Parameters:
event - the DefaultDocumentEvent describing the change

getDefaultRootElement

public Element getDefaultRootElement()
Description copied from class: AbstractDocument
Returns the default root Element of this Document. Usual Documents only have one root element and return this. However, there may be Document implementations that support multiple root elements, they have to return a default root element here.

Specified by:
getDefaultRootElement in interface Document
Specified by:
getDefaultRootElement in class AbstractDocument
Returns:
the default root Element of this Document

getParagraphElement

public Element getParagraphElement(int pos)
Description copied from class: AbstractDocument
Returns the paragraph Element that holds the specified position.

Specified by:
getParagraphElement in class AbstractDocument
Parameters:
pos - the position for which to get the paragraph element
Returns:
the paragraph Element that holds the specified position

insertString

public void insertString(int offs,
                         String str,
                         AttributeSet atts)
                  throws BadLocationException
Inserts a string into the document. If the document property 'filterNewLines' is set to Boolean.TRUE, then all newlines in the inserted string are replaced by space characters, otherwise the superclasses behaviour is executed. Inserting content causes a write lock to be acquired during this method call.

Specified by:
insertString in interface Document
Overrides:
insertString in class AbstractDocument
Parameters:
offs - the offset at which to insert the string
str - the string to be inserted
atts - the text attributes of the string to be inserted
Throws:
BadLocationException