java.lang.Object
javax.swing.text.DefaultStyledDocument.ElementSpec
- Enclosing class:
- DefaultStyledDocument
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
 has been added to the java.beans package.
 Please see XMLEncoder.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final shortA possible value for getType.static final shortA possible value for getType.static final shortA possible value for getDirection.static final shortA possible value for getDirection.static final shortA possible value for getDirection.static final shortA possible value for getDirection.static final shortA possible value for getType.
- 
Constructor SummaryConstructorsConstructorDescriptionElementSpec(AttributeSet a, short type) Constructor useful for markup when the markup will not be stored in the document.ElementSpec(AttributeSet a, short type, char[] txt, int offs, int len) Constructor for creating a spec externally for batch input of content and markup into the document.ElementSpec(AttributeSet a, short type, int len) Constructor for parsing inside the document when the data has already been added, but len information is needed.
- 
Method SummaryModifier and TypeMethodDescriptionchar[]getArray()Gets the array of characters.Gets the element attributes.shortGets the direction.intGets the length.intGets the starting offset.shortgetType()Gets the element type.voidsetDirection(short direction) Sets the direction.voidsetType(short type) Sets the element type.toString()Converts the element to a string.
- 
Field Details- 
StartTagTypepublic static final short StartTagTypeA possible value for getType. This specifies that this record type is a start tag and represents markup that specifies the start of an element.- See Also:
 
- 
EndTagTypepublic static final short EndTagTypeA possible value for getType. This specifies that this record type is a end tag and represents markup that specifies the end of an element.- See Also:
 
- 
ContentTypepublic static final short ContentTypeA possible value for getType. This specifies that this record type represents content.- See Also:
 
- 
JoinPreviousDirectionpublic static final short JoinPreviousDirectionA possible value for getDirection. This specifies that the data associated with this record should be joined to what precedes it.- See Also:
 
- 
JoinNextDirectionpublic static final short JoinNextDirectionA possible value for getDirection. This specifies that the data associated with this record should be joined to what follows it.- See Also:
 
- 
OriginateDirectionpublic static final short OriginateDirectionA 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.- See Also:
 
- 
JoinFractureDirectionpublic static final short JoinFractureDirectionA possible value for getDirection. This specifies that the data associated with this record should be joined to the fractured element.- See Also:
 
 
- 
- 
Constructor Details- 
ElementSpecConstructor 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)
 
- 
ElementSpecConstructor 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
 
- 
ElementSpecConstructor 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 Details- 
setTypepublic void setType(short type) Sets the element type.- Parameters:
- type- the type of the element (StartTagType, EndTagType, ContentType)
 
- 
getTypepublic short getType()Gets the element type.- Returns:
- the type of the element (StartTagType, EndTagType, ContentType)
 
- 
setDirectionpublic void setDirection(short direction) Sets the direction.- Parameters:
- direction- the direction (JoinPreviousDirection, JoinNextDirection)
 
- 
getDirectionpublic short getDirection()Gets the direction.- Returns:
- the direction (JoinPreviousDirection, JoinNextDirection)
 
- 
getAttributesGets the element attributes.- Returns:
- the attribute set
 
- 
getArraypublic char[] getArray()Gets the array of characters.- Returns:
- the array
 
- 
getOffsetpublic int getOffset()Gets the starting offset.- Returns:
- the offset >= 0
 
- 
getLengthpublic int getLength()Gets the length.- Returns:
- the length >= 0
 
- 
toStringConverts the element to a string.
 
-