org.pdfclown.documents.interaction.navigation.document
Class Bookmark

java.lang.Object
  org.pdfclown.objects.PdfObjectWrapper<PdfDictionary>
      org.pdfclown.documents.interaction.navigation.document.Bookmark

All Implemented Interfaces:

Cloneable, ILink, IPdfObjectWrapper

@PDF(value=PDF10)
public final class Bookmark
extends PdfObjectWrapper<PdfDictionary>
implements ILink

Outline item [PDF:1.6:8.2.2].

Version:

0.1.2, 12/21/12

Author:

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

Nested Class Summary

static class

Bookmark.FlagsEnum Bookmark flags [PDF:1.6:8.2.2].

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.
Bookmarks	getBookmarks() Gets the child bookmarks.
DeviceRGBColor	getColor() Gets the bookmark text color.
EnumSet<Bookmark.FlagsEnum>	getFlags() Gets the bookmark flags.
Bookmark	getParent() Gets the parent bookmark.
PdfObjectWrapper<?>	getTarget() Gets the link target.
String	getTitle() Gets the text to be displayed for this bookmark.
boolean	isExpanded() Gets whether this bookmark's children are displayed.
void	setColor(DeviceRGBColor value)
void	setExpanded(boolean value)
void	setFlags(EnumSet<Bookmark.FlagsEnum> value)
void	setTarget(PdfObjectWrapper<?> value)
void	setTitle(String value)

Methods inherited from class org.pdfclown.objects.PdfObjectWrapper

checkCompatibility, delete, equals, exists, getBaseDataObject, getBaseObject, getBaseObject, getContainer, getDataContainer, getDocument, getFile, getMetadata, retrieveName, retrieveNamedBaseObject, setBaseObject, setMetadata

Methods inherited from class java.lang.Object

clone, 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.

Overrides:

clone in class PdfObjectWrapper<PdfDictionary>

Parameters:

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

getBookmarks

public Bookmarks getBookmarks()

Gets the child bookmarks.

getColor

@PDF(value=PDF14)
public DeviceRGBColor getColor()

Gets the bookmark text color.

Since:

0.1.0

getFlags

@PDF(value=PDF14)
public EnumSet<Bookmark.FlagsEnum> getFlags()

Gets the bookmark flags.

Since:

0.1.0

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.

setColor

public void setColor(DeviceRGBColor value)

See Also:

getColor()

setExpanded

public void setExpanded(boolean value)

See Also:

isExpanded()

setFlags

public void setFlags(EnumSet<Bookmark.FlagsEnum> value)

See Also:

getFlags()

setTitle

public void setTitle(String value)

See Also:

getTitle()

getTarget

public PdfObjectWrapper<?> getTarget()

Description copied from interface: ILink

Gets the link target.

Specified by:

getTarget in interface ILink

Returns:

Either a Destination or an Action.

setTarget

public void setTarget(PdfObjectWrapper<?> value)

Specified by:

setTarget in interface ILink

See Also:

ILink.getTarget()