PDF Clown
0.0.8

it.stefanochizzolini.clown.documents.interaction.annotations
Class Link

java.lang.Object
  extended by it.stefanochizzolini.clown.objects.PdfObjectWrapper<PdfDictionary>
      extended by it.stefanochizzolini.clown.documents.interaction.annotations.Annotation
          extended by it.stefanochizzolini.clown.documents.interaction.annotations.Link
All Implemented Interfaces:
ILink

public class Link
extends Annotation
implements ILink

Link annotation [PDF:1.6:8.4.5].

It represents either a hypertext link to a destination elsewhere in the document or an action to be performed.

Since:
0.0.7
Version:
0.0.8
Author:
Stefano Chizzolini (http://www.stefanochizzolini.it)

Nested Class Summary
 
Nested classes/interfaces inherited from class it.stefanochizzolini.clown.documents.interaction.annotations.Annotation
Annotation.FlagsEnum
 
Constructor Summary
Link(Page page, Rectangle2D box, Action action)
           
Link(Page page, Rectangle2D box, Destination destination)
           
Link(PdfDirectObject baseObject, PdfIndirectObject container)
           
 
Method Summary
 Link clone(Document context)
          Gets a clone of the object, registered inside the given document context.
 Destination getDestination()
          Gets the destination to jump to when the link is activated.
 PdfObjectWrapper<?> getTarget()
          Gets the link target (either a Destination or an Action).
 void setAction(Action value)
           
 void setDestination(Destination value)
           
 void setTarget(PdfObjectWrapper<?> value)
           
 
Methods inherited from class it.stefanochizzolini.clown.documents.interaction.annotations.Annotation
getAction, getActions, getAppearance, getBorder, getBox, getFlags, getModificationDate, getName, getPage, getText, isPrintable, isVisible, setActions, setAppearance, setBorder, setBox, setFlags, setModificationDate, setName, setPage, setPrintable, setText, setVisible, 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
 
Methods inherited from interface it.stefanochizzolini.clown.documents.interaction.ILink
getAction
 

Constructor Detail

Link

public Link(Page page,
            Rectangle2D box,
            Destination destination)

Link

public Link(Page page,
            Rectangle2D box,
            Action action)

Link

public Link(PdfDirectObject baseObject,
            PdfIndirectObject container)
Method Detail

clone

public Link clone(Document context)
Description copied from class: PdfObjectWrapper
Gets a clone of the object, registered inside the given document context.

Overrides:
clone in class Annotation
Parameters:
context - Which document the clone has to be registered in.

getDestination

public Destination getDestination()
Description copied from interface: ILink
Gets the destination to jump to when the link is activated.

Specified by:
getDestination in interface ILink

getTarget

public PdfObjectWrapper<?> getTarget()
Description copied from interface: ILink
Gets the link target (either a Destination or an Action).

Specified by:
getTarget in interface ILink

setAction

public void setAction(Action value)
Specified by:
setAction in interface ILink
Overrides:
setAction in class Annotation
See Also:
Annotation.getAction()

setDestination

public void setDestination(Destination value)
Specified by:
setDestination in interface ILink
See Also:
getDestination()

setTarget

public void setTarget(PdfObjectWrapper<?> value)
Specified by:
setTarget in interface ILink
See Also:
ILink.getTarget()

PDF Clown
0.0.8

Project home page

Copyright © 2006-2010 Stefano Chizzolini. Some Rights Reserved.
This documentation is available under the terms of the GNU Free Documentation License.