it.stefanochizzolini.clown.documents.interaction.navigation.document
Class Bookmark

java.lang.Object
  it.stefanochizzolini.clown.objects.PdfObjectWrapper<PdfDictionary>
      it.stefanochizzolini.clown.documents.interaction.navigation.document.Bookmark

All Implemented Interfaces:

ILink

public class Bookmark
extends PdfObjectWrapper<PdfDictionary>
implements ILink

Outline item [PDF:1.6:8.2.2].

Version:

0.0.8

Author:

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

Constructor Summary

Bookmark(Document context, String title)

Bookmark(Document context, String title, Action action)

Bookmark(Document context, String title, LocalDestination destination)

Method Summary

Bookmark	clone(Document context) Gets a clone of the object, registered inside the given document context.
Action	getAction() Gets the action to be performed when the link is activated.
Bookmarks	getBookmarks() Gets the child bookmarks.
Destination	getDestination() Gets the destination to jump to when the link is activated.
Bookmark	getParent() Gets the parent bookmark.
PdfObjectWrapper<?>	getTarget() Gets the link target (either a Destination or an Action).
String	getTitle() Gets the text to be displayed for this bookmark.
boolean	isExpanded() Gets whether this bookmark's children are displayed.
void	setAction(Action value)
void	setDestination(Destination value)
void	setExpanded(boolean value)
void	setTarget(PdfObjectWrapper<?> value)
void	setTitle(String 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

Bookmark

public Bookmark(Document context,
                String title)

Bookmark

public Bookmark(Document context,
                String title,
                LocalDestination destination)

Bookmark

public Bookmark(Document context,
                String title,
                Action action)

Method Detail

clone

public Bookmark 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.

getBookmarks

public Bookmarks getBookmarks()

Gets the child bookmarks.

getParent

public Bookmark getParent()

Gets the parent bookmark.

getTitle

public String getTitle()

Gets the text to be displayed for this bookmark.

isExpanded

public boolean isExpanded()

Gets whether this bookmark's children are displayed.

setExpanded

public void setExpanded(boolean value)

See Also:

isExpanded()

setTitle

public void setTitle(String value)

See Also:

getTitle()

getAction

public Action getAction()

Description copied from interface: ILink

Gets the action to be performed when the link is activated.

Specified by:

getAction in interface ILink

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

See Also:

ILink.getAction()

setDestination

public void setDestination(Destination value)

Specified by:

setDestination in interface ILink

See Also:

ILink.getDestination()

setTarget

public void setTarget(PdfObjectWrapper<?> value)

Specified by:

setTarget in interface ILink

See Also:

ILink.getTarget()