TV-Browser 2.7.5 API

growlplugin
Class GrowlPlugin

java.lang.Object
  extended by devplugin.Plugin
      extended by growlplugin.GrowlPlugin
All Implemented Interfaces:
ContextMenuIf, Marker, ProgramReceiveIf

public class GrowlPlugin
extends Plugin

This is the Growl-Plugin It sends Growl-Notifications for each Program it receives. For more Details look at http://growl.info

Author:
bodum

Field Summary
 
Fields inherited from class devplugin.Plugin
BIG_ICON, DISABLED_ON_TASK_MENU, parent, SINGLE_CLICK_WAITING_TIME
 
Constructor Summary
GrowlPlugin()
          Checks the OS and inititializes the System accordingly.
 
Method Summary
 boolean canReceiveProgramsWithTarget()
          Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.
 GrowlContainer getContainer()
          Return the GrowlContainer that is currently used
 PluginInfo getInfo()
          Gets the meta information about the plugin.
 Icon[] getMarkIconsForProgram(Program p)
          Get mark icons for Plugin
 ProgramReceiveTarget[] getProgramReceiveTargets()
          Returns an array of receive target or null if there is no target
 SettingsTab getSettingsTab()
          Create the Settings-Tab
static Version getVersion()
           
 void loadSettings(Properties settings)
          Load the Settings for this Plugin and create Default-Values if nothing was set
 boolean receivePrograms(Program[] programArr, ProgramReceiveTarget receiveTarget)
          Receives a list of programs from another plugin with a target.
 Properties storeSettings()
          Store the Settings
 
Methods inherited from class devplugin.Plugin
canReceivePrograms, canUseProgramTree, createImageIcon, createImageIcon, createImageIcon, createImageIconForFileName, execute, execute, execute, getAvailableFilter, getAvailableFilterComponentClasses, getButtonAction, getButtonIconName, getButtonText, getContextMenuActions, getContextMenuItemText, getId, getJarFile, getMarkIcon, getMarkIconFromTheme, getMarkIconName, getMarkIcons, getMarkPriorityForProgram, getParentFrame, getPluginManager, getProgramFromContextMenuActionEvent, getProgramTableIcons, getProgramTableIconText, getRatingInterfaces, getRootNode, handleTvBrowserStartFinished, handleTvDataAdded, handleTvDataAdded, handleTvDataChanged, handleTvDataChanged, handleTvDataDeleted, handleTvDataTouched, handleTvDataUpdateFinished, isAllowedToDeleteProgramFilter, layoutWindow, layoutWindow, onActivation, onDeactivation, readData, 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

GrowlPlugin

public GrowlPlugin()
Checks the OS and inititializes the System accordingly.

Method Detail

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.

getVersion

public static Version getVersion()

canReceiveProgramsWithTarget

public boolean canReceiveProgramsWithTarget()
Description copied from class: Plugin
Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.

Specified by:
canReceiveProgramsWithTarget in interface ProgramReceiveIf
Overrides:
canReceiveProgramsWithTarget in class Plugin
Returns:
Whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.
See Also:
Plugin.receivePrograms(Program[],ProgramReceiveTarget)

receivePrograms

public boolean receivePrograms(Program[] programArr,
                               ProgramReceiveTarget receiveTarget)
Description copied from class: Plugin
Receives a list of programs from another plugin with a target.

Specified by:
receivePrograms in interface ProgramReceiveIf
Overrides:
receivePrograms in class Plugin
Parameters:
programArr - The programs passed from the other plugin.
receiveTarget - The receive target of the programs.
Returns:
If the programs were correct received (the target really exists).
See Also:
Plugin.canReceiveProgramsWithTarget()

getProgramReceiveTargets

public ProgramReceiveTarget[] getProgramReceiveTargets()
Description copied from class: Plugin
Returns an array of receive target or null if there is no target

Specified by:
getProgramReceiveTargets in interface ProgramReceiveIf
Overrides:
getProgramReceiveTargets in class Plugin
Returns:
The supported receive targets.
See Also:
Plugin.canReceiveProgramsWithTarget(), Plugin.receivePrograms(Program[],ProgramReceiveTarget)

getSettingsTab

public SettingsTab getSettingsTab()
Create the Settings-Tab

Overrides:
getSettingsTab in class Plugin
Returns:
the SettingsTab object or null if the plugin does not provide this feature.

loadSettings

public void loadSettings(Properties settings)
Load the Settings for this Plugin and create Default-Values if nothing was set

Overrides:
loadSettings in class Plugin
Parameters:
settings - The settings for this plugin (May be empty).

getContainer

public GrowlContainer getContainer()
Return the GrowlContainer that is currently used

Returns:
GrowlContainer that is used

storeSettings

public Properties storeSettings()
Store the Settings

Overrides:
storeSettings in class Plugin
Returns:
The settings for this plugin or null if this plugin does not need to save any settings.

getMarkIconsForProgram

public Icon[] getMarkIconsForProgram(Program p)
Get mark icons for Plugin

Overrides:
getMarkIconsForProgram in class Plugin
Parameters:
p - get Icon for this Program
Returns:
MarkIcons for the Plugin

TV-Browser 2.7.5 API

TV-Browser 2.7.5, Copyright (C) 04-2003 Martin Oberhauser (martin@tvbrowser.org)