TV-Browser 2.7.5 API

emailplugin
Class EMailPlugin

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

public class EMailPlugin
extends Plugin

This Plugin makes it possible to send an email with short info's about the Program

Author:
bodum

Field Summary
 
Fields inherited from class devplugin.Plugin
BIG_ICON, DISABLED_ON_TASK_MENU, parent, SINGLE_CLICK_WAITING_TIME
 
Constructor Summary
EMailPlugin()
          Creates an instance of this class.
 
Method Summary
 boolean canReceiveProgramsWithTarget()
          Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.
protected  LocalPluginProgramFormating[] getAvailableLocalPluginProgramFormatings()
           
 ActionMenu getContextMenuActions(Program program)
          Gets the actions for the context menu of a program.
protected static LocalPluginProgramFormating getDefaultFormating()
           
 PluginInfo getInfo()
          Gets the meta information about the plugin.
 ThemeIcon getMarkIconFromTheme()
          This gets the ThemeIcon containg your mark icon.
 ProgramReceiveTarget[] getProgramReceiveTargets()
          Returns an array of receive target or null if there is no target
protected  AbstractPluginProgramFormating[] getSelectedPluginProgramFormatings()
           
 SettingsTab getSettingsTab()
          Gets the SettingsTab object, which is added to the settings-window.
static Version getVersion()
           
 void loadSettings(Properties settings)
          Called by the host-application during start-up.
 void readData(ObjectInputStream in)
          Called by the host-application during start-up.
 boolean receivePrograms(Program[] programArr, ProgramReceiveTarget target)
          Receives a list of programs from another plugin with a target.
protected  void setAvailableLocalPluginProgramFormatings(LocalPluginProgramFormating[] value)
           
protected  void setSelectedPluginProgramFormatings(AbstractPluginProgramFormating[] value)
           
 Properties storeSettings()
          Called by the host-application during shut-down.
 void writeData(ObjectOutputStream out)
          Counterpart to loadData.
 
Methods inherited from class devplugin.Plugin
canReceivePrograms, canUseProgramTree, createImageIcon, createImageIcon, createImageIcon, createImageIconForFileName, execute, execute, execute, getAvailableFilter, getAvailableFilterComponentClasses, getButtonAction, getButtonIconName, getButtonText, getContextMenuItemText, getId, getJarFile, getMarkIcon, getMarkIconName, getMarkIcons, getMarkIconsForProgram, getMarkPriorityForProgram, getParentFrame, getPluginManager, getProgramFromContextMenuActionEvent, getProgramTableIcons, getProgramTableIconText, getRatingInterfaces, getRootNode, handleTvBrowserStartFinished, handleTvDataAdded, handleTvDataAdded, handleTvDataChanged, handleTvDataChanged, handleTvDataDeleted, handleTvDataTouched, handleTvDataUpdateFinished, isAllowedToDeleteProgramFilter, layoutWindow, layoutWindow, onActivation, onDeactivation, receivePrograms, receiveValues, saveMe, setJarFile, setParent, setPluginManager, storeRootNode, supportMultipleProgramExecution, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EMailPlugin

public EMailPlugin()
Creates an instance of this class.

Method Detail

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.

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

getContextMenuActions

public ActionMenu getContextMenuActions(Program program)
Description copied from class: Plugin
Gets the actions for the context menu of a program.

Override this method to provide context menu items for programs (e.g. in the program table). If your plugin shows a context menu only for some programs, but not for all, then you should explicitly return a non-null menu for the example program. Otherwise your context menu will not be shown in the settings dialog for the context menu order.

The following action values will be used:

Specified by:
getContextMenuActions in interface ContextMenuIf
Overrides:
getContextMenuActions in class Plugin
Parameters:
program - The program the context menu will be shown for.
Returns:
the actions this plugin provides for the given program or null if the plugin does not provide this feature.
See Also:
Plugin.getProgramFromContextMenuActionEvent(ActionEvent)

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)

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)

receivePrograms

public boolean receivePrograms(Program[] programArr,
                               ProgramReceiveTarget target)
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.
target - The receive target of the programs.
Returns:
If the programs were correct received (the target really exists).
See Also:
Plugin.canReceiveProgramsWithTarget()

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.

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.

getDefaultFormating

protected static LocalPluginProgramFormating getDefaultFormating()

getAvailableLocalPluginProgramFormatings

protected LocalPluginProgramFormating[] getAvailableLocalPluginProgramFormatings()

setAvailableLocalPluginProgramFormatings

protected void setAvailableLocalPluginProgramFormatings(LocalPluginProgramFormating[] value)

getSelectedPluginProgramFormatings

protected AbstractPluginProgramFormating[] getSelectedPluginProgramFormatings()

setSelectedPluginProgramFormatings

protected void setSelectedPluginProgramFormatings(AbstractPluginProgramFormating[] value)

writeData

public void writeData(ObjectOutputStream out)
               throws IOException
Description copied from class: Plugin
Counterpart to loadData. Called when the application shuts down.

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

Overrides:
writeData in class Plugin
Parameters:
out - The stream to write the objects to
Throws:
IOException - If writing failed.
See Also:
Plugin.readData(ObjectInputStream)

readData

public void readData(ObjectInputStream in)
              throws IOException,
                     ClassNotFoundException
Description copied from class: Plugin
Called by the host-application during start-up.

Override this method to load any objects from the file system.

Overrides:
readData in class Plugin
Parameters:
in - The stream to read the objects from.
Throws:
IOException - If reading failed.
ClassNotFoundException - If an object could not be casted correctly.
See Also:
Plugin.writeData(ObjectOutputStream)

TV-Browser 2.7.5 API

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