com.livescribe.buttons
Interface Bookmarkable

All Known Implementing Classes:

BookmarkInfo

public interface Bookmarkable

An interface that defines an object as being bookmarkable. A bookmarkable object means that it can have an associated area ID. This is useful, for example, when the menu bookmarking system needs to associate a drawn button with a menu item. The menu item in this case will be bookmarkable.

The menu bookmarking system looks at the currently displaying BrowseList.Item to determine how to activate the bookmark function. An application would therefore use this interface to mark the item as bookmark-capable.

The display name and prompt display may or may not be mutually exclusive. If both are null then the defaults will be used. If both are not null then the prompt display has priority.

Since:

2.3

See Also:

BrowseList.Item

Method Summary

int	getBookmarkAreaId() Gets an unsigned 16-bit area ID for this bookmarkable object.
Displayable	getBookmarkDisplayable() Gets the Displayable object that will be used to prompt the user to draw a button.
String	getBookmarkDisplayName() Gets a string suitable for displaying to the user.
int	getBookmarkZOrder() Gets an unsigned 15-bit Z-order to be used when resolving overlapping conflicts between two bookmarked regions.

Method Detail

getBookmarkAreaId

int getBookmarkAreaId()

Gets an unsigned 16-bit area ID for this bookmarkable object. If this returns a negative value, then the object will not be mapped to any region.

Note that a region having a lower area ID is considered to be "on top of" a region having a higher area ID if the two regions have the same Z-order.

Returns:

an unsigned 16-bit area ID for this object.

See Also:

Region

getBookmarkZOrder

int getBookmarkZOrder()

Gets an unsigned 15-bit Z-order to be used when resolving overlapping conflicts between two bookmarked regions. If this returns a number ≤ zero then the system will choose a Z-order.

Returns:

an unsigned 15-bit Z-order for this object.

getBookmarkDisplayName

String getBookmarkDisplayName()

Gets a string suitable for displaying to the user. This should be localized. If getBookmarkDisplayable() does not return null then it wlil be be used to define what the screen will display instead of the return value from this method.

For the menu bookmarking feature, if this returns null then the localized version of the word "BUTTON" will be used (if getBookmarkDisplayable() returns null).

Returns:

a string suitable for displaying to the user.

See Also:

getBookmarkDisplayable()

getBookmarkDisplayable

Displayable getBookmarkDisplayable()

Gets the Displayable object that will be used to prompt the user to draw a button. If this returns null then a default one will be used. This takes precedence over the value returned by getBookmarkDisplayName().

Returns:

the Displayable to use for the user prompt.

See Also:

ButtonPABDisplay, getBookmarkDisplayName()