de.intarsys.pdf.pd
Class PDOutlineItem

java.lang.Object
  de.intarsys.pdf.cos.COSBasedObject
      de.intarsys.pdf.pd.PDObject
          de.intarsys.pdf.pd.PDOutlineNode
              de.intarsys.pdf.pd.PDOutlineItem

All Implemented Interfaces:

ICOSObjectListener, IAttributeSupport

public class PDOutlineItem
extends PDOutlineNode

A document outline item. This is used to represent all tree elements in a PDF outline tree.

Nested Class Summary

static class

PDOutlineItem.MetaClass The meta class implementation

Field Summary

static COSName	DK_A
static COSName	DK_C
static COSName	DK_Dest
static COSName	DK_F
static COSName	DK_Next
static COSName	DK_Parent
static COSName	DK_Prev
static COSName	DK_SE
static COSName	DK_Title
static PDOutlineItem.MetaClass	META The meta class instance

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

DK_Count, DK_First, DK_Last

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

DK_Subtype, DK_Type

Method Summary

int	basicGetFlags() The flags as integer value.
void	basicSetFlags(int value) Assign the flags from an integer value.
COSArray	cosGetColor() The color values to be used for this.
PDAction	getAction() The PDAction executed when the outline item is activated.
PDDestination	getDestination() The PDDestination to be displayed when the outline item is activated.
OutlineItemFlags	getFlags() The OutlineItemFlags.
PDOutlineItem	getNext() The next PDOutlineItem within the items linked list.
PDOutlineNode	getParent() The parent item.
PDOutlineItem	getPrev() The previous PDOutlineItem within the items linked list.
String	getTitle() The title to be displayed for this.
void	setAction(PDAction action) Assign the PDAction to be executed when the outline is activated.
void	setDestination(PDDestination destination) Assign the PDDestination to be displayed when the outline is activated.
void	setTitle(String title) Assign the outline title

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

addItem, getChildren, getCount, getFirst, getLast, isOutline, removeItem

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

DK_A

public static final COSName DK_A

DK_C

public static final COSName DK_C

DK_Dest

public static final COSName DK_Dest

DK_F

public static final COSName DK_F

DK_Next

public static final COSName DK_Next

DK_Parent

public static final COSName DK_Parent

DK_Prev

public static final COSName DK_Prev

DK_SE

public static final COSName DK_SE

DK_Title

public static final COSName DK_Title

META

public static final PDOutlineItem.MetaClass META

The meta class instance

Method Detail

basicGetFlags

public int basicGetFlags()

The flags as integer value.

Returns:

The flags as integer value.

basicSetFlags

public void basicSetFlags(int value)

Assign the flags from an integer value.

Parameters:

value - The new flags

cosGetColor

public COSArray cosGetColor()

The color values to be used for this.

Returns:

The color values to be used for this.

getAction

public PDAction getAction()

The PDAction executed when the outline item is activated.

Returns:

The PDAction executed when the outline item is activated.

getDestination

public PDDestination getDestination()

The PDDestination to be displayed when the outline item is activated.

Returns:

The PDDestination to be displayed when the outline item is activated.

getFlags

public OutlineItemFlags getFlags()

The OutlineItemFlags.

Returns:

The OutlineItemFlags.

getNext

public PDOutlineItem getNext()

The next PDOutlineItem within the items linked list.

Returns:

The next PDOutlineItem within the items linked list.

getParent

public PDOutlineNode getParent()

The parent item.

Returns:

The parent item.

getPrev

public PDOutlineItem getPrev()

The previous PDOutlineItem within the items linked list.

Returns:

The previous PDOutlineItem within the items linked list.

getTitle

public String getTitle()

The title to be displayed for this.

Returns:

The title to be displayed for this.

setAction

public void setAction(PDAction action)

Assign the PDAction to be executed when the outline is activated.

Parameters:

action - The PDAction to be executed.

setDestination

public void setDestination(PDDestination destination)

Assign the PDDestination to be displayed when the outline is activated.

Parameters:

destination - The PDDestination to be displayed.

setTitle

public void setTitle(String title)

Assign the outline title

Parameters:

title - The new outline title.