com.livescribe.buttons
Class BookmarkInfo

java.lang.Object
  com.livescribe.buttons.BookmarkInfo

All Implemented Interfaces:

Bookmarkable

public class BookmarkInfo
extends Object
implements Bookmarkable

This is a convenience class that allows the creation of bookmark information without having to implement the interface yourself.

Since:

2.3

Field Summary

protected Displayable	displayable The Displayable to use for the user prompt.
protected int	id The area ID.
protected String	name The localized display name.
protected int	zOrder The Z-order.

Constructor Summary

BookmarkInfo(int id, Displayable d)
Creates new bookmark information having the specified values.

BookmarkInfo(int id, String name)
Creates new bookmark information having the specified values.

Method Summary

int	getBookmarkAreaId() Gets the area ID.
Displayable	getBookmarkDisplayable() This returns null for the default displayable.
String	getBookmarkDisplayName() Gets the displayable name.
int	getBookmarkZOrder() Gets the Z-order value.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected int id

The area ID.

zOrder

protected int zOrder

The Z-order.

name

protected String name

The localized display name.

displayable

protected Displayable displayable

The Displayable to use for the user prompt.

Constructor Detail

BookmarkInfo

public BookmarkInfo(int id,
                    String name)

Creates new bookmark information having the specified values. The Z-order value is set to zero and the displayable is set to null.

Parameters:

id - the area ID

name - the display name

BookmarkInfo

public BookmarkInfo(int id,
                    Displayable d)

Creates new bookmark information having the specified values. The Z-order value is set to zero and the name is set to null.

Parameters:

id - the area ID

d - the Displayable for the user prompt

Method Detail

getBookmarkAreaId

public int getBookmarkAreaId()

Gets the area ID.

Specified by:

getBookmarkAreaId in interface Bookmarkable

Returns:

the area ID.

See Also:

Region

getBookmarkZOrder

public int getBookmarkZOrder()

Gets the Z-order value.

Specified by:

getBookmarkZOrder in interface Bookmarkable

Returns:

the Z-order value.

getBookmarkDisplayName

public String getBookmarkDisplayName()

Gets the displayable name.

Specified by:

getBookmarkDisplayName in interface Bookmarkable

Returns:

the displayable name.

See Also:

Bookmarkable.getBookmarkDisplayable()

getBookmarkDisplayable

public Displayable getBookmarkDisplayable()

This returns null for the default displayable.

Specified by:

getBookmarkDisplayable in interface Bookmarkable

Returns:

null.

See Also:

ButtonPABDisplay, Bookmarkable.getBookmarkDisplayName()