Package org.apache.fop.render.intermediate.extensions

Class Bookmark

java.lang.Object
org.apache.fop.render.intermediate.extensions.Bookmark
public class Bookmark extends Object
This class is a bookmark element for use in the intermediate format.

  • Constructor Details

    • Bookmark

      public Bookmark(String title, boolean show, AbstractAction action)
      Creates a new bookmark.
      Parameters:
      title - the bookmark's title
      show - true if the bookmark shall be shown, false for hidden
      action - the action performed when the bookmark is clicked

  • Method Details

    • getTitle

      public 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 List getChildBookmarks()
      Returns a list of child bookmarks.
      Returns:
      the child bookmarks