This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.text
class DefaultStyledDocument.ElementSpec

java.lang.Object extended by javax.swing.text.DefaultStyledDocument.ElementSpec
Enclosing class:
DefaultStyledDocument

public static class DefaultStyledDocument.ElementSpec
extends Object

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 {@link java.beans.XMLEncoder}.


Field Summary
static short ContentType
          A possible value for getType.
static short EndTagType
          A possible value for getType.
static short JoinFractureDirection
          A possible value for getDirection.
static short JoinNextDirection
          A possible value for getDirection.
static short JoinPreviousDirection
          A possible value for getDirection.
static short OriginateDirection
          A possible value for getDirection.
static short StartTagType
          A possible value for getType.
 
Constructor Summary

          Constructor useful for markup when the markup will not be stored in the document.
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.

          Constructor for parsing inside the document when the data has already been added, but len information is needed.
 
Method Summary
 char[]

          Gets the array of characters.
 AttributeSet

          Gets the element attributes.
 short

          Gets the direction.
 int

          Gets the length.
 int

          Gets the starting offset.
 short

          Gets the element type.
 void
setDirection(short direction)

          Sets the direction.
 void
setType(short type)

          Sets the element type.
 String

          Converts the element to a string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ContentType

public static final short ContentType
A possible value for getType. This specifies that this record type represents content.

EndTagType

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.

JoinFractureDirection

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.

JoinNextDirection

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.

JoinPreviousDirection

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.

OriginateDirection

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.

StartTagType

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.
Constructor Detail

DefaultStyledDocument.ElementSpec

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)

DefaultStyledDocument.ElementSpec

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

DefaultStyledDocument.ElementSpec

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
Method Detail

getArray

public char[] getArray()
Gets the array of characters.

Returns:
the array

getAttributes

public AttributeSet getAttributes()
Gets the element attributes.

Returns:
the attribute set

getDirection

public short getDirection()
Gets the direction.

Returns:
the direction (JoinPreviousDirection, JoinNextDirection)

getLength

public int getLength()
Gets the length.

Returns:
the length >= 0

getOffset

public int getOffset()
Gets the starting offset.

Returns:
the offset >= 0

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)

setType

public void setType(short type)
Sets the element type.

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

toString

public String toString()
Converts the element to a string.

Overrides:
toString in class Object
Returns:
the string


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.