de.intarsys.pdf.pd
Class PDAction

java.lang.Object
  de.intarsys.pdf.cos.COSBasedObject
      de.intarsys.pdf.pd.PDObject
          de.intarsys.pdf.pd.PDAction

All Implemented Interfaces:

ICOSObjectListener, IAttributeSupport

Direct Known Subclasses:

PDActionAny, PDActionGoTo, PDActionGoToR, PDActionJavaScript, PDActionLaunch, PDActionNamed, PDActionResetForm, PDActionSubmitForm, PDActionURI

public abstract class PDAction
extends PDObject

A PDF document can be interative by defining actions for different events. This is an abstract superclass for the implementation of the various action types.

Nested Class Summary

static class

PDAction.MetaClass The meta class implementation

Field Summary

static COSName	CN_Type_Action
static COSName	DK_Next
static COSName	DK_S
static PDAction.MetaClass	META The meta class instance

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

DK_Subtype, DK_Type

Method Summary

void	addNext(PDAction action) Add a new PDAction to be executed after this.
COSName	cosGetActionType() The real action type.
abstract COSName	cosGetExpectedActionType() The action type expected for a PDAction of the instantiated class.
List	getNext() The List of PDAction instances that must be executed after this.
void	removeNext(PDAction action) Remove a PDAction from the actions to be executed after 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 PDAction.MetaClass META

The meta class instance

DK_S

public static final COSName DK_S

DK_Next

public static final COSName DK_Next

CN_Type_Action

public static final COSName CN_Type_Action

Method Detail

cosGetExpectedActionType

public abstract COSName cosGetExpectedActionType()

The action type expected for a PDAction of the instantiated class.

Returns:

The action type expected for a PDAction of the instantiated class.

cosGetActionType

public COSName cosGetActionType()

The real action type.

Returns:

The real action type.

getNext

public List getNext()

The List of PDAction instances that must be executed after this.

Returns:

The List of PDAction instances that must be executed after this.

addNext

public void addNext(PDAction action)

Add a new PDAction to be executed after this.

Parameters:

action - The new PDAction

removeNext

public void removeNext(PDAction action)

Remove a PDAction from the actions to be executed after this.

Parameters:

action - The PDAction to be removed