it.stefanochizzolini.clown.documents.interaction.actions
Class GoToEmbedded

java.lang.Object
  it.stefanochizzolini.clown.objects.PdfObjectWrapper<PdfDictionary>
      it.stefanochizzolini.clown.documents.interaction.actions.Action
          it.stefanochizzolini.clown.documents.interaction.actions.GoToDestination<T>
              it.stefanochizzolini.clown.documents.interaction.actions.GoToNonLocal<Destination>
                  it.stefanochizzolini.clown.documents.interaction.actions.GoToEmbedded

All Implemented Interfaces:

IGoToAction

public class GoToEmbedded
extends GoToNonLocal<Destination>

'Change the view to a specified destination in a PDF file embedded in another PDF file' action [PDF:1.6:8.5.3].

Since:

0.0.7

Version:

0.0.8

Author:

Stefano Chizzolini (http://www.stefanochizzolini.it)

Nested Class Summary

static class

GoToEmbedded.TargetObject Path information to the target document [PDF:1.6:8.5.3].

Constructor Summary

GoToEmbedded(Document context, FileSpec fileSpec, Destination destination)
Creates a new embedded-goto action within the given document context, pointing to a destination within another document.

GoToEmbedded(Document context, FileSpec fileSpec, GoToEmbedded.TargetObject target, Destination destination)
Creates a new embedded-goto action within the given document context.

GoToEmbedded(Document context, GoToEmbedded.TargetObject target, Destination destination)
Creates a new embedded-goto action within the given document context, pointing to a destination within a target document embedded within the same document.

Method Summary

GoToEmbedded	clone(Document context) Gets a clone of the object, registered inside the given document context.
protected Class<Destination>	getDestinationClass()
EnumSet<OptionsEnum>	getOptions() Gets the action options.
GoToEmbedded.TargetObject	getTarget() Gets the path information to the target document.
void	setOptions(EnumSet<OptionsEnum> value)
void	setTarget(GoToEmbedded.TargetObject value)

Methods inherited from class it.stefanochizzolini.clown.documents.interaction.actions.GoToNonLocal

getFileSpec, setFileSpec

Methods inherited from class it.stefanochizzolini.clown.documents.interaction.actions.GoToDestination

getDestination, setDestination

Methods inherited from class it.stefanochizzolini.clown.documents.interaction.actions.Action

getActions, setActions, wrap, wrap

Methods inherited from class it.stefanochizzolini.clown.objects.PdfObjectWrapper

delete, getBaseDataObject, getBaseObject, getContainer, getDocument, getFile, setBaseObject, setContainer, update

Methods inherited from class java.lang.Object

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

Constructor Detail

GoToEmbedded

public GoToEmbedded(Document context,
                    GoToEmbedded.TargetObject target,
                    Destination destination)

Creates a new embedded-goto action within the given document context, pointing to a destination within a target document embedded within the same document.

GoToEmbedded

public GoToEmbedded(Document context,
                    FileSpec fileSpec,
                    Destination destination)

Creates a new embedded-goto action within the given document context, pointing to a destination within another document.

GoToEmbedded

public GoToEmbedded(Document context,
                    FileSpec fileSpec,
                    GoToEmbedded.TargetObject target,
                    Destination destination)

Creates a new embedded-goto action within the given document context.

Method Detail

clone

public GoToEmbedded clone(Document context)

Description copied from class: PdfObjectWrapper

Gets a clone of the object, registered inside the given document context.

Overrides:

clone in class Action

Parameters:

context - Which document the clone has to be registered in.

getOptions

public EnumSet<OptionsEnum> getOptions()

Gets the action options.

getTarget

public GoToEmbedded.TargetObject getTarget()

Gets the path information to the target document.

setOptions

public void setOptions(EnumSet<OptionsEnum> value)

See Also:

getOptions()

setTarget

public void setTarget(GoToEmbedded.TargetObject value)

See Also:

getTarget()

getDestinationClass

protected Class<Destination> getDestinationClass()

Specified by:

getDestinationClass in class GoToDestination<Destination>