public final class

StringContent

extends Object
implements Serializable AbstractDocument.Content
java.lang.Object
   ↳ javax.swing.text.StringContent

Class Overview

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.

Summary

Public Constructors
StringContent()
Creates a new StringContent object.
StringContent(int initialLength)
Creates a new StringContent object, with the initial size specified.
Public Methods
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.
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 Methods
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.
void updateUndoPositions(Vector positions)
Resets the location for all the UndoPosRef instances in positions.
[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.swing.text.AbstractDocument.Content

Public Constructors

public StringContent ()

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

public StringContent (int initialLength)

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

Public Methods

public Position createPosition (int offset)

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

Parameters
offset the offset to create a position for >= 0
Returns
  • the position
Throws
BadLocationException if the specified position is invalid

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

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

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

public String getString (int where, int len)

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

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

public UndoableEdit insertString (int where, String str)

Inserts a string into the content.

Parameters
where the starting position >= 0 && < length()
str the non-null string to insert
Returns
  • an UndoableEdit object for undoing
Throws
BadLocationException if the specified position is invalid
See Also

public int length ()

Returns the length of the content.

Returns
  • the length >= 1
See Also

public UndoableEdit remove (int where, int nitems)

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

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

Protected Methods

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

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