Java javax.swing.text Class PlainDocument（JDK8）

Field Detail

• tabSizeAttribute

  public static final String tabSizeAttribute

  Name of the attribute that specifies the tab size for tabs contained in the content. The type for the value is Integer.

  See Also:

  Constant Field Values

• lineLimitAttribute

  public static final String lineLimitAttribute

  Name of the attribute that specifies the maximum length of a line, if there is a maximum length. The type for the value is Integer.

  See Also:

  Constant Field Values

Constructor Detail

• PlainDocument

  public PlainDocument()

  Constructs a plain text document. A default model using GapContent is constructed and set.

• PlainDocument

  public PlainDocument(AbstractDocument.Content c)

  Constructs a plain text document. A default root element is created, and the tab size set to 8.

  Parameters:

  c - the container for the content

Method Detail

• insertString

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

  Inserts some content into the document. Inserting content causes a write lock to be held while the actual changes are taking place, followed by notification to the observers on the thread that grabbed the write lock.

  This method is thread safe, although most Swing methods are not. Please see Concurrency in Swing for more information.

  Specified by:

  insertString in interface Document

  Overrides:

  insertString in class AbstractDocument

  Parameters:

  offs - the starting offset >= 0

  str - the string to insert; does nothing with null/empty strings

  a - the attributes for the inserted content

  Throws:

  BadLocationException - the given insert position is not a valid position within the document

  See Also:

  Document.insertString(int, java.lang.String, javax.swing.text.AttributeSet)

• getDefaultRootElement

  public Element getDefaultRootElement()

  Gets the default root element for the document model.

  Specified by:

  getDefaultRootElement in interface Document

  Specified by:

  getDefaultRootElement in class AbstractDocument

  Returns:

  the root

  See Also:

  Document.getDefaultRootElement()

• createDefaultRoot

  protected AbstractDocument.AbstractElement createDefaultRoot()

  Creates the root element to be used to represent the default document structure.

  Returns:

  the element base

• getParagraphElement

  public Element getParagraphElement(int pos)

  Get the paragraph element containing the given position. Since this document only models lines, it returns the line instead.

  Specified by:

  getParagraphElement in class AbstractDocument

  Parameters:

  pos - the starting offset >= 0

  Returns:

  the element

• insertUpdate

  protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
                              AttributeSet attr)

  Updates document structure as a result of text insertion. This will happen within a write lock. Since this document simply maps out lines, we refresh the line map.

  Overrides:

  insertUpdate in class AbstractDocument

  Parameters:

  chng - the change event describing the dit

  attr - the set of attributes for the inserted text

• removeUpdate

  protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)

  Updates any document structure as a result of text removal. This will happen within a write lock. Since the structure represents a line map, this just checks to see if the removal spans lines. If it does, the two lines outside of the removal area are joined together.

  Overrides:

  removeUpdate in class AbstractDocument

  Parameters:

  chng - the change event describing the edit