de.intarsys.pdf.pd

Class PDOutlineNode

java.lang.Object

de.intarsys.pdf.cos.COSBasedObject

de.intarsys.pdf.pd.PDObject

de.intarsys.pdf.pd.PDOutlineNode

All Implemented Interfaces:

ICOSObjectListener, de.intarsys.tools.attribute.IAttributeSupport

Direct Known Subclasses:

PDOutline, PDOutlineItem

public abstract class PDOutlineNode
extends PDObject

Factoring out the commonalities between the PDOutline and PDOutlineItem.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PDOutlineNode.MetaClass The meta class implementation

Field Summary

Fields

Modifier and Type	Field and Description
static COSName	DK_Count
static COSName	DK_First
static COSName	DK_Last
static PDOutlineNode.MetaClass	META The meta class instance

Fields inherited from class de.intarsys.pdf.pd.PDObject

DK_Subtype, DK_Type

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(PDOutlineItem newItem) Add a new PDOutlineItem.
boolean	collapse() Collapse this node (mark the children invisible).
boolean	expand() Expand this node (mark the children visible).
List<PDOutlineItem>	getChildren() The list of all child nodes for this.
int	getCount() The number of child elements.
PDOutlineItem	getFirst() The first child element in the linked list of children.
PDOutlineItem	getLast() The last child element in the linked list of children.
boolean	isOutline() true if this is the outline (root element) itself.
boolean	removeItem(PDOutlineItem pItem) Remove a PDOutlineItem from this.

Methods inherited from class de.intarsys.pdf.pd.PDObject

cosGetFieldDescendant, cosGetFieldInheritable, cosGetFieldInherited, cosGetSubtype, cosGetType, cosRemoveFieldInheritable, cosSetFieldInheritable, cosSetSubtype, cosSetType, getDoc, getGenericChildren, getGenericParent, setGenericParent, toString

Methods inherited from class de.intarsys.pdf.cos.COSBasedObject

changed, cosGetArray, cosGetDict, cosGetDoc, cosGetField, cosGetObject, cosGetStream, cosHasField, cosRemoveField, cosSetField, getAttribute, getFieldBoolean, getFieldDate, getFieldFixed, getFieldFixedArray, getFieldInt, getFieldMLString, getFieldString, invalidateCaches, removeAttribute, setAttribute, setFieldBoolean, setFieldFixed, setFieldInt, setFieldMLString, setFieldName, setFieldObject, setFieldString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

META

public static final PDOutlineNode.MetaClass META

The meta class instance

DK_First

public static final COSName DK_First

DK_Last

public static final COSName DK_Last

DK_Count

public static final COSName DK_Count

Method Detail

addItem

public void addItem(PDOutlineItem newItem)

Add a new PDOutlineItem.

Parameters:

newItem - The new item to be inserted at the end.

collapse

public boolean collapse()

Collapse this node (mark the children invisible).

Returns:

true if the expansion state of the node changes.

expand

public boolean expand()

Expand this node (mark the children visible).

Returns:

true if the expansion state of the node changes.

getChildren

public List<PDOutlineItem> getChildren()

The list of all child nodes for this.

Returns:

The list of all child nodes for this.

getCount

public int getCount()

The number of child elements.

Returns:

The number of child elements.

getFirst

public PDOutlineItem getFirst()

The first child element in the linked list of children.

Returns:

The first child element in the linked list of children.

getLast

public PDOutlineItem getLast()

The last child element in the linked list of children.

Returns:

The last child element in the linked list of children.

isOutline

public boolean isOutline()

true if this is the outline (root element) itself.

Returns:

true if this is the outline (root element) itself.

removeItem

public boolean removeItem(PDOutlineItem pItem)

Remove a PDOutlineItem from this.

Parameters:

pItem - The item to be removed.

Returns:

true if the item was removed.