com.blackledge.david.tivo.multitasker
Interface LocalOptionProvider

All Known Implementing Classes:

AudioArtBackgroundImage, ClockBrand, GenericAudio, GenericBackgroundImage, GenericImageBrand, LocalAudio, LocalStreamedBackgroundImage, MultiTaskerApplication, PictureInPicture, RSSTicker, SampleMultitaskerApp, TivoFreeCellMulti, TivoSolitaireMulti, WeatherMultitaskerApp

public interface LocalOptionProvider

Implement this interface with each of your plugins (BackgroundImage, Audio, or TickerTape) that you also want to have their own options that work nicely with the option system

Version:

$Revision: 1.1 $

Field Summary

static String	TYPE_BOOLEAN
static String	TYPE_CLASS
static String	TYPE_COLOR
static String	TYPE_FILE
static String	TYPE_FLOAT
static String	TYPE_FOLDER
static String	TYPE_IMAGE FUTURE - just Url alias for now.
static String	TYPE_INTEGER
static String	TYPE_STRING
static String	TYPE_URL

Method Summary

String	getLocalOptionDefault(String key) defaults for each of the local option keys.
Collection	getLocalOptionNames() Your option keys.
Map	getLocalOptionPreferences() map of your option keys where the value is "Type[+],text [range]" per the MultiTaskerPreferences class.

Field Detail

TYPE_STRING

static final String TYPE_STRING

See Also:

Constant Field Values

TYPE_FLOAT

static final String TYPE_FLOAT

See Also:

Constant Field Values

TYPE_INTEGER

static final String TYPE_INTEGER

See Also:

Constant Field Values

TYPE_BOOLEAN

static final String TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_COLOR

static final String TYPE_COLOR

See Also:

Constant Field Values

TYPE_CLASS

static final String TYPE_CLASS

See Also:

Constant Field Values

TYPE_URL

static final String TYPE_URL

See Also:

Constant Field Values

TYPE_IMAGE

static final String TYPE_IMAGE

FUTURE - just Url alias for now.

See Also:

Constant Field Values

TYPE_FILE

static final String TYPE_FILE

See Also:

Constant Field Values

TYPE_FOLDER

static final String TYPE_FOLDER

See Also:

Constant Field Values

Method Detail

getLocalOptionNames

Collection getLocalOptionNames()

Your option keys. Usually just the keys of getLocalOptionPreferences, unless you don't provide preferences definitions for all of your keys.

Returns:

getLocalOptionDefault

String getLocalOptionDefault(String key)

defaults for each of the local option keys. Could just return null if there is no provided default. If the local option default starts with a +, it is appended (delimeted by a comma) to the getOptionDefault value, if any.

Returns:

Option value to use if none is set or overridden.

getLocalOptionPreferences

Map getLocalOptionPreferences()

map of your option keys where the value is "Type[+],text [range]" per the MultiTaskerPreferences class. Use a LinkedHashMap to maintain the order of your options.

Returns: