Package Summary  Overview Summary

class:DefaultStyledDocument.ElementSpec [NONE]

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

field:StartTagType [NONE]

  • 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.
    See Also:
    Constant Field Values
  • field:EndTagType [NONE]

    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.
    See Also:
    Constant Field Values

    field:ContentType [NONE]

    ContentType

    public static final  short ContentType
    A possible value for getType. This specifies that this record type represents content.
    See Also:
    Constant Field Values

    field:JoinPreviousDirection [NONE]

    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.
    See Also:
    Constant Field Values

    field:JoinNextDirection [NONE]

    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.
    See Also:
    Constant Field Values

    field:OriginateDirection [NONE]

    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.
    See Also:
    Constant Field Values

    field:JoinFractureDirection [NONE]

    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.
    See Also:
    Constant Field Values

    constructor:DefaultStyledDocument.ElementSpec(javax.swing.text.AttributeSet,short) [NONE]

  • ElementSpec

    public 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)
  • constructor:DefaultStyledDocument.ElementSpec(javax.swing.text.AttributeSet,short,int) [NONE]

    ElementSpec

    public 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

    constructor:DefaultStyledDocument.ElementSpec(javax.swing.text.AttributeSet,short,char[],int,int) [NONE]

    ElementSpec

    public 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

    method:setType(short) [NONE]

  • setType

    public void setType?(short type)
    Sets the element type.
    Parameters:
    type - the type of the element (StartTagType, EndTagType, ContentType)
  • method:getType() [NONE]

    getType

    public short getType()
    Gets the element type.
    Returns:
    the type of the element (StartTagType, EndTagType, ContentType)

    method:setDirection(short) [NONE]

    setDirection

    public void setDirection?(short direction)
    Sets the direction.
    Parameters:
    direction - the direction (JoinPreviousDirection, JoinNextDirection)

    method:getDirection() [NONE]

    getDirection

    public short getDirection()
    Gets the direction.
    Returns:
    the direction (JoinPreviousDirection, JoinNextDirection)

    method:getAttributes() [NONE]

    getAttributes

    public AttributeSet getAttributes()
    Gets the element attributes.
    Returns:
    the attribute set

    method:getArray() [NONE]

    getArray

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

    method:getOffset() [NONE]

    getOffset

    public int getOffset()
    Gets the starting offset.
    Returns:
    the offset >= 0

    method:getLength() [NONE]

    getLength

    public int getLength()
    Gets the length.
    Returns:
    the length >= 0

    method:toString() [NONE]

    toString

    public String toString()
    Converts the element to a string.
    Overrides:
    toString in class Object
    Returns:
    the string

    © 2021 Oracle Corporation and/or its affiliates