javax.swing.text
Class DefaultStyledDocument.ElementSpec

java.lang.Object
  extended by javax.swing.text.DefaultStyledDocument.ElementSpec
Enclosing class:
DefaultStyledDocument

public static class DefaultStyledDocument.ElementSpec
extends Object

Carries specification information for new Elements that should be created in DefaultStyledDocument.ElementBuffer. This allows the parsing process to be decoupled from the Element creation process.


Field Summary
static short ContentType
          This indicates a content element.
static short EndTagType
          This indicates an end tag.
static short JoinFractureDirection
          This indicates that the data associated with this spec should be joined to the fractured element.
static short JoinNextDirection
          This indicates that the data associated with this spec should be joined with what follows it.
static short JoinPreviousDirection
          This indicates that the data associated with this spec should be joined with what precedes it.
static short OriginateDirection
          This indicates that the data associated with this spec should be used to create a new element.
static short StartTagType
          This indicates a start tag.
 
Constructor Summary
DefaultStyledDocument.ElementSpec(AttributeSet a, short type)
          Creates a new ElementSpec with no content, length or offset.
DefaultStyledDocument.ElementSpec(AttributeSet a, short type, char[] txt, int offs, int len)
          Creates a new ElementSpec with document content.
DefaultStyledDocument.ElementSpec(AttributeSet a, short type, int len)
          Creates a new ElementSpec that specifies the length but not the offset of an element.
 
Method Summary
 char[] getArray()
          Returns the actual content of the element.
 AttributeSet getAttributes()
          Returns the attributes of the element.
 short getDirection()
          Returns the direction of the element.
 int getLength()
          Returns the length of the content.
 int getOffset()
          Returns the offset of the content.
 short getType()
          Returns the type of the element.
 void setDirection(short dir)
          Sets the direction of the element.
 void setType(short type)
          Sets the type of the element.
 String toString()
          Returns a String representation of this ElementSpec describing the type, direction and length of this ElementSpec.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

StartTagType

public static final short StartTagType
This indicates a start tag. This is a possible value for getType().

See Also:
Constant Field Values

EndTagType

public static final short EndTagType
This indicates an end tag. This is a possible value for getType().

See Also:
Constant Field Values

ContentType

public static final short ContentType
This indicates a content element. This is a possible value for getType().

See Also:
Constant Field Values

JoinPreviousDirection

public static final short JoinPreviousDirection
This indicates that the data associated with this spec should be joined with what precedes it. This is a possible value for getDirection().

See Also:
Constant Field Values

JoinNextDirection

public static final short JoinNextDirection
This indicates that the data associated with this spec should be joined with what follows it. This is a possible value for getDirection().

See Also:
Constant Field Values

OriginateDirection

public static final short OriginateDirection
This indicates that the data associated with this spec should be used to create a new element. This is a possible value for getDirection().

See Also:
Constant Field Values

JoinFractureDirection

public static final short JoinFractureDirection
This indicates that the data associated with this spec should be joined to the fractured element. This is a possible value for getDirection().

See Also:
Constant Field Values
Constructor Detail

DefaultStyledDocument.ElementSpec

public DefaultStyledDocument.ElementSpec(AttributeSet a,
                                         short type)
Creates a new ElementSpec with no content, length or offset. This is most useful for start and end tags.

Parameters:
a - the attributes for the element to be created
type - the type of the tag

DefaultStyledDocument.ElementSpec

public DefaultStyledDocument.ElementSpec(AttributeSet a,
                                         short type,
                                         int len)
Creates a new ElementSpec that specifies the length but not the offset of an element. Such ElementSpecs are processed sequentially from a known starting point.

Parameters:
a - the attributes for the element to be created
type - the type of the tag
len - the length of the element

DefaultStyledDocument.ElementSpec

public DefaultStyledDocument.ElementSpec(AttributeSet a,
                                         short type,
                                         char[] txt,
                                         int offs,
                                         int len)
Creates a new ElementSpec with document content.

Parameters:
a - the attributes for the element to be created
type - the type of the tag
txt - the actual content
offs - the offset into the txt array
len - the length of the element
Method Detail

setType

public void setType(short type)
Sets the type of the element.

Parameters:
type - the type of the element to be set

getType

public short getType()
Returns the type of the element.

Returns:
the type of the element

setDirection

public void setDirection(short dir)
Sets the direction of the element.

Parameters:
dir - the direction of the element to be set

getDirection

public short getDirection()
Returns the direction of the element.

Returns:
the direction of the element

getAttributes

public AttributeSet getAttributes()
Returns the attributes of the element.

Returns:
the attributes of the element

getArray

public char[] getArray()
Returns the actual content of the element.

Returns:
the actual content of the element

getOffset

public int getOffset()
Returns the offset of the content.

Returns:
the offset of the content

getLength

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

Returns:
the length of the content

toString

public String toString()
Returns a String representation of this ElementSpec describing the type, direction and length of this ElementSpec.

Overrides:
toString in class Object
Returns:
a String representation of this ElementSpec
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)