java.lang.Objectjavax.swing.text.AbstractDocument
javax.swing.text.PlainDocument
public class PlainDocument
A plain document that maintains no character attributes. The default element structure for this document is a map of the lines in the text. The Element returned by getDefaultRootElement is a map of the lines, and each child element represents a line. This model does not maintain any character level attributes, but each line can be tagged with an arbitrary set of attributes. Line to offset, and offset to line translations can be quickly performed using the default root element. The structure information of the DocumentEvent's fired by edits will indicate the line structure changes.
The default content storage management is performed by a gapped buffer implementation (GapContent). It supports editing reasonably large documents with good efficiency when the edits are contiguous or clustered, as is typical.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans TM has been added to the java.beans package. Please see XMLEncoder .
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
Name of the attribute that specifies the maximum length of a line, if there is a maximum length. |
static String |
tabSizeAttribute
Name of the attribute that specifies the tab size for tabs contained in the content. |
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
() Constructs a plain text document. |
|
PlainDocument
(
AbstractDocument.Content
c) Constructs a plain text document. |
Method Summary | |
---|---|
protected AbstractDocument.AbstractElement |
createDefaultRoot
() Creates the root element to be used to represent the default document structure. |
Element |
getDefaultRootElement
() Gets the default root element for the document model. |
Element |
getParagraphElement
(int pos) Get the paragraph element containing the given position. |
void |
insertString
(int offs,
String
str,
AttributeSet
a) Inserts some content into the document. |
protected void |
insertUpdate
(
AbstractDocument.DefaultDocumentEvent
chng,
AttributeSet
attr) Updates document structure as a result of text insertion. |
protected void |
removeUpdate
(
AbstractDocument.DefaultDocumentEvent
chng) Updates any document structure as a result of text removal. |
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 |
---|
public static final String tabSizeAttribute
public static final String lineLimitAttribute
Constructor Detail |
---|
public PlainDocument()
public PlainDocument(AbstractDocument.Content c)
Method Detail |
---|
public void insertString(int offs, String str, AttributeSet a) throws BadLocationException
This method is thread safe, although most Swing methods are not. Please see
How to Use Threads
Threads and Swing
for more information.
public Element getDefaultRootElement()
protected AbstractDocument.AbstractElement createDefaultRoot()
public Element getParagraphElement(int pos)
protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr)
protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)