public static class

DefaultStyledDocument.ElementSpec

extends Object
java.lang.Object
   ↳ javax.swing.text.DefaultStyledDocument.ElementSpec

Class Overview

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

Summary

Constants
short ContentType A possible value for getType.
short EndTagType A possible value for getType.
short JoinFractureDirection A possible value for getDirection.
short JoinNextDirection A possible value for getDirection.
short JoinPreviousDirection A possible value for getDirection.
short OriginateDirection A possible value for getDirection.
short StartTagType A possible value for getType.
Public Constructors
DefaultStyledDocument.ElementSpec(AttributeSet a, short type)
Constructor useful for markup when the markup will not be stored in the document.
DefaultStyledDocument.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.
DefaultStyledDocument.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.
Public Methods
char[] getArray()
Gets the array of characters.
AttributeSet getAttributes()
Gets the element attributes.
short getDirection()
Gets the direction.
int getLength()
Gets the length.
int getOffset()
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.
String toString()
Converts the element to a string.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final short ContentType

A possible value for getType. This specifies that this record type represents content.

Constant Value: 3 (0x00000003)

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.

Constant Value: 2 (0x00000002)

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.

Constant Value: 7 (0x00000007)

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.

Constant Value: 5 (0x00000005)

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.

Constant Value: 4 (0x00000004)

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.

Constant Value: 6 (0x00000006)

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.

Constant Value: 1 (0x00000001)

Public Constructors

public DefaultStyledDocument.ElementSpec (AttributeSet a, short type)

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

Parameters
a the attributes for the element
type the type of the element (StartTagType, EndTagType, ContentType)
len the length >= 0

public DefaultStyledDocument.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.

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

Public Methods

public char[] getArray ()

Gets the array of characters.

Returns
  • the array

public AttributeSet getAttributes ()

Gets the element attributes.

Returns
  • the attribute set

public short getDirection ()

Gets the direction.

Returns
  • the direction (JoinPreviousDirection, JoinNextDirection)

public int getLength ()

Gets the length.

Returns
  • the length >= 0

public int getOffset ()

Gets the starting offset.

Returns
  • the offset >= 0

public short getType ()

Gets the element type.

Returns
  • the type of the element (StartTagType, EndTagType, ContentType)

public void setDirection (short direction)

Sets the direction.

Parameters
direction the direction (JoinPreviousDirection, JoinNextDirection)

public void setType (short type)

Sets the element type.

Parameters
type the type of the element (StartTagType, EndTagType, ContentType)

public String toString ()

Converts the element to a string.

Returns
  • the string