Home » openjdk-7 » javax » swing » text » [javadoc | source]

javax.swing.text
public static class: DefaultStyledDocument.ElementSpec [javadoc | source]

java.lang.Object
   javax.swing.text.DefaultStyledDocument$ElementSpec

Specification for building elements.

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 JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder .

Field Summary
public static final  short	StartTagType	A possible value for getType. This specifies that this record type is a start tag and represents markup that specifies the start of an element.
public static final  short	EndTagType	A possible value for getType. This specifies that this record type is a end tag and represents markup that specifies the end of an element.
public static final  short	ContentType	A possible value for getType. This specifies that this record type represents content.
public static final  short	JoinPreviousDirection	A possible value for getDirection. This specifies that the data associated with this record should be joined to what precedes it.
public static final  short	JoinNextDirection	A possible value for getDirection. This specifies that the data associated with this record should be joined to what follows it.
public static final  short	OriginateDirection	A possible value for getDirection. This specifies that the data associated with this record should be used to originate a new element. This would be the normal value.
public static final  short	JoinFractureDirection	A possible value for getDirection. This specifies that the data associated with this record should be joined to the fractured element.

Constructor:
public ElementSpec(AttributeSet a, short type) { this(a, type, null, 0, 0); } Constructor useful for markup when the markup will not be stored in the document. Parameters: a - the attributes for the element type - the type of the element (StartTagType, EndTagType, ContentType)
public ElementSpec(AttributeSet a, short type, int len) { this(a, type, null, 0, len); } Constructor for parsing inside the document when the data has already been added, but len information is needed. Parameters: a - the attributes for the element type - the type of the element (StartTagType, EndTagType, ContentType) len - the length >= 0
public ElementSpec(AttributeSet a, short type, char[] txt, int offs, int len) { attr = a; this.type = type; this.data = txt; this.offs = offs; this.len = len; this.direction = OriginateDirection; } Constructor for creating a spec externally for batch input of content and markup into the document. Parameters: a - the attributes for the element type - the type of the element (StartTagType, EndTagType, ContentType) txt - the text for the element offs - the offset into the text >= 0 len - the length of the text >= 0

Method from javax.swing.text.DefaultStyledDocument$ElementSpec Summary:
getArray,   getAttributes,   getDirection,   getLength,   getOffset,   getType,   setDirection,   setType,   toString

Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from javax.swing.text.DefaultStyledDocument$ElementSpec Detail:
public char[] getArray() { return data; } Gets the array of characters.
public AttributeSet getAttributes() { return attr; } Gets the element attributes.
public short getDirection() { return direction; } Gets the direction.
public int getLength() { return len; } Gets the length.
public int getOffset() { return offs; } Gets the starting offset.
public short getType() { return type; } Gets the element type.
public void setDirection(short direction) { this.direction = direction; } Sets the direction.
public void setType(short type) { this.type = type; } Sets the element type.
public String toString() { String tlbl = "??"; String plbl = "??"; switch(type) { case StartTagType: tlbl = "StartTag"; break; case ContentType: tlbl = "Content"; break; case EndTagType: tlbl = "EndTag"; break; } switch(direction) { case JoinPreviousDirection: plbl = "JoinPrevious"; break; case JoinNextDirection: plbl = "JoinNext"; break; case OriginateDirection: plbl = "Originate"; break; case JoinFractureDirection: plbl = "Fracture"; break; } return tlbl + ":" + plbl + ":" + getLength(); } Converts the element to a string.