com.cete.dynamicpdf
Class Outline

java.lang.Object
  com.cete.dynamicpdf.Outline

public class Outline
extends java.lang.Object

See the Outlines and Bookmarks topic for more on Outlines.

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

protected

Outline(boolean expanded, TextStyle style, Action action) Initializes a new instance of the Outline class.

Method Summary

OutlineList	getChildOutlines() Gets a collection or child outlines.
RgbColor	getColor() Gets the color of the outline.
boolean	getIsExpanded() Gets a value specifying if the outline is expanded.
OutlineList	getParent() Gets the parent of the outline.
TextStyle	getStyle() Gets the style of the outline.
java.lang.String	getText() Gets the text of the outline.
protected void	init(OutlineList parentOutline, int index)
void	setColor(RgbColor value) Sets the color of the outline.
void	setIsExpanded(boolean value) Sets a value specifying if the outline is expanded.
void	setStyle(TextStyle value) Sets the style of the outline.
void	setText(java.lang.String value) Sets the text of the outline.

Methods inherited from class java.lang.Object

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

Constructor Detail

Outline

protected Outline(boolean expanded,
                  TextStyle style,
                  Action action)

Initializes a new instance of the Outline class.

Parameters:

expanded - Specifies if the outline will be expanded.

style - Style of the outline.

action - Action of the outline.

Method Detail

setText

public void setText(java.lang.String value)

Sets the text of the outline.

Parameters:

value - the text of the outline.

getText

public java.lang.String getText()

Gets the text of the outline.

Returns:

the text of the outline.

setStyle

public void setStyle(TextStyle value)

Sets the style of the outline.

Parameters:

value - the style of the outline.

getStyle

public TextStyle getStyle()

Gets the style of the outline.

Returns:

the style of the outline.

setColor

public void setColor(RgbColor value)

Sets the color of the outline.

Parameters:

value - the color of the outline.

getColor

public RgbColor getColor()

Gets the color of the outline.

Returns:

the color of the outline.

getParent

public OutlineList getParent()

Gets the parent of the outline.

Returns:

the parent of the outline.

getChildOutlines

public OutlineList getChildOutlines()

Gets a collection or child outlines.

Returns:

a collection or child outlines.

setIsExpanded

public void setIsExpanded(boolean value)

Sets a value specifying if the outline is expanded.

Parameters:

value - a value specifying if the outline is expanded.

getIsExpanded

public boolean getIsExpanded()

Gets a value specifying if the outline is expanded.

Returns:

value indicating if the outline is expanded.

init

protected void init(OutlineList parentOutline,
                    int index)