javax.swing.text
Class StringContent

java.lang.Object
  |
  +--javax.swing.text.StringContent

All Implemented Interfaces:

javax.swing.text.AbstractDocument.Content, Serializable

public final class StringContent

extends Object

implements javax.swing.text.AbstractDocument.Content, Serializable

Safe: 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 JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder.

Version:

1.42 12/03/01

Author:

Timothy Prinzing

See Also:

Serialized Form

Field Summary

private int	count
private char[]	data
private static char[]	empty
(package private) Vector	marks

Constructor Summary

StringContent()
Enabled: Creates a new StringContent object.

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

Method Summary

Position	createPosition(int offset) Enabled: Creates a position within the content that will track change as the content is mutated.
void	getChars(int where, int len, Segment chars) Suppressed: Retrieves a portion of the content.
protected Vector	getPositionsInRange(Vector 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) Enabled: Retrieves a portion of the content.
javax.swing.undo.UndoableEdit	insertString(int where, String str) Enabled: Inserts a string into the content.
int	length() Enabled: Returns the length of the content.
javax.swing.undo.UndoableEdit	remove(int where, int nitems) Enabled: Removes part of the content.
(package private) void	replace(int offset, int length, char[] replArray, int replOffset, int replLength) Replaces some of the characters in the array
(package private) void	resize(int ncount)
(package private) void	updateMarksForInsert(int offset, int length)
(package private) void	updateMarksForRemove(int offset, int length)
protected void	updateUndoPositions(Vector positions) Resets the location for all the UndoPosRef instances in positions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

empty

private static final char[] empty

data

private char[] data

count

private int count

marks

transient Vector marks

Constructor Detail

StringContent

public StringContent()

Enabled: Creates a new StringContent object. Initial size defaults to 10.

StringContent

public StringContent(int initialLength)

Enabled: Creates a new StringContent object, with the initial size specified. If the length is < 1, a size of 1 is used.

Parameters:

initialLength - the initial size

Method Detail

length

public int length()

Enabled: Returns the length of the content.

Specified by:

length in interface javax.swing.text.AbstractDocument.Content

Returns:

the length >= 1

See Also:

AbstractDocument.Content#length

insertString

public javax.swing.undo.UndoableEdit insertString(int where,
                                                  String str)
                                           throws BadLocationException

Enabled: Inserts a string into the content.

Specified by:

insertString in interface javax.swing.text.AbstractDocument.Content

Parameters:

where - the starting position >= 0 && < length()

str - the non-null string to insert

Returns:

an UndoableEdit object for undoing

BadLocationException

See Also:

AbstractDocument.Content#insertString

remove

public javax.swing.undo.UndoableEdit remove(int where,
                                            int nitems)
                                     throws BadLocationException

Enabled: Removes part of the content. where + nitems must be < length().

Specified by:

remove in interface javax.swing.text.AbstractDocument.Content

Parameters:

where - the starting position >= 0

nitems - the number of characters to remove >= 0

Returns:

an UndoableEdit object for undoing

BadLocationException

See Also:

AbstractDocument.Content#remove

getString

public String getString(int where,
                        int len)
                 throws BadLocationException

Enabled: Retrieves a portion of the content. where + len must be <= length().

Specified by:

getString in interface javax.swing.text.AbstractDocument.Content

Parameters:

where - the starting position >= 0

len - the length to retrieve >= 0

Returns:

a string representing the content; may be empty

BadLocationException

See Also:

AbstractDocument.Content#getString

getChars

public void getChars(int where,
                     int len,
                     Segment chars)
              throws BadLocationException

Suppressed: Retrieves a portion of the content. where + len must be <= length()

Specified by:

getChars in interface javax.swing.text.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

BadLocationException

See Also:

AbstractDocument.Content#getChars

createPosition

public Position createPosition(int offset)
                        throws BadLocationException

Enabled: Creates a position within the content that will track change as the content is mutated.

Specified by:

createPosition in interface javax.swing.text.AbstractDocument.Content

Parameters:

offset - the offset to create a position for >= 0

Returns:

the position

BadLocationException

replace

void replace(int offset,
             int length,
             char[] replArray,
             int replOffset,
             int replLength)

Replaces some of the characters in the array

Parameters:

offset - offset into the array to start the replace

length - number of characters to remove

replArray - replacement array

replOffset - offset into the replacement array

replLength - number of character to use from the replacement array.

resize

void resize(int ncount)

updateMarksForInsert

void updateMarksForInsert(int offset,
                          int length)

updateMarksForRemove

void updateMarksForRemove(int offset,
                          int length)

getPositionsInRange

protected Vector getPositionsInRange(Vector 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

updateUndoPositions

protected void updateUndoPositions(Vector 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