Overview Package Class Source Tree Index About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing.text

Class StringContent

Implemented Interfaces:
AbstractDocument.Content, Serializable
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. It is also quite inefficient.

It is generally recommended that the gap buffer or piece table implementations be used instead. This buffer does not scale up to large sizes.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

See Also:
Serialized Form

Constructor Summary

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

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 chars)
Retrieves a portion of the content.
protected Vector<E>
getPositionsInRange(Vector<E> v, int offset, int length)
Returns a Vector containing instances of UndoPosRef for the Positions in the range offset to offset + length.
String
getString(int where, int len)
Retrieves a portion of the content.
UndoableEdit
insertString(int where, String str)
Inserts a string into the content.
int
length()
Returns the length of the content.
UndoableEdit
remove(int where, int nitems)
Removes part of the content.
protected void
updateUndoPositions(Vector<E> positions)
Resets the location for all the UndoPosRef instances in positions.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StringContent

public StringContent()
Creates a new StringContent object. Initial size defaults to 10.
Usages and Demos :

View More Examples of StringContent()
   1:         protected Document createDefaultModel() {
   2:             PlainDocument doc = new PlainDocument(new StringContent());
   3:             undoManager = new UndoManager();
   4:             doc.addUndoableEditListener(undoManager);
   5:             return doc;

View Full Code Here

StringContent

public StringContent(int initialLength)
Creates a new StringContent object, with the initial size specified. If the length is <321, a size of 1 is used.
Parameters:
initialLength - the initial size

Method Details

createPosition

public Position createPosition(int offset)
            throws BadLocationException
Creates a position within the content that will track change as the content is mutated.
Specified by:
createPosition in interface AbstractDocument.Content
Parameters:
offset - the offset to create a position for >= 0
Returns:
the position
Throws:
BadLocationException - if the specified position is invalid

getChars

public void getChars(int where,
                     int len,
                     Segment chars)
            throws BadLocationException
Retrieves a portion of the content. where + len must be <= length()
Specified by:
getChars in interface AbstractDocument.Content
Parameters:
where - the starting position >= 0
len - the number of characters to retrieve >= 0
chars - the Segment object to return the characters in
Throws:
BadLocationException - if the specified position is invalid
See Also:
AbstractDocument.Content.getChars(int,int,Segment)

getPositionsInRange

protected Vector<E> getPositionsInRange(Vector<E> v,
                                     int offset,
                                     int length)
Returns a Vector containing instances of UndoPosRef for the Positions in the range offset to offset + length. If v is not null the matching Positions are placed in there. The vector with the resulting Positions are returned.

This is meant for internal usage, and is generally not of interest to subclasses.

Parameters:
v - the Vector to use, with a new one created on null
offset - the starting offset >= 0
length - the length >= 0
Returns:
the set of instances

getString

public String getString(int where,
                        int len)
            throws BadLocationException
Retrieves a portion of the content. where + len must be <= length().
Specified by:
getString in interface AbstractDocument.Content
Parameters:
where - the starting position >= 0
len - the length to retrieve >= 0
Returns:
a string representing the content; may be empty
Throws:
BadLocationException - if the specified position is invalid
See Also:
AbstractDocument.Content.getString(int,int)

insertString

public UndoableEdit insertString(int where,
                                 String str)
            throws BadLocationException
Inserts a string into the content.
Specified by:
insertString in interface AbstractDocument.Content
Parameters:
where - the starting position >= 0 && <32length()
str - the non-null string to insert
Returns:
an UndoableEdit object for undoing
Throws:
BadLocationException - if the specified position is invalid
See Also:
AbstractDocument.Content.insertString(int,String)

length

public int length()
Returns the length of the content.
Specified by:
length in interface AbstractDocument.Content
Returns:
the length >= 1
See Also:
AbstractDocument.Content.length()

remove

public UndoableEdit remove(int where,
                           int nitems)
            throws BadLocationException
Removes part of the content. where + nitems must be <32length().
Specified by:
remove in interface AbstractDocument.Content
Parameters:
where - the starting position >= 0
nitems - the number of characters to remove >= 0
Returns:
an UndoableEdit object for undoing
Throws:
BadLocationException - if the specified position is invalid
See Also:
AbstractDocument.Content.remove(int,int)

updateUndoPositions

protected void updateUndoPositions(Vector<E> positions)
Resets the location for all the UndoPosRef instances in positions.

This is meant for internal usage, and is generally not of interest to subclasses.

Parameters:
positions - the positions of the instances

Overview Package Class Source Tree Index About
Java API(Doc)