captureplugin

Class CapturePlugin

java.lang.Object

devplugin.Plugin

captureplugin.CapturePlugin

All Implemented Interfaces:

ContextMenuIf, Marker, ProgramReceiveIf

public class CapturePlugin
extends Plugin

Plugin to send the TV-Data to an external program

Author:

Andreas Hessel, Bodo Tasche

Field Summary

Fields inherited from class devplugin.Plugin

BIG_ICON, DISABLED_ON_TASK_MENU, parent, SINGLE_CLICK_WAITING_TIME

Constructor Summary

Constructors

Constructor and Description
CapturePlugin() Creates the Plugin

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canReceiveProgramsWithTarget() Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.
boolean	canUseProgramTree() Signal whether this plugin participates in the plugin tree view or not.
ActionMenu	getButtonAction() Gets the action to use for the main menu and the toolbar.
CapturePluginData	getCapturePluginData() Returns the CapturePluginData
ActionMenu	getContextMenuActions(Program program) Gets the actions for the context menu of a program.
PluginInfo	getInfo() Implement this function to provide information about your plugin.
static CapturePlugin	getInstance() Returns this Instance
ThemeIcon	getMarkIconFromTheme() This gets the ThemeIcon containg your mark icon.
int	getMarkPriorityForProgram(Program p) Gets the mark priority for the given program that this Plugin uses.
ProgramReceiveTarget[]	getProgramReceiveTargets() Returns an array of receive target or null if there is no target
PluginTreeNode	getRootNode() Get the Root-Node.
SettingsTab	getSettingsTab() Returns a new SettingsTab object, which is added to the settings-window.
Frame	getSuperFrame()
static Version	getVersion()
void	handleTvBrowserStartFinished() This method is called when the TV-Browser start is finished.
void	handleTvDataUpdateFinished() Check the programs after data update.
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 receiveTarget) Receives a list of programs from another plugin with a target.
void	setCapturePluginData(CapturePluginData data) Sets the CaputePluginData
void	showDialog() This method is invoked by the host-application if the user has choosen your plugin from the menu.
Properties	storeSettings() Called by the host-application during shut-down.
void	updateMarkedPrograms() Updates the marked Programs.
void	writeData(ObjectOutputStream out) Counterpart to loadData.

Methods inherited from class devplugin.Plugin

canReceivePrograms, createImageIcon, createImageIcon, createImageIcon, createImageIconForFileName, execute, execute, execute, getAvailableFilter, getAvailableFilterComponentClasses, getButtonIconName, getButtonText, getContextMenuItemText, getId, getJarFile, getMarkIcon, getMarkIconName, getMarkIcons, getMarkIconsForProgram, getParentFrame, getPluginManager, getProgramFromContextMenuActionEvent, getProgramTableIcons, getProgramTableIconText, getRatingInterfaces, handleTvDataAdded, handleTvDataAdded, handleTvDataChanged, handleTvDataChanged, handleTvDataDeleted, handleTvDataTouched, 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

CapturePlugin

public CapturePlugin()

Creates the Plugin

Method Detail

getInstance

public static CapturePlugin getInstance()

Returns this Instance

Returns:

Instance

readData

public void readData(ObjectInputStream in)
              throws IOException,
                     ClassNotFoundException

Called by the host-application during start-up. Implement 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:

writeData(ObjectOutputStream)

writeData

public void writeData(ObjectOutputStream out)
               throws IOException

Counterpart to loadData. Called when the application shuts down. Implement this method to store any objects to the file system.

Overrides:

writeData in class Plugin

Parameters:

out - The stream to write the objects to

Throws:

IOException - If writing failed.

See Also:

readData(ObjectInputStream)

loadSettings

public void loadSettings(Properties settings)

Called by the host-application during start-up. Implements 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()

Called by the host-application during shut-down. Implements this method to store your plugins settings to the file system.

Overrides:

storeSettings in class Plugin

Returns:

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

getVersion

public static Version getVersion()

getInfo

public PluginInfo getInfo()

Implement this function to provide information about your plugin.

Overrides:

getInfo in class Plugin

Returns:

The meta information about the plugin.

getSettingsTab

public SettingsTab getSettingsTab()

Returns a new SettingsTab object, which is added to the settings-window.

Overrides:

getSettingsTab in class Plugin

Returns:

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

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:

• Action.NAME: The text for the context menu item.
• Action.SMALL_ICON: The icon for the context menu item. Should be 16x16.

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)

updateMarkedPrograms

public void updateMarkedPrograms()

Updates the marked Programs.

getButtonAction

public ActionMenu getButtonAction()

Description copied from class: Plugin

Gets the action to use for the main menu and the toolbar.

Override this method to provide a menu item in the main menu and a toolbar button.

The following action values will be used:

• Action.NAME: The text for the main menu item and the toolbar button.
• Action.SHORT_DESCRIPTION: The description for the button action. Used as tooltip and for the status bar.
• Action.SMALL_ICON: The icon for the main menu item. Should be 16x16.
• BIG_ICON: The icon for the toolbar button. Should be 24x24.

Overrides:

getButtonAction in class Plugin

Returns:

the action to use for the menu and the toolbar or null if the plugin does not provide this feature.

showDialog

public void showDialog()

This method is invoked by the host-application if the user has choosen your plugin from the menu.

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

setCapturePluginData

public void setCapturePluginData(CapturePluginData data)

Sets the CaputePluginData

Parameters:

data - CapturePluginData

getCapturePluginData

public CapturePluginData getCapturePluginData()

Returns the CapturePluginData

Returns:

The CapaturePluginData

getRootNode

public PluginTreeNode getRootNode()

Get the Root-Node. The CapturePlugin handles all Programs for itself. Some Devices can remove Programs externaly

Overrides:

getRootNode in class Plugin

Returns:

The root node.

See Also:

Plugin.canUseProgramTree()

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()

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)

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

handleTvDataUpdateFinished

public void handleTvDataUpdateFinished()

Check the programs after data update.

Overrides:

handleTvDataUpdateFinished in class Plugin

See Also:

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

getSuperFrame

public Frame getSuperFrame()

Returns:

The parent frame.

getMarkPriorityForProgram

public int getMarkPriorityForProgram(Program p)

Description copied from class: Plugin

Gets the mark priority for the given program that this Plugin uses.

The mark priority can be Program.NO_MARK_PRIORITY, Program.MIN_MARK_PRIORITY, Program.LOWER_MEDIUM_MARK_PRIORITY, Program.MEDIUM_MARK_PRIORITY, Program.HIGHER_MEDIUM_MARK_PRIORITY or Program.MAX_MARK_PRIORITY.

Specified by:

getMarkPriorityForProgram in interface Marker

Overrides:

getMarkPriorityForProgram in class Plugin

Parameters:

p - The program to get the mark prioriy for.

Returns:

The mark priority for the given program for this plugin.