All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.swing.text.StringContent 

java.lang.Object
    |
    +----java.awt.swing.text.StringContent
public final class StringContent
extends Object
implements AbstractDocument.Content, Serializable
An implementation of the AbstractDocument.Content interface that is a brute force implementation that is useful for relatively small documents and/or debugging. It manages the character content as a simple character array, and does not maintain any history for undo/redo operations. It is also quite inefficient. It is generally recommended that the gap buffer or piece table implementations be used instead.

Constructor Index

o StringContent()
Creates a new StringContent object.
o StringContent(int)
Creates a new StringContent object, with the initial size specified.

Method Index

o createPosition(int)
Creates a position within the content that will track change as the content is mutated.
o getChars(int, int, Segment)
Retrieves a portion of the content.
o getString(int, int)
Retrieves a portion of the content.
o insertString(int, String)
Inserts a string into the content.
o length()
Returns the length of the content.
o remove(int, int)
Removes part of the content.

Constructors

o StringContent 
public StringContent()
Creates a new StringContent object. Initial size defaults to 10.

o StringContent 
public StringContent(int initialLength)
Creates a new StringContent object, with the initial size specified.

Parameters:
initialLength - the initial size

Methods

o length 
public int length()
Returns the length of the content.

Returns:
the length
See Also:
length
o insertString 
public UndoableEdit insertString(int where,
                                 String str) throws BadLocationException
Inserts a string into the content.

Parameters:
where - the starting position
str - the string to insert
Returns:
an UndoableEdit object for undoing
Throws: BadLocationException
if the specified position is invalid
See Also:
insertString
o remove 
public UndoableEdit remove(int where,
                           int nitems) throws BadLocationException
Removes part of the content.

Parameters:
where - the starting position
nitems - the number of characters to remove
Returns:
an UndoableEdit object for undoing
Throws: BadLocationException
if the specified position is invalid
See Also:
remove
o getString 
public String getString(int where,
                        int len) throws BadLocationException
Retrieves a portion of the content.

Parameters:
where - the starting position
len - the length to retrieve
Returns:
a string representing the content
Throws: BadLocationException
if the specified position is invalid
See Also:
getString
o getChars 
public void getChars(int where,
                     int len,
                     Segment chars) throws BadLocationException
Retrieves a portion of the content.

Parameters:
where - the starting position
len - the number of characters to retrieve
chars - the Segment object to return the characters in
Throws: BadLocationException
if the specified position is invalid
See Also:
getChars
o createPosition 
public Position createPosition(int offset) throws BadLocationException
Creates a position within the content that will track change as the content is mutated.

Parameters:
offset - the offset
Returns:
the position
Throws: BadLocationException
if the specified position is invalid
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature