tvbrowser.extras.reminderplugin

Class ReminderPluginProxy

java.lang.Object

tvbrowser.extras.reminderplugin.ReminderPluginProxy

All Implemented Interfaces:

ContextMenuIf, Marker, ProgramReceiveIf, ButtonActionIf, InternalPluginProxyIf

public class ReminderPluginProxy
extends Object
implements ButtonActionIf, ContextMenuIf, ProgramReceiveIf, Marker, InternalPluginProxyIf

Encapsulates the Reminder and manages the access to it.

Since:

2.5

Author:

René Mach

Nested Class Summary

Nested classes/interfaces inherited from interface tvbrowser.extras.common.InternalPluginProxyIf

InternalPluginProxyIf.Comparator

Field Summary

Fields inherited from interface tvbrowser.extras.common.InternalPluginProxyIf

KEYBOARD_ACCELERATOR

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canReceivePrograms() Deprecated. Since 2.5
boolean	canReceiveProgramsWithTarget() Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.
ActionMenu	getButtonAction() Gets the action menu with the action supported for toolbar actions.
String	getButtonActionDescription() Gets the description for this ButtonActionIf.
ActionMenu	getContextMenuActions(Program program) Gets the actions for the context menu of a program.
Icon	getIcon() Gets the icon of this internal plugin.
String	getId() Gets the id of this ButtonActionIf.
static ReminderPluginProxy	getInstance()
Icon	getMarkIcon()
Icon[]	getMarkIcons(Program p)
int	getMarkPriorityForProgram(Program p)
String	getName() Gets the name of this internal plugin.
ProgramReceiveTarget[]	getProgramReceiveTargets() Returns an array of receive target or null if there is no target
String	getSettingsId() Gets the settings id of this internal plugin.
SettingsTab	getSettingsTab() Gets the settings tab of this internal plugin.
void	receivePrograms(Program[] programArr) Deprecated. Since 2.5
boolean	receivePrograms(Program[] programArr, ProgramReceiveTarget receiveTarget) Receives a list of programs from another plugin with a target.
boolean	receiveValues(String[] values, ProgramReceiveTarget receiveTarget) Receives a list of Strings from another plugin with a target.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ReminderPluginProxy getInstance()

Returns:

The instance of the ReminderPluginProxy

getContextMenuActions

public ActionMenu getContextMenuActions(Program program)

Description copied from interface: ContextMenuIf

Gets the actions for the context menu of a program.

Specified by:

getContextMenuActions in interface ContextMenuIf

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.

getId

public String getId()

Description copied from interface: ButtonActionIf

Gets the id of this ButtonActionIf.

Specified by:

getId in interface ContextMenuIf

Specified by:

getId in interface Marker

Specified by:

getId in interface ProgramReceiveIf

Specified by:

getId in interface ButtonActionIf

Specified by:

getId in interface InternalPluginProxyIf

Returns:

The id of this ButtonActionIf.

toString

public String toString()

Overrides:

toString in class Object

canReceiveProgramsWithTarget

public boolean canReceiveProgramsWithTarget()

Description copied from interface: ProgramReceiveIf

Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.

Specified by:

canReceiveProgramsWithTarget in interface ProgramReceiveIf

Returns:

Whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.

See Also:

ProgramReceiveIf.receivePrograms(Program[],ProgramReceiveTarget)

receivePrograms

public boolean receivePrograms(Program[] programArr,
                      ProgramReceiveTarget receiveTarget)

Description copied from interface: ProgramReceiveIf

Receives a list of programs from another plugin with a target.

Specified by:

receivePrograms in interface ProgramReceiveIf

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:

ProgramReceiveIf.canReceiveProgramsWithTarget()

getProgramReceiveTargets

public ProgramReceiveTarget[] getProgramReceiveTargets()

Description copied from interface: ProgramReceiveIf

Returns an array of receive target or null if there is no target

Specified by:

getProgramReceiveTargets in interface ProgramReceiveIf

Returns:

The supported receive targets.

See Also:

ProgramReceiveIf.canReceiveProgramsWithTarget(), ProgramReceiveIf.receivePrograms(Program[],ProgramReceiveTarget)

canReceivePrograms

public boolean canReceivePrograms()

Deprecated. Since 2.5

Description copied from interface: ProgramReceiveIf

Gets whether the ProgramReceiveIf supports receiving programs from other plugins.

Specified by:

canReceivePrograms in interface ProgramReceiveIf

Returns:

Whether the ProgramReceiveIf supports receiving programs from other plugins.

See Also:

ProgramReceiveIf.receivePrograms(Program[])

receivePrograms

public void receivePrograms(Program[] programArr)

Deprecated. Since 2.5

Description copied from interface: ProgramReceiveIf

Receives a list of programs from another plugin.

Specified by:

receivePrograms in interface ProgramReceiveIf

Parameters:

programArr - The programs passed from the other plugin.

See Also:

ProgramReceiveIf.canReceivePrograms()

getMarkIcon

public Icon getMarkIcon()

Specified by:

getMarkIcon in interface Marker

getMarkIcons

public Icon[] getMarkIcons(Program p)

Specified by:

getMarkIcons in interface Marker

getMarkPriorityForProgram

public int getMarkPriorityForProgram(Program p)

Specified by:

getMarkPriorityForProgram in interface Marker

getButtonActionDescription

public String getButtonActionDescription()

Description copied from interface: ButtonActionIf

Gets the description for this ButtonActionIf.

Specified by:

getButtonActionDescription in interface ButtonActionIf

Specified by:

getButtonActionDescription in interface InternalPluginProxyIf

Returns:

The description for this ButtonActionIf.

getIcon

public Icon getIcon()

Description copied from interface: InternalPluginProxyIf

Gets the icon of this internal plugin.

Specified by:

getIcon in interface InternalPluginProxyIf

Returns:

The icon for this internal plugin.

getName

public String getName()

Description copied from interface: InternalPluginProxyIf

Gets the name of this internal plugin.

Specified by:

getName in interface InternalPluginProxyIf

Returns:

The name of this internal plugin.

getSettingsTab

public SettingsTab getSettingsTab()

Description copied from interface: InternalPluginProxyIf

Gets the settings tab of this internal plugin.

Specified by:

getSettingsTab in interface InternalPluginProxyIf

Returns:

The settings tab of this internal plugin.

getSettingsId

public String getSettingsId()

Description copied from interface: InternalPluginProxyIf

Gets the settings id of this internal plugin.

Specified by:

getSettingsId in interface InternalPluginProxyIf

Returns:

The settings id of this internal plugin.

getButtonAction

public ActionMenu getButtonAction()

Description copied from interface: ButtonActionIf

Gets the action menu with the action supported for toolbar actions.

Specified by:

getButtonAction in interface ButtonActionIf

Returns:

The action menu with the supported toolbar actions

receiveValues

public boolean receiveValues(String[] values,
                    ProgramReceiveTarget receiveTarget)

Description copied from interface: ProgramReceiveIf

Receives a list of Strings from another plugin with a target.

Specified by:

receiveValues in interface ProgramReceiveIf

Parameters:

values - The value array passed from the other plugin.

receiveTarget - The receive target of the programs.

Returns:

True if the value array was handled correct, false otherwise.

See Also:

ProgramReceiveIf.canReceiveProgramsWithTarget()