Interface Document

public static final String StreamDescriptionProperty

The key for the property that describes the source of a document.

Field Value:

"stream"

public static final String TitleProperty

The key for the property that is the title of a document.

Field Value:

"title"

public void addDocumentListener(DocumentListener listener)

Adds a DocumentListener to this document.

Parameters:

listener - the DocumentListener to add

public void addUndoableEditListener(UndoableEditListener listener)

Adds an UndoableEditListener to this document.

Parameters:

listener - the UndoableEditListener to add

public Position createPosition(int offs)
            throws BadLocationException

Creates a mark in the character content at the specified offset.

Parameters:

offs - the offset where to place the mark

Returns:

the created Position object

Throws:

BadLocationException - of the specified offset is not a valid position in the documents content

public Element getDefaultRootElement()

Returns the default root element. Views should be using this element unless other mechanisms for assigning views to element structure is provided.

Returns:

the default root element

public Position getEndPosition()

Returns the position that marks the end of the document.

Returns:

the position that marks the end of the document

public int getLength()

Returns the length of the document content.

Returns:

the length of the document content

public Object getProperty(Object key)

Returns a document property with the specified key.

Parameters:

key - the (non-null) key for the property to fetch

Returns:

the property for key or null if no such property is stored

public Element[] getRootElements()

Returns the root elements of the document content.

Returns:

the root elements of the document content

public Position getStartPosition()

Returns the position that marks the beginning of the document content.

Returns:

the start position

public String getText(int offset,
                      int length)
            throws BadLocationException

Returns the textual content starting at offset with a length of length.

Parameters:

offset - the beginning of the text fragment to fetch

length - the length of the text fragment to fetch

Returns:

the text fragment starting at offset with a length of length

Throws:

BadLocationException - if offset or length are no valid locations in the document content

public void getText(int offset,
                    int length,
                    Segment txt)
            throws BadLocationException

Fetch the textual content starting at offset with a length of length and store it in txt.

Parameters:

offset - the beginning of the text fragment to fetch

length - the length of the text fragment to fetch

txt - the Segment where to store the text fragment

Throws:

BadLocationException - if offset or length are no valid locations in the document content

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

Inserts a piece of text with an AttributeSet at the specified offset.

Parameters:

offset - the location where to insert the content

str - the textual content to insert

a - the Attributes associated with the piece of text

Throws:

BadLocationException - if offset is not a valid location in the document content

public void putProperty(Object key,
                        Object value)

Sets a document property.

Parameters:

key - the key of the property

value - the value of the property

public void remove(int offs,
                   int len)
            throws BadLocationException

Removes a piece of content.

Parameters:

offs - the location of the fragment to remove

len - the length of the fragment to remove

Throws:

BadLocationException - if offs or len are no valid locations in the document content

public void removeDocumentListener(DocumentListener listener)

Removes a DocumentListener from this Document.

Parameters:

listener - the DocumentListener to remove

public void removeUndoableEditListener(UndoableEditListener listener)

Removes an UndoableEditListener from this Document.

Parameters:

listener - the UndoableEditListener to remove

public void render(Runnable r)

This allows the Document to be rendered safely. It is made sure that the Runnable can read the document without any changes while reading. The Runnable is not allowed to change the Document itself.

Parameters:

r - the Runnable that renders the Document