com.livescribe.display
Interface BrowseList.Item

All Known Implementing Classes:

BrowseList.Title, Menu.MenuItem

Enclosing class:

BrowseList

public static interface BrowseList.Item

The Item interface describes an item in a BrowseList. It specifies information necessary for rendering the item.

Method Summary

String	getAudioMimeType() Returns the MIME type of the audio stream.
InputStream	getAudioStream() Returns the audio stream that should be played when this Item has focus.
Image	getIcon() Gets the image that should be displayed when this Item has focus.
Object	getText() Returns the text that should be displayed when this Item has focus.
boolean	isSelectable() Indicates if the item can be selected.

Method Detail

isSelectable

boolean isSelectable()

Indicates if the item can be selected. When the pen user selects this item, your code can perform an action.

Returns:

true if the the item is selectable; otherwise.

getText

Object getText()

Returns the text that should be displayed when this Item has focus.

Returns:

the String text to display or an AttributedText

getIcon

Image getIcon()

Gets the image that should be displayed when this Item has focus.

Returns:

the Image containing the icon; or null if this Item does not support an icon.

getAudioStream

InputStream getAudioStream()

Returns the audio stream that should be played when this Item has focus. Return an InputStream that should be played; or null if no audio should be played.

getAudioMimeType

String getAudioMimeType()

Returns the MIME type of the audio stream.

Returns:

a String with the MIME type; or null if this Item does not support audio. In the case of a String, the allowable MIME types are:

• ResourceBundle.MIME_AUDIO_AAC
• ResourceBundle.MIME_AUDIO_WAV
• ResourceBundle.MIME_AUDIO_WAVPACK
• ResourceBundle.MIME_UNKNOWN