javax.swing.text

Class DefaultStyledDocument.ElementSpec

public static class DefaultStyledDocument.ElementSpec extends Object

Carries specification information for new {@link Element}s that should be created in {@link 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
	ElementSpec(AttributeSet a, short type) Creates a new `ElementSpec` with no content, length or offset.
	ElementSpec(AttributeSet a, short type, int len) Creates a new `ElementSpec` that specifies the length but not the offset of an element.
	ElementSpec(AttributeSet a, short type, char[] txt, int offs, int len) Creates a new `ElementSpec` with document content.

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`.

Field Detail

ContentType

public static final short ContentType

This indicates a content element. This is a possible value for {@link #getType}.

EndTagType

public static final short EndTagType

This indicates an end tag. This is a possible value for {@link #getType}.

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 {@link #getDirection}.

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 {@link #getDirection}.

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 {@link #getDirection}.

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 {@link #getDirection}.

StartTagType

public static final short StartTagType

This indicates a start tag. This is a possible value for {@link #getType}.

Constructor Detail

ElementSpec

public 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

ElementSpec

public 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

ElementSpec

public 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