com.blackledge.david.tivo.multitasker.plugins
Class LocalStreamedBackgroundImage

java.lang.Object
  extended by com.blackledge.david.tivo.multitasker.plugins.LocalStreamedBackgroundImage
All Implemented Interfaces:
BackgroundImage, Brand, LocalOptionProvider

public class LocalStreamedBackgroundImage
extends Object
implements BackgroundImage, Brand, LocalOptionProvider

non-smart implementation of getting local picture URLs for everything in "My Pictures"

Version:
$Revision: 1.1 $

Field Summary
static String OPTION_LOCAL_IMAGE_FOLDER
           
 
Fields inherited from interface com.blackledge.david.tivo.multitasker.LocalOptionProvider
TYPE_BOOLEAN, TYPE_CLASS, TYPE_COLOR, TYPE_FILE, TYPE_FLOAT, TYPE_FOLDER, TYPE_IMAGE, TYPE_INTEGER, TYPE_STRING, TYPE_URL
 
Constructor Summary
LocalStreamedBackgroundImage()
           
 
Method Summary
 String getLocalOptionDefault(String key)
          defaults for each of the local option keys.
 Collection getLocalOptionNames()
          just the keySet of getLocalOptionPreferences()
 Map getLocalOptionPreferences()
          Add support for OPTION_LOCAL_IMAGE_FOLDER map of your option keys where the value is "Type[+],text [range]" per the MultiTaskerPreferences class.
 String getNextImage()
           
 com.tivo.hme.bananas.BView getUpdatedBrand(com.tivo.hme.bananas.BView brandParent)
          Simple impl of brand - just sets brand's resource to result of getNextImage() Not going to work nicely with simultaneous use of background image for non-shuffle mode.
 void init(MultiTaskerApplication app)
          initialize the plugin with the current application context.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPTION_LOCAL_IMAGE_FOLDER

public static final String OPTION_LOCAL_IMAGE_FOLDER
See Also:
Constant Field Values
Constructor Detail

LocalStreamedBackgroundImage

public LocalStreamedBackgroundImage()
Method Detail

getNextImage

public String getNextImage()
Specified by:
getNextImage in interface BackgroundImage

init

public void init(MultiTaskerApplication app)
Description copied from interface: Brand
initialize the plugin with the current application context. Called once before Brand.getUpdatedBrand(BView) is ever called.

Specified by:
init in interface BackgroundImage
Specified by:
init in interface Brand

getLocalOptionNames

public Collection getLocalOptionNames()
just the keySet of getLocalOptionPreferences()

Specified by:
getLocalOptionNames in interface LocalOptionProvider
Returns:

getLocalOptionPreferences

public Map getLocalOptionPreferences()
Add support for OPTION_LOCAL_IMAGE_FOLDER 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.

Specified by:
getLocalOptionPreferences in interface LocalOptionProvider
Returns:
See Also:
LocalOptionProvider.getLocalOptionPreferences()

getLocalOptionDefault

public String getLocalOptionDefault(String key)
Description copied from interface: LocalOptionProvider
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.

Specified by:
getLocalOptionDefault in interface LocalOptionProvider
Returns:
Option value to use if none is set or overridden.

getUpdatedBrand

public com.tivo.hme.bananas.BView getUpdatedBrand(com.tivo.hme.bananas.BView brandParent)
Simple impl of brand - just sets brand's resource to result of getNextImage() Not going to work nicely with simultaneous use of background image for non-shuffle mode. Gets called to create the brand and any time the multitasker thinks it should be updated. Implementors are responsible for cleaning up your old View if creating a new one!

Specified by:
getUpdatedBrand in interface Brand
Parameters:
brandParent - the parent to use for the brand's view - constrains height/width/position
Returns:
View that contains the brand. Will be set visible or invisible as needed by multitasker. If null is returned, the Brand will be unchanged this "round."
See Also:
Brand.getUpdatedBrand(com.tivo.hme.bananas.BView)