- All Known Implementing Classes:
GapContent,StringContent
- Enclosing class:
- AbstractDocument
public static interface AbstractDocument.Content
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.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptioncreatePosition(int offset) Creates a position within the content that will track change as the content is mutated.voidGets a sequence of characters and copies them into a Segment.getString(int where, int len) Fetches a string of characters contained in the sequence.insertString(int where, String str) Inserts a string of characters into the sequence.intlength()Current length of the sequence of character content.remove(int where, int nitems) Removes some portion of the sequence.
-
Method Details
-
createPosition
Creates a position within the content that will track change as the content is mutated.- Parameters:
offset- the offset in the content >= 0- Returns:
- a Position
- Throws:
BadLocationException- for an invalid offset
-
length
int length()Current length of the sequence of character content.- Returns:
- the length >= 0
-
insertString
Inserts a string of characters into the sequence.- Parameters:
where- offset into the sequence to make the insertion >= 0str- string to insert- Returns:
- if the implementation supports a history mechanism,
a reference to an
Editimplementation will be returned, otherwise returnsnull - Throws:
BadLocationException- thrown if the area covered by the arguments is not contained in the character sequence
-
remove
Removes some portion of the sequence.- Parameters:
where- The offset into the sequence to make the insertion >= 0.nitems- The number of items in the sequence to remove >= 0.- Returns:
- If the implementation supports a history mechanism, a reference to an Edit implementation will be returned, otherwise null.
- Throws:
BadLocationException- Thrown if the area covered by the arguments is not contained in the character sequence.
-
getString
Fetches a string of characters contained in the sequence.- Parameters:
where- Offset into the sequence to fetch >= 0.len- number of characters to copy >= 0.- Returns:
- the string
- Throws:
BadLocationException- Thrown if the area covered by the arguments is not contained in the character sequence.
-
getChars
Gets a sequence of characters and copies them into a Segment.- Parameters:
where- the starting offset >= 0len- the number of characters >= 0txt- the target location to copy into- Throws:
BadLocationException- Thrown if the area covered by the arguments is not contained in the character sequence.
-