Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.swing.text
Class StringContent

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.swing.text.StringContent
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , AbstractDocument.Content sample code for javax.swing.text.AbstractDocument.Content definition code for javax.swing.text.AbstractDocument.Content 
public final class StringContent
extends Object sample code for java.lang.Object definition code for java.lang.Object 
implements AbstractDocument.Content sample code for javax.swing.text.AbstractDocument.Content definition code for javax.swing.text.AbstractDocument.Content , Serializable sample code for java.io.Serializable definition code for java.io.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 sample code for java.beans.XMLEncoder definition code for java.beans.XMLEncoder .

See Also:
Serialized Form

Constructor Summary
StringContent sample code for javax.swing.text.StringContent.StringContent() definition code for javax.swing.text.StringContent.StringContent() ()
          Creates a new StringContent object.
StringContent sample code for javax.swing.text.StringContent.StringContent(int) definition code for javax.swing.text.StringContent.StringContent(int) (int initialLength)
          Creates a new StringContent object, with the initial size specified.
 
Method Summary
 Position sample code for javax.swing.text.Position definition code for javax.swing.text.Position createPosition sample code for javax.swing.text.StringContent.createPosition(int) definition code for javax.swing.text.StringContent.createPosition(int) (int offset)
          Creates a position within the content that will track change as the content is mutated.
 void getChars sample code for javax.swing.text.StringContent.getChars(int, int, javax.swing.text.Segment) definition code for javax.swing.text.StringContent.getChars(int, int, javax.swing.text.Segment) (int where, int len, Segment sample code for javax.swing.text.Segment definition code for javax.swing.text.Segment  chars)
          Retrieves a portion of the content.
protected  Vector sample code for java.util.Vector definition code for java.util.Vector getPositionsInRange sample code for javax.swing.text.StringContent.getPositionsInRange(java.util.Vector, int, int) definition code for javax.swing.text.StringContent.getPositionsInRange(java.util.Vector, int, int) (Vector sample code for java.util.Vector definition code for java.util.Vector  v, int offset, int length)
          Returns a Vector containing instances of UndoPosRef for the Positions in the range offset to offset + length.
 String sample code for java.lang.String definition code for java.lang.String getString sample code for javax.swing.text.StringContent.getString(int, int) definition code for javax.swing.text.StringContent.getString(int, int) (int where, int len)
          Retrieves a portion of the content.
 UndoableEdit sample code for javax.swing.undo.UndoableEdit definition code for javax.swing.undo.UndoableEdit insertString sample code for javax.swing.text.StringContent.insertString(int, java.lang.String) definition code for javax.swing.text.StringContent.insertString(int, java.lang.String) (int where, String sample code for java.lang.String definition code for java.lang.String  str)
          Inserts a string into the content.
 int length sample code for javax.swing.text.StringContent.length() definition code for javax.swing.text.StringContent.length() ()
          Returns the length of the content.
 UndoableEdit sample code for javax.swing.undo.UndoableEdit definition code for javax.swing.undo.UndoableEdit remove sample code for javax.swing.text.StringContent.remove(int, int) definition code for javax.swing.text.StringContent.remove(int, int) (int where, int nitems)
          Removes part of the content.
protected  void updateUndoPositions sample code for javax.swing.text.StringContent.updateUndoPositions(java.util.Vector) definition code for javax.swing.text.StringContent.updateUndoPositions(java.util.Vector) (Vector sample code for java.util.Vector definition code for java.util.Vector  positions)
          Resets the location for all the UndoPosRef instances in positions.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

StringContent sample code for javax.swing.text.StringContent() definition code for javax.swing.text.StringContent() 

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

StringContent sample code for javax.swing.text.StringContent(int) definition code for javax.swing.text.StringContent(int) 

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
Method Detail

length sample code for javax.swing.text.StringContent.length() definition code for javax.swing.text.StringContent.length() 

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

Specified by:
length sample code for javax.swing.text.AbstractDocument.Content.length() definition code for javax.swing.text.AbstractDocument.Content.length() in interface AbstractDocument.Content sample code for javax.swing.text.AbstractDocument.Content definition code for javax.swing.text.AbstractDocument.Content
Returns:
the length >= 1
See Also:
AbstractDocument.Content.length() sample code for javax.swing.text.AbstractDocument.Content.length() definition code for javax.swing.text.AbstractDocument.Content.length()

insertString sample code for javax.swing.text.StringContent.insertString(int, java.lang.String) definition code for javax.swing.text.StringContent.insertString(int, java.lang.String) 

public UndoableEdit sample code for javax.swing.undo.UndoableEdit definition code for javax.swing.undo.UndoableEdit  insertString(int where,
                                 String sample code for java.lang.String definition code for java.lang.String  str)
                          throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException
Inserts a string into the content.

