Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

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. 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 Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.


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.
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)
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.
void  updateUndoPositions(Vector positions)
For all the UndoPosRef instances in positions the location is reset.
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringContent

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

StringContent

public StringContent(int initialLength)
Creates a new StringContent object, with the initial size specified.
Parameters:
initialLength - the initial size
Method Detail

length

public int length()
Returns the length of the content.
Implements:
length in interface AbstractDocument.Content
Returns:
the length
See Also:
length

insertString

public UndoableEdit insertString(int where,
                                 String str) throws BadLocationException
Inserts a string into the content.
Implements:
insertString in interface AbstractDocument.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

remove

public UndoableEdit remove(int where,
                           int nitems) throws BadLocationException
Removes part of the content.
Implements:
remove in interface AbstractDocument.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

getString

public String getString(int where,
                        int len) throws BadLocationException
Retrieves a portion of the content.
Implements:
getString in interface AbstractDocument.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

getChars

public void getChars(int where,
                     int len,
                     Segment chars) throws BadLocationException
Retrieves a portion of the content.
Implements:
getChars in interface AbstractDocument.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

createPosition

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

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.

updateUndoPositions

protected void updateUndoPositions(Vector positions)
For all the UndoPosRef instances in positions the location is reset.

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.