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 Summary
Modifier and TypeFieldDescriptionstatic final short
A possible value for getType.static final short
A possible value for getType.static final short
A possible value for getDirection.static final short
A possible value for getDirection.static final short
A possible value for getDirection.static final short
A possible value for getDirection.static final short
A possible value for getType. -
Constructor Summary
ConstructorDescriptionElementSpec
(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 Summary
Modifier and TypeMethodDescriptionchar[]
getArray()
Gets the array of characters.Gets the element attributes.short
Gets the direction.int
Gets the length.int
Gets the starting offset.short
getType()
Gets the element type.void
setDirection
(short direction) Sets the direction.void
setType
(short type) Sets the element type.toString()
Converts the element to a string.
-
Field Details
-
StartTagType
public 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:
-
EndTagType
public 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:
-
ContentType
public static final short ContentTypeA possible value for getType. This specifies that this record type represents content.- See Also:
-
JoinPreviousDirection
public 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:
-
JoinNextDirection
public 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:
-
OriginateDirection
public 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:
-
JoinFractureDirection
public 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
-
ElementSpec
Constructor useful for markup when the markup will not be stored in the document.- Parameters:
a
- the attributes for the elementtype
- the type of the element (StartTagType, EndTagType, ContentType)
-
ElementSpec
Constructor for parsing inside the document when the data has already been added, but len information is needed.- Parameters:
a
- the attributes for the elementtype
- the type of the element (StartTagType, EndTagType, ContentType)len
- the length >= 0
-
ElementSpec
Constructor for creating a spec externally for batch input of content and markup into the document.- Parameters:
a
- the attributes for the elementtype
- the type of the element (StartTagType, EndTagType, ContentType)txt
- the text for the elementoffs
- the offset into the text >= 0len
- the length of the text >= 0
-
-
Method Details
-
setType
public void setType(short type) Sets the element type.- Parameters:
type
- the type of the element (StartTagType, EndTagType, ContentType)
-
getType
public short getType()Gets the element type.- Returns:
- the type of the element (StartTagType, EndTagType, ContentType)
-
setDirection
public void setDirection(short direction) Sets the direction.- Parameters:
direction
- the direction (JoinPreviousDirection, JoinNextDirection)
-
getDirection
public short getDirection()Gets the direction.- Returns:
- the direction (JoinPreviousDirection, JoinNextDirection)
-
getAttributes
Gets the element attributes.- Returns:
- the attribute set
-
getArray
public char[] getArray()Gets the array of characters.- Returns:
- the array
-
getOffset
public int getOffset()Gets the starting offset.- Returns:
- the offset >= 0
-
getLength
public int getLength()Gets the length.- Returns:
- the length >= 0
-
toString
Converts the element to a string.
-