com.cete.dynamicpdf.pageelements
Class Bookmark

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.Bookmark

All Implemented Interfaces:

ICoordinate

public class Bookmark
extends PageElement
implements ICoordinate

This class can be used to place bookmarks on the PDF document. These bookmarks will be displayed to the right of the PDF document. See the Outlines topic for more details on bookmarks.

NOTE: This page element cannot be used within a table cell, or tranformation group.

Licensing:
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Professional Edition
• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

Bookmark(java.lang.String text, float x, float y)
Creates a new instance of Bookmark class.

Bookmark(java.lang.String text, float x, float y, Outline parentOutline)
Creates a new instance of Bookmark class.

Method Summary

void	draw(PageWriter writer) Draws the bookmark to the given PageWriter object.
RgbColor	getColor() Gets the RgbColor object to use for the text of the bookmark.
Outline	getParentOutline() Gets the Outline object the bookmark will appear under.
TextStyle	getStyle() Gets the TextStyle enumeration that represents the text style of the bookmark.
java.lang.String	getText() Gets the text of the bookmark.
float	getX() Gets the X coordinate of the bookmark.
float	getY() Gets the Y coordinate of the bookmark.
void	setColor(RgbColor value) Sets the RgbColor object to use for the text of the bookmark.
void	setParentOutline(Outline value) Sets the Outline object the bookmark will appear under.
void	setStyle(TextStyle value) Sets the TextStyle enumeration that represents the text style of the bookmark.
void	setText(java.lang.String value) Sets the text of the bookmark.
void	setX(float value) Sets the X coordinate of the bookmark.
void	setY(float value) Sets the Y coordinate of the bookmark.

Methods inherited from class com.cete.dynamicpdf.PageElement

getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

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

Constructor Detail

Bookmark

public Bookmark(java.lang.String text,
                float x,
                float y)

Creates a new instance of Bookmark class.

Parameters:

text - Text of the bookmark.

x - X coordinate of the bookmark.

y - Y coordinate of the bookmark.

Bookmark

public Bookmark(java.lang.String text,
                float x,
                float y,
                Outline parentOutline)

Creates a new instance of Bookmark class.

Parameters:

text - Text of the bookmark.

x - X coordinate of the bookmark.

y - Y coordinate of the bookmark.

parentOutline - Outline object that the bookmark will appear under.

See Also:

Outline

Method Detail

getText

public java.lang.String getText()

Gets the text of the bookmark.

Returns:

the text of the bookmark.

getX

public float getX()

Gets the X coordinate of the bookmark.

Specified by:

getX in interface ICoordinate

Returns:

the X coordinate of the bookmark.

getY

public float getY()

Gets the Y coordinate of the bookmark.

Specified by:

getY in interface ICoordinate

Returns:

the Y coordinate of the bookmark.

getStyle

public TextStyle getStyle()

Gets the TextStyle enumeration that represents the text style of the bookmark.

Returns:

the text style of the book mark.

See Also:

TextStyle

getParentOutline

public Outline getParentOutline()

Gets the Outline object the bookmark will appear under.

Returns:

the outline of the bookmark.

See Also:

Outline

getColor

public RgbColor getColor()

Gets the RgbColor object to use for the text of the bookmark.

Returns:

the color of the bookmark.

See Also:

RgbColor

setText

public void setText(java.lang.String value)

Sets the text of the bookmark.

Parameters:

value - the text of the bookmark.

setX

public void setX(float value)

Sets the X coordinate of the bookmark.

Specified by:

setX in interface ICoordinate

Parameters:

value - the X coordinate of the bookmark.

setY

public void setY(float value)

Sets the Y coordinate of the bookmark.

Specified by:

setY in interface ICoordinate

Parameters:

value - the Y coordinate of the bookmark.

setStyle

public void setStyle(TextStyle value)

Sets the TextStyle enumeration that represents the text style of the bookmark.

Parameters:

value - the text style of the bookmark.

See Also:

TextStyle

setParentOutline

public void setParentOutline(Outline value)

Sets the Outline object the bookmark will appear under.

Parameters:

value - the outline of the bookmark.

See Also:

Outline

setColor

public void setColor(RgbColor value)

Sets the RgbColor object to use for the text of the bookmark.

Parameters:

value - the color of the bookmark.

See Also:

RgbColor

draw

public void draw(PageWriter writer)

Draws the bookmark to the given PageWriter object.

Specified by:

draw in class PageElement

Parameters:

writer - PageWriter object to receive the bookmark's output.

See Also:

PageWriter