org.foray.area
Class BookmarkArea

java.lang.Object
  org.foray.area.BookmarkParentArea
      org.foray.area.BookmarkArea

All Implemented Interfaces:

org.axsl.galley.Bookmark

public final class BookmarkArea
extends BookmarkParentArea
implements org.axsl.galley.Bookmark

The AreaTree representation of an fo:bookmark object.

Method Summary

protected void	addBookmarkAreaChild(BookmarkArea bookmarkArea) Adds a bookmark area as a child.
BookmarkTitleArea	getBookmarkTitle() Return the bookmark title for this bookmark.
List<BookmarkArea>	getChildren()
String	getDestination()
BookmarkParentArea	getParent() Returns the parent of this bookmark.
String	getTitleText()
protected void	layoutBookmarkTitle(org.axsl.fo.fo.BookmarkTitle bookmarkTitle) Lays out a bookmark title.
void	makeChildren(org.axsl.fo.fo.Bookmark bookmark) Creates the child areas for this bookmark area.
Color	traitColor()
org.axsl.font.Font.Style	traitFontStyle()
org.axsl.font.Font.Weight	traitFontWeight()
org.axsl.fo.fo.Bookmark	traitGeneratedBy() Returns the FO Tree bookmark node that created this.

Methods inherited from class org.foray.area.BookmarkParentArea

makeBookmarkArea

Methods inherited from class java.lang.Object

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

Method Detail

getBookmarkTitle

public BookmarkTitleArea getBookmarkTitle()

Return the bookmark title for this bookmark.

Returns:

The bookmark title for this bookmark.

layoutBookmarkTitle

protected void layoutBookmarkTitle(org.axsl.fo.fo.BookmarkTitle bookmarkTitle)

Lays out a bookmark title.

Parameters:

bookmarkTitle - The bookmark title to be laid out.

getChildren

public List<BookmarkArea> getChildren()

Specified by:

getChildren in interface org.axsl.galley.Bookmark

makeChildren

public void makeChildren(org.axsl.fo.fo.Bookmark bookmark)

Creates the child areas for this bookmark area.

Parameters:

bookmark - The "generated-by" Bookmark.

addBookmarkAreaChild

protected void addBookmarkAreaChild(BookmarkArea bookmarkArea)

Description copied from class: BookmarkParentArea

Adds a bookmark area as a child.

Specified by:

addBookmarkAreaChild in class BookmarkParentArea

Parameters:

bookmarkArea - The bookmark area to be added.

traitGeneratedBy

public org.axsl.fo.fo.Bookmark traitGeneratedBy()

Returns the FO Tree bookmark node that created this.

Returns:

The FO Tree bookmark.

getDestination

public String getDestination()

Specified by:

getDestination in interface org.axsl.galley.Bookmark

getTitleText

public String getTitleText()

Specified by:

getTitleText in interface org.axsl.galley.Bookmark

traitColor

public Color traitColor()

Specified by:

traitColor in interface org.axsl.galley.Bookmark

traitFontWeight

public org.axsl.font.Font.Weight traitFontWeight()

Specified by:

traitFontWeight in interface org.axsl.galley.Bookmark

traitFontStyle

public org.axsl.font.Font.Style traitFontStyle()

Specified by:

traitFontStyle in interface org.axsl.galley.Bookmark

getParent

public BookmarkParentArea getParent()

Returns the parent of this bookmark.

Returns:

The parent of this bookmark.