Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing.text

Class DefaultStyledDocument.ElementSpec

Enclosing Class:
DefaultStyledDocument
public static class DefaultStyledDocument.ElementSpec
extends Object
Carries specification information for new Elements that should be created in DefaultStyledDocument.ElementBuffer. This allows the parsing process to be decoupled from the Element creation process.

Field Summary

static short
ContentType
This indicates a content element.
static short
EndTagType
This indicates an end tag.
static short
JoinFractureDirection
This indicates that the data associated with this spec should be joined to the fractured element.
static short
JoinNextDirection
This indicates that the data associated with this spec should be joined with what follows it.
static short
JoinPreviousDirection
This indicates that the data associated with this spec should be joined with what precedes it.
static short
OriginateDirection
This indicates that the data associated with this spec should be used to create a new element.
static short
StartTagType
This indicates a start tag.

Constructor Summary

ElementSpec(AttributeSet a, short type)
Creates a new ElementSpec with no content, length or offset.
ElementSpec(AttributeSet a, short type, char[] txt, int offs, int len)
Creates a new ElementSpec with document content.
ElementSpec(AttributeSet a, short type, int len)
Creates a new ElementSpec that specifies the length but not the offset of an element.

Method Summary

char[]
getArray()
Returns the actual content of the element.
AttributeSet
getAttributes()
Returns the attributes of the element.
short
getDirection()
Returns the direction of the element.
int
getLength()
Returns the length of the content.
int
getOffset()
Returns the offset of the content.
short
getType()
Returns the type of the element.
void
setDirection(short dir)
Sets the direction of the element.
void
setType(short type)
Sets the type of the element.
String
toString()
Returns a String representation of this ElementSpec describing the type, direction and length of this ElementSpec.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ContentType

public static final short ContentType
This indicates a content element. This is a possible value for getType().
Field Value:
3

EndTagType

public static final short EndTagType
This indicates an end tag. This is a possible value for getType().
Field Value:
2

JoinFractureDirection

public static final short JoinFractureDirection
This indicates that the data associated with this spec should be joined to the fractured element. This is a possible value for getDirection().
Field Value:
7

JoinNextDirection

public static final short JoinNextDirection
This indicates that the data associated with this spec should be joined with what follows it. This is a possible value for getDirection().
Field Value:
5

JoinPreviousDirection

public static final short JoinPreviousDirection
This indicates that the data associated with this spec should be joined with what precedes it. This is a possible value for getDirection().
Field Value:
4

OriginateDirection

public static final short OriginateDirection
This indicates that the data associated with this spec should be used to create a new element. This is a possible value for getDirection().
Field Value:
6

StartTagType

public static final short StartTagType
This indicates a start tag. This is a possible value for getType().
Field Value:
1

Constructor Details

ElementSpec

public ElementSpec(AttributeSet a,
                   short type)
Creates a new ElementSpec with no content, length or offset. This is most useful for start and end tags.
Parameters:
a - the attributes for the element to be created
type - the type of the tag

ElementSpec

public ElementSpec(AttributeSet a,
                   short type,
                   char[] txt,
                   int offs,
                   int len)
Creates a new ElementSpec with document content.
Parameters:
a - the attributes for the element to be created
type - the type of the tag
txt - the actual content
offs - the offset into the txt array
len - the length of the element

ElementSpec

public ElementSpec(AttributeSet a,
                   short type,
                   int len)
Creates a new ElementSpec that specifies the length but not the offset of an element. Such ElementSpecs are processed sequentially from a known starting point.
Parameters:
a - the attributes for the element to be created
type - the type of the tag
len - the length of the element

Method Details

getArray

public char[] getArray()
Returns the actual content of the element.
Returns:
the actual content of the element

getAttributes

public AttributeSet getAttributes()
Returns the attributes of the element.
Returns:
the attributes of the element

getDirection

public short getDirection()
Returns the direction of the element.
Returns:
the direction of the element

getLength

public int getLength()
Returns the length of the content.
Returns:
the length of the content

getOffset

public int getOffset()
Returns the offset of the content.
Returns:
the offset of the content

getType

public short getType()
Returns the type of the element.
Returns:
the type of the element

setDirection

public void setDirection(short dir)
Sets the direction of the element.
Parameters:
dir - the direction of the element to be set

setType

public void setType(short type)
Sets the type of the element.
Parameters:
type - the type of the element to be set

toString

public String toString()
Returns a String representation of this ElementSpec describing the type, direction and length of this ElementSpec.
Overrides:
toString in interface Object
Returns:
a String representation of this ElementSpec
DefaultStyledDocument.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About