com.itextpdf.kernel.pdf.action

Class PdfAction

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.action.PdfAction

All Implemented Interfaces:

Serializable

public class PdfAction
extends PdfObjectWrapper<PdfDictionary>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	RESET_EXCLUDE a possible submitvalue
static int	SUBMIT_CANONICAL_FORMAT a possible submitvalue
static int	SUBMIT_COORDINATES a possible submitvalue
static int	SUBMIT_EMBED_FORM a possible submitvalue
static int	SUBMIT_EXCL_F_KEY a possible submitvalue
static int	SUBMIT_EXCL_NON_USER_ANNOTS a possible submitvalue
static int	SUBMIT_EXCLUDE a possible submitvalue
static int	SUBMIT_HTML_FORMAT a possible submitvalue
static int	SUBMIT_HTML_GET a possible submitvalue
static int	SUBMIT_INCLUDE_ANNOTATIONS a possible submitvalue
static int	SUBMIT_INCLUDE_APPEND_SAVES a possible submitvalue
static int	SUBMIT_INCLUDE_NO_VALUE_FIELDS a possible submitvalue
static int	SUBMIT_PDF a possible submitvalue
static int	SUBMIT_XFDF a possible submitvalue

Constructor Summary

Constructors

Constructor and Description
PdfAction()
PdfAction(PdfDictionary pdfObject)

Method Summary

Modifier and Type	Method and Description
static PdfAction	createGoTo(PdfDestination destination)
static PdfAction	createGoTo(String destination)
static PdfAction	createGoToE(PdfDestination destination, boolean newWindow, PdfTargetDictionary targetDictionary)
static PdfAction	createGoToE(PdfFileSpec fileSpec, PdfDestination destination, boolean newWindow, PdfTargetDictionary targetDictionary)
static PdfAction	createGoToR(PdfFileSpec fileSpec, PdfDestination destination)
static PdfAction	createGoToR(PdfFileSpec fileSpec, PdfDestination destination, boolean newWindow)
static PdfAction	createGoToR(String filename, int pageNum)
static PdfAction	createGoToR(String filename, int pageNum, boolean newWindow)
static PdfAction	createGoToR(String filename, String destination)
static PdfAction	createGoToR(String filename, String destination, boolean newWindow)
static PdfAction	createHide(PdfAnnotation[] annotations, boolean hidden)
static PdfAction	createHide(PdfAnnotation annotation, boolean hidden)
static PdfAction	createHide(String[] text, boolean hidden)
static PdfAction	createHide(String text, boolean hidden)
static PdfAction	createJavaScript(String javaScript)
static PdfAction	createLaunch(PdfFileSpec fileSpec)
static PdfAction	createLaunch(PdfFileSpec fileSpec, boolean newWindow)
static PdfAction	createLaunch(PdfFileSpec fileSpec, PdfWin win, boolean newWindow)
static PdfAction	createMovie(PdfAnnotation annotation, String title, PdfName operation)
static PdfAction	createNamed(PdfName namedAction)
static PdfAction	createRendition(String file, PdfFileSpec fileSpec, String mimeType, PdfAnnotation screenAnnotation)
static PdfAction	createResetForm(Object[] names, int flags)
static PdfAction	createSetOcgState(List<PdfActionOcgState> states)
static PdfAction	createSetOcgState(List<PdfActionOcgState> states, boolean preserveRb)
static PdfAction	createSound(PdfStream sound)
static PdfAction	createSound(PdfStream sound, float volume, boolean synchronous, boolean repeat, boolean mix)
static PdfAction	createSubmitForm(String file, Object[] names, int flags)
static PdfAction	createThread(PdfFileSpec fileSpec)
static PdfAction	createThread(PdfFileSpec fileSpec, PdfObject destinationThread, PdfObject bead)
static PdfAction	createURI(String uri)
static PdfAction	createURI(String uri, boolean isMap)
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
void	next(PdfAction na) Add a chained action.
PdfAction	put(PdfName key, PdfObject value)
static void	setAdditionalAction(PdfObjectWrapper<PdfDictionary> wrapper, PdfName key, PdfAction action)

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBMIT_EXCLUDE

public static final int SUBMIT_EXCLUDE

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_INCLUDE_NO_VALUE_FIELDS

public static final int SUBMIT_INCLUDE_NO_VALUE_FIELDS

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_HTML_FORMAT

public static final int SUBMIT_HTML_FORMAT

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_HTML_GET

public static final int SUBMIT_HTML_GET

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_COORDINATES

public static final int SUBMIT_COORDINATES

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_XFDF

public static final int SUBMIT_XFDF

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_INCLUDE_APPEND_SAVES

