public static interface

AbstractDocument.Content

javax.swing.text.AbstractDocument.Content
Known Indirect Subclasses

Class Overview

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

Summary

Public Methods
abstract Position createPosition(int offset)
Creates a position within the content that will track change as the content is mutated.
abstract void getChars(int where, int len, Segment txt)
Gets a sequence of characters and copies them into a Segment.
abstract String getString(int where, int len)
Fetches a string of characters contained in the sequence.
abstract UndoableEdit insertString(int where, String str)
Inserts a string of characters into the sequence.
abstract int length()
Current length of the sequence of character content.
abstract UndoableEdit remove(int where, int nitems)
Removes some portion of the sequence.

Public Methods

public abstract Position createPosition (int offset)

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

public abstract void getChars (int where, int len, Segment txt)

Gets a sequence of characters and copies them into a Segment.

Parameters
where the starting offset >= 0
len the number of characters >= 0
txt the target location to copy into
Throws
BadLocationException Thrown if the area covered by the arguments is not contained in the character sequence.

public abstract String getString (int where, int len)

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.

public abstract UndoableEdit insertString (int where, String str)

Inserts a string of characters into the sequence.

Parameters
where offset into the sequence to make the insertion >= 0
str string to insert
Returns
  • if the implementation supports a history mechanism, a reference to an Edit implementation will be returned, otherwise returns null
Throws
BadLocationException thrown if the area covered by the arguments is not contained in the character sequence

public abstract int length ()

Current length of the sequence of character content.

Returns
  • the length >= 0

public abstract UndoableEdit remove (int where, int nitems)

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 mechansim, 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.