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

java.lang.Object
  it.stefanochizzolini.clown.objects.PdfObjectWrapper<PdfDictionary>
      it.stefanochizzolini.clown.documents.interaction.actions.GoToEmbedded.TargetObject

Enclosing class:

GoToEmbedded

public static class GoToEmbedded.TargetObject
extends PdfObjectWrapper<PdfDictionary>

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

Nested Class Summary

static class

GoToEmbedded.TargetObject.RelationEnum Relationship between the target and the current document [PDF:1.6:8.5.3].

Constructor Summary

GoToEmbedded.TargetObject(Document context, GoToEmbedded.TargetObject target)
Creates a new target representing the parent of the document.

GoToEmbedded.TargetObject(Document context, Object annotationPageRef, Object annotationRef, GoToEmbedded.TargetObject target)
Creates a new target associated with a file attachment annotation.

GoToEmbedded.TargetObject(Document context, String embeddedFileName, GoToEmbedded.TargetObject target)
Creates a new target located in the embedded files collection of the document.

Method Summary

GoToEmbedded.TargetObject	clone(Document context) Gets a clone of the object, registered inside the given document context.
Object	getAnnotationPageRef() Gets the page reference to the file attachment annotation.
Object	getAnnotationRef() Gets the reference to the file attachment annotation.
String	getEmbeddedFileName() Gets the embedded file name.
GoToEmbedded.TargetObject.RelationEnum	getRelation() Gets the relationship between the target and the current document.
GoToEmbedded.TargetObject	getTarget() Gets a further path information to the target document.
void	setAnnotationPageRef(Object value)
void	setAnnotationRef(Object value)
void	setEmbeddedFileName(String value)
void	setRelation(GoToEmbedded.TargetObject.RelationEnum value)
void	setTarget(GoToEmbedded.TargetObject value)

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.TargetObject

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

Creates a new target representing the parent of the document.

GoToEmbedded.TargetObject

public GoToEmbedded.TargetObject(Document context,
                                 String embeddedFileName,
                                 GoToEmbedded.TargetObject target)

Creates a new target located in the embedded files collection of the document.

GoToEmbedded.TargetObject

public GoToEmbedded.TargetObject(Document context,
                                 Object annotationPageRef,
                                 Object annotationRef,
                                 GoToEmbedded.TargetObject target)

Creates a new target associated with a file attachment annotation.

Method Detail

clone

public GoToEmbedded.TargetObject clone(Document context)

Description copied from class: PdfObjectWrapper

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

Specified by:

clone in class PdfObjectWrapper<PdfDictionary>

Parameters:

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

getAnnotationPageRef

public Object getAnnotationPageRef()

Gets the page reference to the file attachment annotation.

Returns:

Either the (zero-based) number of the page in the current document containing the file attachment annotation, or the name of a destination in the current document that provides the page number of the file attachment annotation.

getAnnotationRef

public Object getAnnotationRef()

Gets the reference to the file attachment annotation.

Returns:

Either the (zero-based) index of the annotation in the list of annotations associated to the page specified by the annotationPageRef property, or the name of the annotation.

getEmbeddedFileName

public String getEmbeddedFileName()

Gets the embedded file name.

getRelation

public GoToEmbedded.TargetObject.RelationEnum getRelation()

Gets the relationship between the target and the current document.

getTarget

public GoToEmbedded.TargetObject getTarget()

Gets a further path information to the target document.

setAnnotationPageRef

public void setAnnotationPageRef(Object value)

See Also:

getAnnotationPageRef()

setAnnotationRef

public void setAnnotationRef(Object value)

See Also:

getAnnotationRef()

setEmbeddedFileName

public void setEmbeddedFileName(String value)

See Also:

getEmbeddedFileName()

setRelation

public void setRelation(GoToEmbedded.TargetObject.RelationEnum value)

See Also:

getRelation()

setTarget

public void setTarget(GoToEmbedded.TargetObject value)

See Also:

getTarget()