public static final int SUBMIT_INCLUDE_APPEND_SAVES

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_INCLUDE_ANNOTATIONS

public static final int SUBMIT_INCLUDE_ANNOTATIONS

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_PDF

public static final int SUBMIT_PDF

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_CANONICAL_FORMAT

public static final int SUBMIT_CANONICAL_FORMAT

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_EXCL_NON_USER_ANNOTS

public static final int SUBMIT_EXCL_NON_USER_ANNOTS

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_EXCL_F_KEY

public static final int SUBMIT_EXCL_F_KEY

a possible submitvalue

See Also:

Constant Field Values

SUBMIT_EMBED_FORM

public static final int SUBMIT_EMBED_FORM

a possible submitvalue

See Also:

Constant Field Values

RESET_EXCLUDE

public static final int RESET_EXCLUDE

a possible submitvalue

See Also:

Constant Field Values

Constructor Detail

PdfAction

public PdfAction()

PdfAction

public PdfAction(PdfDictionary pdfObject)

Method Detail

createGoTo

public static PdfAction createGoTo(PdfDestination destination)

createGoTo

public static PdfAction createGoTo(String destination)

createGoToR

public static PdfAction createGoToR(PdfFileSpec fileSpec,
                                    PdfDestination destination,
                                    boolean newWindow)

createGoToR

public static PdfAction createGoToR(PdfFileSpec fileSpec,
                                    PdfDestination destination)

createGoToR

public static PdfAction createGoToR(String filename,
                                    int pageNum)

createGoToR

public static PdfAction createGoToR(String filename,
                                    int pageNum,
                                    boolean newWindow)

createGoToR

public static PdfAction createGoToR(String filename,
                                    String destination,
                                    boolean newWindow)

createGoToR

public static PdfAction createGoToR(String filename,
                                    String destination)

createGoToE

public static PdfAction createGoToE(PdfDestination destination,
                                    boolean newWindow,
                                    PdfTargetDictionary targetDictionary)

createGoToE

public static PdfAction createGoToE(PdfFileSpec fileSpec,
                                    PdfDestination destination,
                                    boolean newWindow,
                                    PdfTargetDictionary targetDictionary)

createLaunch

public static PdfAction createLaunch(PdfFileSpec fileSpec,
                                     boolean newWindow)

createLaunch

public static PdfAction createLaunch(PdfFileSpec fileSpec)

createLaunch

public static PdfAction createLaunch(PdfFileSpec fileSpec,
                                     PdfWin win,
                                     boolean newWindow)

createThread

public static PdfAction createThread(PdfFileSpec fileSpec,
                                     PdfObject destinationThread,
                                     PdfObject bead)

createThread

public static PdfAction createThread(PdfFileSpec fileSpec)

createURI

public static PdfAction createURI(String uri)

createURI

public static PdfAction createURI(String uri,
                                  boolean isMap)

createSound

public static PdfAction createSound(PdfStream sound)

createSound

public static PdfAction createSound(PdfStream sound,
                                    float volume,
                                    boolean synchronous,
                                    boolean repeat,
                                    boolean mix)

createMovie

public static PdfAction createMovie(PdfAnnotation annotation,
                                    String title,
                                    PdfName operation)

createHide

public static PdfAction createHide(PdfAnnotation annotation,
                                   boolean hidden)

createHide

public static PdfAction createHide(PdfAnnotation[] annotations,
                                   boolean hidden)

createHide

public static PdfAction createHide(String text,
                                   boolean hidden)

createHide

public static PdfAction createHide(String[] text,
                                   boolean hidden)

createNamed

public static PdfAction createNamed(PdfName namedAction)

createSetOcgState

public static PdfAction createSetOcgState(List<PdfActionOcgState> states)

createSetOcgState

public static PdfAction createSetOcgState(List<PdfActionOcgState> states,
                                          boolean preserveRb)

createRendition

public static PdfAction createRendition(String file,
                                        PdfFileSpec fileSpec,
                                        String mimeType,
                                        PdfAnnotation screenAnnotation)

createJavaScript

public static PdfAction createJavaScript(String javaScript)

createSubmitForm

public static PdfAction createSubmitForm(String file,
                                         Object[] names,
                                         int flags)

createResetForm

public static PdfAction createResetForm(Object[] names,
                                        int flags)

setAdditionalAction

public static void setAdditionalAction(PdfObjectWrapper<PdfDictionary> wrapper,
                                       PdfName key,
                                       PdfAction action)

next

public void next(PdfAction na)

Add a chained action.

Parameters:

na -

put

public PdfAction put(PdfName key,
                     PdfObject value)

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Description copied from class: PdfObjectWrapper

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Specified by:

isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.