AbstractDocument (Java Platform SE 8 ) (original) (raw)

Modifier and Type

Method

Description

void

[addDocumentListener](../../../javax/swing/text/AbstractDocument.html#addDocumentListener-javax.swing.event.DocumentListener-)([DocumentListener](../../../javax/swing/event/DocumentListener.html "interface in javax.swing.event") listener)

Adds a document listener for notification of any changes.

void

[addUndoableEditListener](../../../javax/swing/text/AbstractDocument.html#addUndoableEditListener-javax.swing.event.UndoableEditListener-)([UndoableEditListener](../../../javax/swing/event/UndoableEditListener.html "interface in javax.swing.event") listener)

Adds an undo listener for notification of any changes.

protected [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

[createBranchElement](../../../javax/swing/text/AbstractDocument.html#createBranchElement-javax.swing.text.Element-javax.swing.text.AttributeSet-)([Element](../../../javax/swing/text/Element.html "interface in javax.swing.text") parent,[AttributeSet](../../../javax/swing/text/AttributeSet.html "interface in javax.swing.text") a)

Creates a document branch element, that can contain other elements.

protected [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

[createLeafElement](../../../javax/swing/text/AbstractDocument.html#createLeafElement-javax.swing.text.Element-javax.swing.text.AttributeSet-int-int-)([Element](../../../javax/swing/text/Element.html "interface in javax.swing.text") parent,[AttributeSet](../../../javax/swing/text/AttributeSet.html "interface in javax.swing.text") a, int p0, int p1)

Creates a document leaf element.

[Position](../../../javax/swing/text/Position.html "interface in javax.swing.text")

[createPosition](../../../javax/swing/text/AbstractDocument.html#createPosition-int-)(int offs)

Returns a position that will track change as the document is altered.

void

[dump](../../../javax/swing/text/AbstractDocument.html#dump-java.io.PrintStream-)([PrintStream](../../../java/io/PrintStream.html "class in java.io") out)

Gives a diagnostic dump.

protected void

[fireChangedUpdate](../../../javax/swing/text/AbstractDocument.html#fireChangedUpdate-javax.swing.event.DocumentEvent-)([DocumentEvent](../../../javax/swing/event/DocumentEvent.html "interface in javax.swing.event") e)

Notifies all listeners that have registered interest for notification on this event type.

protected void

[fireInsertUpdate](../../../javax/swing/text/AbstractDocument.html#fireInsertUpdate-javax.swing.event.DocumentEvent-)([DocumentEvent](../../../javax/swing/event/DocumentEvent.html "interface in javax.swing.event") e)

Notifies all listeners that have registered interest for notification on this event type.

protected void

[fireRemoveUpdate](../../../javax/swing/text/AbstractDocument.html#fireRemoveUpdate-javax.swing.event.DocumentEvent-)([DocumentEvent](../../../javax/swing/event/DocumentEvent.html "interface in javax.swing.event") e)

Notifies all listeners that have registered interest for notification on this event type.

protected void

[fireUndoableEditUpdate](../../../javax/swing/text/AbstractDocument.html#fireUndoableEditUpdate-javax.swing.event.UndoableEditEvent-)([UndoableEditEvent](../../../javax/swing/event/UndoableEditEvent.html "class in javax.swing.event") e)

Notifies all listeners that have registered interest for notification on this event type.

int

[getAsynchronousLoadPriority](../../../javax/swing/text/AbstractDocument.html#getAsynchronousLoadPriority--)()

Gets the asynchronous loading priority.

protected [AbstractDocument.AttributeContext](../../../javax/swing/text/AbstractDocument.AttributeContext.html "interface in javax.swing.text")

[getAttributeContext](../../../javax/swing/text/AbstractDocument.html#getAttributeContext--)()

Fetches the context for managing attributes.

[Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

[getBidiRootElement](../../../javax/swing/text/AbstractDocument.html#getBidiRootElement--)()

Returns the root element of the bidirectional structure for this document.

protected [AbstractDocument.Content](../../../javax/swing/text/AbstractDocument.Content.html "interface in javax.swing.text")

[getContent](../../../javax/swing/text/AbstractDocument.html#getContent--)()

Gets the content for the document.

protected [Thread](../../../java/lang/Thread.html "class in java.lang")

[getCurrentWriter](../../../javax/swing/text/AbstractDocument.html#getCurrentWriter--)()

Fetches the current writing thread if there is one.

abstract [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

[getDefaultRootElement](../../../javax/swing/text/AbstractDocument.html#getDefaultRootElement--)()

Returns the root element that views should be based upon unless some other mechanism for assigning views to element structures is provided.

[DocumentFilter](../../../javax/swing/text/DocumentFilter.html "class in javax.swing.text")

[getDocumentFilter](../../../javax/swing/text/AbstractDocument.html#getDocumentFilter--)()

Returns the DocumentFilter that is responsible for filtering of insertion/removal.

[DocumentListener](../../../javax/swing/event/DocumentListener.html "interface in javax.swing.event")[]

[getDocumentListeners](../../../javax/swing/text/AbstractDocument.html#getDocumentListeners--)()

Returns an array of all the document listeners registered on this document.

[Dictionary](../../../java/util/Dictionary.html "class in java.util")<[Object](../../../java/lang/Object.html "class in java.lang"),[Object](../../../java/lang/Object.html "class in java.lang")>

[getDocumentProperties](../../../javax/swing/text/AbstractDocument.html#getDocumentProperties--)()

Supports managing a set of properties.

[Position](../../../javax/swing/text/Position.html "interface in javax.swing.text")

[getEndPosition](../../../javax/swing/text/AbstractDocument.html#getEndPosition--)()

Returns a position that represents the end of the document.

int

[getLength](../../../javax/swing/text/AbstractDocument.html#getLength--)()

Returns the length of the data.

<T extends [EventListener](../../../java/util/EventListener.html "interface in java.util")> T[]

[getListeners](../../../javax/swing/text/AbstractDocument.html#getListeners-java.lang.Class-)([Class](../../../java/lang/Class.html "class in java.lang")<T> listenerType)

Returns an array of all the objects currently registered as _Foo_Listeners upon this document.

abstract [Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")

[getParagraphElement](../../../javax/swing/text/AbstractDocument.html#getParagraphElement-int-)(int pos)

Get the paragraph element containing the given position.

[Object](../../../java/lang/Object.html "class in java.lang")

[getProperty](../../../javax/swing/text/AbstractDocument.html#getProperty-java.lang.Object-)([Object](../../../java/lang/Object.html "class in java.lang") key)

A convenience method for looking up a property value.

[Element](../../../javax/swing/text/Element.html "interface in javax.swing.text")[]

[getRootElements](../../../javax/swing/text/AbstractDocument.html#getRootElements--)()

Gets all root elements defined.

[Position](../../../javax/swing/text/Position.html "interface in javax.swing.text")

[getStartPosition](../../../javax/swing/text/AbstractDocument.html#getStartPosition--)()

Returns a position that represents the start of the document.

[String](../../../java/lang/String.html "class in java.lang")

[getText](../../../javax/swing/text/AbstractDocument.html#getText-int-int-)(int offset, int length)

Gets a sequence of text from the document.

void

[getText](../../../javax/swing/text/AbstractDocument.html#getText-int-int-javax.swing.text.Segment-)(int offset, int length,[Segment](../../../javax/swing/text/Segment.html "class in javax.swing.text") txt)

Fetches the text contained within the given portion of the document.

[UndoableEditListener](../../../javax/swing/event/UndoableEditListener.html "interface in javax.swing.event")[]

[getUndoableEditListeners](../../../javax/swing/text/AbstractDocument.html#getUndoableEditListeners--)()

Returns an array of all the undoable edit listeners registered on this document.

void

[insertString](../../../javax/swing/text/AbstractDocument.html#insertString-int-java.lang.String-javax.swing.text.AttributeSet-)(int offs,[String](../../../java/lang/String.html "class in java.lang") str,[AttributeSet](../../../javax/swing/text/AttributeSet.html "interface in javax.swing.text") a)

Inserts some content into the document.

protected void

[insertUpdate](../../../javax/swing/text/AbstractDocument.html#insertUpdate-javax.swing.text.AbstractDocument.DefaultDocumentEvent-javax.swing.text.AttributeSet-)([AbstractDocument.DefaultDocumentEvent](../../../javax/swing/text/AbstractDocument.DefaultDocumentEvent.html "class in javax.swing.text") chng,[AttributeSet](../../../javax/swing/text/AttributeSet.html "interface in javax.swing.text") attr)

Updates document structure as a result of text insertion.

protected void

[postRemoveUpdate](../../../javax/swing/text/AbstractDocument.html#postRemoveUpdate-javax.swing.text.AbstractDocument.DefaultDocumentEvent-)([AbstractDocument.DefaultDocumentEvent](../../../javax/swing/text/AbstractDocument.DefaultDocumentEvent.html "class in javax.swing.text") chng)

Updates any document structure as a result of text removal.

void

[putProperty](../../../javax/swing/text/AbstractDocument.html#putProperty-java.lang.Object-java.lang.Object-)([Object](../../../java/lang/Object.html "class in java.lang") key,[Object](../../../java/lang/Object.html "class in java.lang") value)

A convenience method for storing up a property value.

void

[readLock](../../../javax/swing/text/AbstractDocument.html#readLock--)()

Acquires a lock to begin reading some state from the document.

void

[readUnlock](../../../javax/swing/text/AbstractDocument.html#readUnlock--)()

Does a read unlock.

void

[remove](../../../javax/swing/text/AbstractDocument.html#remove-int-int-)(int offs, int len)

Removes some content from the document.

void

[removeDocumentListener](../../../javax/swing/text/AbstractDocument.html#removeDocumentListener-javax.swing.event.DocumentListener-)([DocumentListener](../../../javax/swing/event/DocumentListener.html "interface in javax.swing.event") listener)

Removes a document listener.

void

[removeUndoableEditListener](../../../javax/swing/text/AbstractDocument.html#removeUndoableEditListener-javax.swing.event.UndoableEditListener-)([UndoableEditListener](../../../javax/swing/event/UndoableEditListener.html "interface in javax.swing.event") listener)

Removes an undo listener.

protected void

[removeUpdate](../../../javax/swing/text/AbstractDocument.html#removeUpdate-javax.swing.text.AbstractDocument.DefaultDocumentEvent-)([AbstractDocument.DefaultDocumentEvent](../../../javax/swing/text/AbstractDocument.DefaultDocumentEvent.html "class in javax.swing.text") chng)

Updates any document structure as a result of text removal.

void

[render](../../../javax/swing/text/AbstractDocument.html#render-java.lang.Runnable-)([Runnable](../../../java/lang/Runnable.html "interface in java.lang") r)

This allows the model to be safely rendered in the presence of currency, if the model supports being updated asynchronously.

void

[replace](../../../javax/swing/text/AbstractDocument.html#replace-int-int-java.lang.String-javax.swing.text.AttributeSet-)(int offset, int length,[String](../../../java/lang/String.html "class in java.lang") text,[AttributeSet](../../../javax/swing/text/AttributeSet.html "interface in javax.swing.text") attrs)

Deletes the region of text from offset tooffset + length, and replaces it with text.

void

[setAsynchronousLoadPriority](../../../javax/swing/text/AbstractDocument.html#setAsynchronousLoadPriority-int-)(int p)

Sets the asynchronous loading priority.

void

[setDocumentFilter](../../../javax/swing/text/AbstractDocument.html#setDocumentFilter-javax.swing.text.DocumentFilter-)([DocumentFilter](../../../javax/swing/text/DocumentFilter.html "class in javax.swing.text") filter)

Sets the DocumentFilter.

void

[setDocumentProperties](../../../javax/swing/text/AbstractDocument.html#setDocumentProperties-java.util.Dictionary-)([Dictionary](../../../java/util/Dictionary.html "class in java.util")<[Object](../../../java/lang/Object.html "class in java.lang"),[Object](../../../java/lang/Object.html "class in java.lang")> x)

Replaces the document properties dictionary for this document.

protected void

[writeLock](../../../javax/swing/text/AbstractDocument.html#writeLock--)()

Acquires a lock to begin mutating the document this lock protects.

protected void

[writeUnlock](../../../javax/swing/text/AbstractDocument.html#writeUnlock--)()

Releases a write lock previously obtained via writeLock.