javax.swing.text
Interface Document

All Known Subinterfaces:

StyledDocument

All Known Implementing Classes:

AbstractDocument, DefaultStyledDocument

public interface Document

Unsafe:

Field Summary

static String	StreamDescriptionProperty Suppressed: The property name for the description of the stream used to initialize the document.
static String	TitleProperty Suppressed: The property name for the title of the document, if there is one.

Method Summary

void	addDocumentListener(DocumentListener listener) Enabled: Registers the given observer to begin receiving notifications when changes are made to the document.
void	addUndoableEditListener(UndoableEditListener listener) Enabled: Registers the given observer to begin receiving notifications when undoable edits are made to the document.
Position	createPosition(int offs) Enabled: This method allows an application to mark a place in a sequence of character content.
Element	getDefaultRootElement() Enabled: Returns the root element that views should be based upon, unless some other mechanism for assigning views to element structures is provided.
Position	getEndPosition() Enabled: Returns a position that represents the end of the document.
int	getLength() Enabled: Returns number of characters of content currently in the document.
Object	getProperty(Object key) Suppressed: Gets the properties associated with the document.
Element[]	getRootElements() Enabled: Returns all of the root elements that are defined.
Position	getStartPosition() Enabled: Returns a position that represents the start of the document.
String	getText(int offset, int length) Enabled: Fetches the text contained within the given portion of the document.
void	getText(int offset, int length, Segment txt) Enabled: Fetches the text contained within the given portion of the document.
void	insertString(int offset, String str, AttributeSet a) Enabled: Inserts a string of content.
void	putProperty(Object key, Object value) Suppressed: Associates a property with the document.
void	remove(int offs, int len) Enabled: Removes a portion of the content of the document.
void	removeDocumentListener(DocumentListener listener) Enabled: Unregisters the given observer from the notification list so it will no longer receive change updates.
void	removeUndoableEditListener(UndoableEditListener listener) Enabled: Unregisters the given observer from the notification list so it will no longer receive updates.
void	render(Runnable r) Suppressed: This allows the model to be safely rendered in the presence of currency, if the model supports being updated asynchronously.

Field Detail

StreamDescriptionProperty

public static final String StreamDescriptionProperty

Suppressed: The property name for the description of the stream used to initialize the document. This should be used if the document was initialized from a stream and anything is known about the stream.

TitleProperty

public static final String TitleProperty

Suppressed: The property name for the title of the document, if there is one.

Method Detail

getLength

public int getLength()

Enabled: Returns number of characters of content currently in the document.

Returns:

number of characters >= 0

addDocumentListener

public void addDocumentListener(DocumentListener listener)

Enabled: Registers the given observer to begin receiving notifications when changes are made to the document.

Parameters:

listener - the observer to register

See Also:

removeDocumentListener(javax.swing.event.DocumentListener)

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Enabled: Unregisters the given observer from the notification list so it will no longer receive change updates.

Parameters:

listener - the observer to register

See Also:

addDocumentListener(javax.swing.event.DocumentListener)

addUndoableEditListener

public void addUndoableEditListener(UndoableEditListener listener)

Enabled: Registers the given observer to begin receiving notifications when undoable edits are made to the document.

Parameters:

listener - the observer to register

See Also:

javax.swing.event.UndoableEditEvent

removeUndoableEditListener

public void removeUndoableEditListener(UndoableEditListener listener)

Enabled: Unregisters the given observer from the notification list so it will no longer receive updates.

Parameters:

listener - the observer to register

See Also:

javax.swing.event.UndoableEditEvent

getProperty

public Object getProperty(Object key)

Suppressed: Gets the properties associated with the document.

Parameters:

key - a non-null property key

Returns:

the properties

See Also:

putProperty(Object, Object)

putProperty

public void putProperty(Object key,
                        Object value)

Suppressed: Associates a property with the document. Two standard property keys provided are: StreamDescriptionProperty and TitleProperty. Other properties, such as author, may also be defined.

Parameters:

key - the non-null property key

value - the property value

See Also:

getProperty(Object)

remove

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

Enabled: Removes a portion of the content of the document. This will cause a DocumentEvent of type DocumentEvent.EventType.REMOVE to be sent to the registered DocumentListeners, unless an exception is thrown. The notification will be sent to the listeners by calling the removeUpdate method on the DocumentListeners.