Specified by:
insertString sample code for javax.swing.text.AbstractDocument.Content.insertString(int, java.lang.String) definition code for javax.swing.text.AbstractDocument.Content.insertString(int, java.lang.String) in interface AbstractDocument.Content sample code for javax.swing.text.AbstractDocument.Content definition code for 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
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException - if the specified position is invalid
See Also:
AbstractDocument.Content.insertString(int, java.lang.String) sample code for javax.swing.text.AbstractDocument.Content.insertString(int, java.lang.String) definition code for javax.swing.text.AbstractDocument.Content.insertString(int, java.lang.String)

remove sample code for javax.swing.text.StringContent.remove(int, int) definition code for javax.swing.text.StringContent.remove(int, int) 

public UndoableEdit sample code for javax.swing.undo.UndoableEdit definition code for javax.swing.undo.UndoableEdit  remove(int where,
                           int nitems)
                    throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException
Removes part of the content. where + nitems must be < length().

Specified by:
remove sample code for javax.swing.text.AbstractDocument.Content.remove(int, int) definition code for javax.swing.text.AbstractDocument.Content.remove(int, int) in interface AbstractDocument.Content sample code for javax.swing.text.AbstractDocument.Content definition code for 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
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException - if the specified position is invalid
See Also:
AbstractDocument.Content.remove(int, int) sample code for javax.swing.text.AbstractDocument.Content.remove(int, int) definition code for javax.swing.text.AbstractDocument.Content.remove(int, int)

getString sample code for javax.swing.text.StringContent.getString(int, int) definition code for javax.swing.text.StringContent.getString(int, int) 

public String sample code for java.lang.String definition code for java.lang.String  getString(int where,
                        int len)
                 throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException
Retrieves a portion of the content. where + len must be <= length().

Specified by:
getString sample code for javax.swing.text.AbstractDocument.Content.getString(int, int) definition code for javax.swing.text.AbstractDocument.Content.getString(int, int) in interface AbstractDocument.Content sample code for javax.swing.text.AbstractDocument.Content definition code for 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
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException - if the specified position is invalid
See Also:
AbstractDocument.Content.getString(int, int) sample code for javax.swing.text.AbstractDocument.Content.getString(int, int) definition code for javax.swing.text.AbstractDocument.Content.getString(int, int)

getChars sample code for javax.swing.text.StringContent.getChars(int, int, javax.swing.text.Segment) definition code for javax.swing.text.StringContent.getChars(int, int, javax.swing.text.Segment) 

public void getChars(int where,
                     int len,
                     Segment sample code for javax.swing.text.Segment definition code for javax.swing.text.Segment  chars)
              throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException
Retrieves a portion of the content. where + len must be <= length()

Specified by:
getChars sample code for javax.swing.text.AbstractDocument.Content.getChars(int, int, javax.swing.text.Segment) definition code for javax.swing.text.AbstractDocument.Content.getChars(int, int, javax.swing.text.Segment) in interface AbstractDocument.Content sample code for javax.swing.text.AbstractDocument.Content definition code for 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
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException - if the specified position is invalid
See Also:
AbstractDocument.Content.getChars(int, int, javax.swing.text.Segment) sample code for javax.swing.text.AbstractDocument.Content.getChars(int, int, javax.swing.text.Segment) definition code for javax.swing.text.AbstractDocument.Content.getChars(int, int, javax.swing.text.Segment)

createPosition sample code for javax.swing.text.StringContent.createPosition(int) definition code for javax.swing.text.StringContent.createPosition(int) 

public Position sample code for javax.swing.text.Position definition code for javax.swing.text.Position  createPosition(int offset)
                        throws BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException
Creates a position within the content that will track change as the content is mutated.

Specified by:
createPosition sample code for javax.swing.text.AbstractDocument.Content.createPosition(int) definition code for javax.swing.text.AbstractDocument.Content.createPosition(int) in interface AbstractDocument.Content sample code for javax.swing.text.AbstractDocument.Content definition code for javax.swing.text.AbstractDocument.Content
Parameters:
offset - the offset to create a position for >= 0
Returns:
the position
Throws:
BadLocationException sample code for javax.swing.text.BadLocationException definition code for javax.swing.text.BadLocationException - if the specified position is invalid

getPositionsInRange sample code for javax.swing.text.StringContent.getPositionsInRange(java.util.Vector, int, int) definition code for javax.swing.text.StringContent.getPositionsInRange(java.util.Vector, int, int) 

protected Vector sample code for java.util.Vector definition code for java.util.Vector  getPositionsInRange(Vector sample code for java.util.Vector definition code for java.util.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 sample code for javax.swing.text.StringContent.updateUndoPositions(java.util.Vector) definition code for javax.swing.text.StringContent.updateUndoPositions(java.util.Vector) 

protected void updateUndoPositions(Vector sample code for java.util.Vector definition code for java.util.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
Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD