Class Bookmark
- java.lang.Object
-
- org.apache.fop.render.intermediate.extensions.Bookmark
-
public class Bookmark extends java.lang.Object
This class is a bookmark element for use in the intermediate format.
-
-
Field Summary
Fields Modifier and Type Field Description private AbstractAction
action
private java.util.List
childBookmarks
private boolean
show
private java.lang.String
title
-
Constructor Summary
Constructors Constructor Description Bookmark(java.lang.String title, boolean show, AbstractAction action)
Creates a new bookmark.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChildBookmark(Bookmark bookmark)
Adds a child bookmark.AbstractAction
getAction()
Returns the action performed when the bookmark is clicked.java.util.List
getChildBookmarks()
Returns a list of child bookmarks.java.lang.String
getTitle()
Returns the bookmark's title.boolean
isShown()
Indicates whether the bookmark shall be shown initially.void
setAction(AbstractAction action)
Sets the action performed when the bookmark is clicked.
-
-
-
Field Detail
-
title
private java.lang.String title
-
show
private boolean show
-
childBookmarks
private java.util.List childBookmarks
-
action
private AbstractAction action
-
-
Constructor Detail
-
Bookmark
public Bookmark(java.lang.String title, boolean show, AbstractAction action)
Creates a new bookmark.- Parameters:
title
- the bookmark's titleshow
- true if the bookmark shall be shown, false for hiddenaction
- the action performed when the bookmark is clicked
-
-
Method Detail
-
getTitle
public java.lang.String getTitle()
Returns the bookmark's title.- Returns:
- the title
-
isShown
public boolean isShown()
Indicates whether the bookmark shall be shown initially.- Returns:
- true if it shall be shown
-
getAction
public AbstractAction getAction()
Returns the action performed when the bookmark is clicked.- Returns:
- the action
-
setAction
public void setAction(AbstractAction action)
Sets the action performed when the bookmark is clicked.- Parameters:
action
- the action
-
addChildBookmark
public void addChildBookmark(Bookmark bookmark)
Adds a child bookmark.- Parameters:
bookmark
- the child bookmark
-
getChildBookmarks
public java.util.List getChildBookmarks()
Returns a list of child bookmarks.- Returns:
- the child bookmarks
-
-