To ensure reasonable behavior in the face of concurrency, the event is dispatched after the mutation has occurred. This means that by the time a notification of removal is dispatched, the document has already been updated and any marks created by createPosition have already changed. For a removal, the end of the removal range is collapsed down to the start of the range, and any marks in the removal range are collapsed down to the start of the range.

If the Document structure changed as result of the removal, the details of what Elements were inserted and removed in response to the change will also be contained in the generated DocumentEvent. It is up to the implementation of a Document to decide how the structure should change in response to a remove.

If the Document supports undo/redo, an UndoableEditEvent will also be generated.

Parameters:

offs - the offset from the beginning >= 0

len - the number of characters to remove >= 0

BadLocationException

See Also:

javax.swing.event.DocumentEvent, javax.swing.event.DocumentListener, javax.swing.event.UndoableEditEvent, javax.swing.event.UndoableEditListener

insertString

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

Enabled: Inserts a string of content. This will cause a DocumentEvent of type DocumentEvent.EventType.INSERT to be sent to the registered DocumentListers, unless an exception is thrown. The DocumentEvent will be delivered by calling the insertUpdate method on the DocumentListener. The offset and length of the generated DocumentEvent will indicate what change was actually made to the Document.

If the Document structure changed as result of the insertion, the details of what Elements were inserted and removed in response to the change will also be contained in the generated DocumentEvent. It is up to the implementation of a Document to decide how the structure should change in response to an insertion.

If the Document supports undo/redo, an UndoableEditEvent will also be generated.

Parameters:

offset - the offset into the document to insert the content >= 0. All positions that track change at or after the given location will move.

str - the string to insert

a - the attributes to associate with the inserted content. This may be null if there are no attributes.

BadLocationException

See Also:

javax.swing.event.DocumentEvent, javax.swing.event.DocumentListener, javax.swing.event.UndoableEditEvent, javax.swing.event.UndoableEditListener

getText

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

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

Parameters:

offset - the offset into the document representing the desired start of the text >= 0

length - the length of the desired string >= 0

Returns:

the text, in a String of length >= 0

BadLocationException

getText

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

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

If the partialReturn property on the txt parameter is false, the data returned in the Segment will be the entire length requested and may or may not be a copy depending upon how the data was stored. If the partialReturn property is true, only the amount of text that can be returned without creating a copy is returned. Using partial returns will give better performance for situations where large parts of the document are being scanned. The following is an example of using the partial return to access the entire document:

   int nleft = doc.getDocumentLength();
   Segment text = new Segment();
   int offs = 0;
   text.setPartialReturn(true);   
   while (nleft > 0) {
       doc.getText(offs, nleft, text);
       // do someting with text
       nleft -= text.count;
       offs += text.count;
   }

 

Parameters:

offset - the offset into the document representing the desired start of the text >= 0

length - the length of the desired string >= 0

txt - the Segment object to return the text in

BadLocationException

getStartPosition

public Position getStartPosition()

Enabled: Returns a position that represents the start of the document. The position returned can be counted on to track change and stay located at the beginning of the document.

Returns:

the position

getEndPosition

public Position getEndPosition()

Enabled: Returns a position that represents the end of the document. The position returned can be counted on to track change and stay located at the end of the document.

Returns:

the position

createPosition

public Position createPosition(int offs)
                        throws BadLocationException

Enabled: This method allows an application to mark a place in a sequence of character content. This mark can then be used to tracks change as insertions and removals are made in the content. The policy is that insertions always occur prior to the current position (the most common case) unless the insertion location is zero, in which case the insertion is forced to a position that follows the original position.

Parameters:

offs - the offset from the start of the document >= 0

Returns:

the position

BadLocationException

getRootElements

public Element[] getRootElements()

Enabled: Returns all of the root elements that are defined.

Typically there will be only one document structure, but the interface supports building an arbitrary number of structural projections over the text data. The document can have multiple root elements to support multiple document structures. Some examples might be:

• Text direction.
• Lexical token streams.
• Parse trees.
• Conversions to formats other than the native format.
• Modification specifications.
• Annotations.

Returns:

the root element

getDefaultRootElement

public Element getDefaultRootElement()

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

Returns:

the root element

render

public void render(Runnable r)

Suppressed: This allows the model to be safely rendered in the presence of currency, if the model supports being updated asynchronously. The given runnable will be executed in a way that allows it to safely read the model with no changes while the runnable is being executed. The runnable itself may not make any mutations.

Parameters:

r - a Runnable used to render the model