|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface to describe a sequence of character content that can be edited. Implementations may or may not support a history mechanism which will be reflected by whether or not mutations return an UndoableEdit implementation.
AbstractDocument
Method Summary | |
Position |
createPosition(int offset)
Creates a position within the content that will track change as the content is mutated. |
void |
getChars(int where,
int len,
Segment txt)
Gets a sequence of characters and copies them into a Segment. |
String |
getString(int where,
int len)
Fetches a string of characters contained in the sequence. |
UndoableEdit |
insertString(int where,
String str)
Inserts a string of characters into the sequence. |
int |
length()
Current length of the sequence of character content. |
UndoableEdit |
remove(int where,
int nitems)
Removes some portion of the sequence. |
Method Detail |
public Position createPosition(int offset) throws BadLocationException
offset
- the offset in the content >= 0BadLocationException
- for an invalid offsetpublic int length()
public UndoableEdit insertString(int where, String str) throws BadLocationException
where
- Offset into the sequence to make the insertion >= 0.str
- String to insert.BadLocationException
- Thrown if the area covered by
the arguments is not contained in the character sequence.public UndoableEdit remove(int where, int nitems) throws BadLocationException
where
- The offset into the sequence to make the
insertion >= 0.nitems
- The number of items in the sequence to remove >= 0.BadLocationException
- Thrown if the area covered by
the arguments is not contained in the character sequence.public String getString(int where, int len) throws BadLocationException
where
- Offset into the sequence to fetch >= 0.len
- number of characters to copy >= 0.BadLocationException
- Thrown if the area covered by
the arguments is not contained in the character sequence.public void getChars(int where, int len, Segment txt) throws BadLocationException
where
- the starting offset >= 0len
- the number of characters >= 0txt
- the target location to copy intoBadLocationException
- Thrown if the area covered by
the arguments is not contained in the character sequence.
|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.