genreplugin

Class GenrePlugin

java.lang.Object

devplugin.Plugin

genreplugin.GenrePlugin

All Implemented Interfaces:

ContextMenuIf, Marker, ProgramReceiveIf, IGenreSettings

public class GenrePlugin
extends Plugin
implements IGenreSettings

Author:

bananeweizen

Field Summary

Fields inherited from class devplugin.Plugin

BIG_ICON, DISABLED_ON_TASK_MENU, parent, SINGLE_CLICK_WAITING_TIME

Fields inherited from interface genreplugin.IGenreSettings

FILTERED_GENRE, FILTERED_GENRES_COUNT, SETTINGS_DAYS

Constructor Summary

Constructors

Constructor and Description
GenrePlugin()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canUseProgramTree() Signal whether this plugin participates in the plugin tree view or not.
protected void	getFilterFromSettings()
PluginInfo	getInfo() Gets the meta information about the plugin.
protected static GenrePlugin	getInstance()
ThemeIcon	getMarkIconFromTheme() This gets the ThemeIcon containg your mark icon.
PluginTreeNode	getRootNode() Gets the root node of the plugin for the plugin tree.
SettingsTab	getSettingsTab() Gets the SettingsTab object, which is added to the settings-window.
static Version	getVersion()
void	handleTvBrowserStartFinished() This method is called when the TV-Browser start is finished.
void	handleTvDataUpdateFinished() This method is automatically called, when the TV data update is finished.
void	hideGenre(String genre)
void	loadSettings(Properties settings) Called by the host-application during start-up.
void	onActivation() This method is automatically called immediatly before the plugin gets activated.
void	saveSettings(Object[] hidden)
Properties	storeSettings() Called by the host-application during shut-down.
protected void	updateRootNode()

Methods inherited from class devplugin.Plugin

canReceivePrograms, canReceiveProgramsWithTarget, createImageIcon, createImageIcon, createImageIcon, createImageIconForFileName, execute, execute, execute, getAvailableFilter, getAvailableFilterComponentClasses, getButtonAction, getButtonIconName, getButtonText, getContextMenuActions, getContextMenuItemText, getId, getJarFile, getMarkIcon, getMarkIconName, getMarkIcons, getMarkIconsForProgram, getMarkPriorityForProgram, getParentFrame, getPluginManager, getProgramFromContextMenuActionEvent, getProgramReceiveTargets, getProgramTableIcons, getProgramTableIconText, getRatingInterfaces, handleTvDataAdded, handleTvDataAdded, handleTvDataChanged, handleTvDataChanged, handleTvDataDeleted, handleTvDataTouched, isAllowedToDeleteProgramFilter, layoutWindow, layoutWindow, onDeactivation, readData, receivePrograms, receivePrograms, receiveValues, saveMe, setJarFile, setParent, setPluginManager, storeRootNode, supportMultipleProgramExecution, toString, writeData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GenrePlugin

public GenrePlugin()

Method Detail

getInstance

protected static GenrePlugin getInstance()

canUseProgramTree

public boolean canUseProgramTree()

Description copied from class: Plugin

Signal whether this plugin participates in the plugin tree view or not.

Overrides:

canUseProgramTree in class Plugin

Returns:

true, if the programs of this plugin are handled by the plugin tree view

See Also:

Plugin.getRootNode()

getVersion

public static Version getVersion()

getInfo

public PluginInfo getInfo()

Description copied from class: Plugin

Gets the meta information about the plugin.

Override this method to provide information about your plugin.

Overrides:

getInfo in class Plugin

Returns:

The meta information about the plugin.

getRootNode

public PluginTreeNode getRootNode()

Description copied from class: Plugin

Gets the root node of the plugin for the plugin tree.

Overrides:

getRootNode in class Plugin

Returns:

The root node.

See Also:

Plugin.canUseProgramTree()

getSettingsTab

public SettingsTab getSettingsTab()

Description copied from class: Plugin

Gets the SettingsTab object, which is added to the settings-window.

Override this method to provide a settings tab. The settings tab will be shown in the settings dialog in the plugin section.

Overrides:

getSettingsTab in class Plugin

Returns:

the SettingsTab object or null if the plugin does not provide this feature.

updateRootNode

protected void updateRootNode()

handleTvBrowserStartFinished

public void handleTvBrowserStartFinished()

Description copied from class: Plugin

This method is called when the TV-Browser start is finished.

Overrides:

handleTvBrowserStartFinished in class Plugin

getMarkIconFromTheme

public ThemeIcon getMarkIconFromTheme()

Description copied from class: Plugin

This gets the ThemeIcon containg your mark icon. This Function uses the Icon-Theme-Function of the TV-Browser. For details see PluginManager.getIconFromTheme(Plugin, String, String, int)

Overrides:

getMarkIconFromTheme in class Plugin

Returns:

ThemeIcon that identifies the Icon in the Theme

handleTvDataUpdateFinished

public void handleTvDataUpdateFinished()

Description copied from class: Plugin

This method is automatically called, when the TV data update is finished.

Override this method to react on this event. If you want to read data from the internet use this method to track if a connection was established. ATTENTION: If you do so take care of the TV-Browser start, at the start this method mustn't use an internet connection. Use the method handleTvBrowserStartFinished() to track if the TV-Browser start was finished before allowing access to the internet in this method.

Overrides:

handleTvDataUpdateFinished in class Plugin

See Also:

Plugin.handleTvBrowserStartFinished(), Plugin.handleTvDataAdded(ChannelDayProgram), Plugin.handleTvDataDeleted(ChannelDayProgram), Plugin.handleTvDataChanged()

loadSettings

public void loadSettings(Properties settings)

Description copied from class: Plugin

Called by the host-application during start-up.

Override this method to load your plugins settings from the file system.

Overrides:

loadSettings in class Plugin

Parameters:

settings - The settings for this plugin (May be empty).

storeSettings

public Properties storeSettings()

Description copied from class: Plugin

Called by the host-application during shut-down.

Override this method to store your plugins settings to the file system. ATTENTION: Don't use any logger, thread or access to Frames in this method.

Overrides:

storeSettings in class Plugin

Returns:

The settings for this plugin or null if this plugin does not need to save any settings.

hideGenre

public void hideGenre(String genre)

getFilterFromSettings

protected void getFilterFromSettings()

saveSettings

public void saveSettings(Object[] hidden)

onActivation

public void onActivation()

Description copied from class: Plugin

This method is automatically called immediatly before the plugin gets activated.

Overrides:

onActivation in class Plugin