com.livescribe.display
Class BrowseList.Title

java.lang.Object
  com.livescribe.display.BrowseList.Title

All Implemented Interfaces:

BrowseList.Item

Enclosing class:

BrowseList

public static class BrowseList.Title
extends Object
implements BrowseList.Item

Title encapsulates the title for a browse list. It has the same attributes as a BrowseList.Item except that it cannot be selectable.

Field Summary

static Image

DEFAULT_TITLE_ICON

Constructor Summary

BrowseList.Title(String text, Image icon)
Constructs a Title with the text and icon passed.

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() Returns the icon for the title.
Object	getText() Returns the text for the title.
boolean	isSelectable() Indicates if the item can be selected.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TITLE_ICON

public static final Image DEFAULT_TITLE_ICON

Constructor Detail

BrowseList.Title

public BrowseList.Title(String text,
                        Image icon)

Constructs a Title with the text and icon passed.

Parameters:

text - a String to be used for the title.

icon - an Image to be used for the title icon.

Method Detail

getText

public Object getText()

Returns the text for the title.

Specified by:

getText in interface BrowseList.Item

Returns:

a String title text.

getIcon

public Image getIcon()

Returns the icon for the title.

Specified by:

getIcon in interface BrowseList.Item

Returns:

the Image used for the title's icon; or null if the title does not support an icon.

isSelectable

public final boolean isSelectable()

Description copied from interface: BrowseList.Item

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

Specified by:

isSelectable in interface BrowseList.Item

Returns:

true if the the item is selectable; otherwise.

getAudioStream

public InputStream getAudioStream()

Description copied from interface: BrowseList.Item

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.

Specified by:

getAudioStream in interface BrowseList.Item

getAudioMimeType

public String getAudioMimeType()

Description copied from interface: BrowseList.Item

Returns the MIME type of the audio stream.

Specified by:

getAudioMimeType in interface BrowseList.Item

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