Plugin (API documentation for TV-Browser 3.3.3)

Overview

Package

Class

Tree

Deprecated

Index

Help

TV-Browser 3.3.3 API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

devplugin
Class Plugin

java.lang.Object
  devplugin.Plugin

All Implemented Interfaces:: ContextMenuIf, Marker, ProgramReceiveIf, java.lang.Comparable<ProgramReceiveIf>

Direct Known Subclasses:: AndroidSync, DummyPlugin

public abstract class Plugin
extends java.lang.Object
implements Marker, ContextMenuIf, ProgramReceiveIf
extends java.lang.Object
implements Marker, ContextMenuIf, ProgramReceiveIf

Superclass for all Java-TV-Browser plugins.

To create a plugin do the following:

Create a class that extends this class and name its package equal to the class name but with lower case letters. E.g. myplugin.MyPlugin.
Write your plugin code in that class.
Pack your plugin class including all needed resources in a jar file named equal to your class. E.g. MyPlugin.jar.
Put the jar in the plugin directory of your TV-Browser installation.

Author:: Martin Oberhauser, Til Schneider, www.murfman.de

Field Summary
`static java.lang.String`	`ACTION_ID_KEY` A key for sub action menu entries unique ID.
`static java.lang.String`	`ADDITONAL_DATA_SERVICE_HARDWARE_CATEGORY`
`static java.lang.String`	`ADDITONAL_DATA_SERVICE_SOFTWARE_CATEGORY`
`static java.lang.String`	`ALL_CATEGORY`
`static java.lang.String`	`BIG_ICON` The name to use for the big icon (the 22x22 one for the toolbar) of the button action.
`static java.lang.String`	`DISABLED_ON_TASK_MENU` The name to use for disabling a menu part for showing in ProgramInfo.
`static Localizer`	`mLocalizer` The localizer used by this class.
`static java.lang.String`	`NO_ICON_RESIZE` Key for button action to disable icon resize.
`static java.lang.String`	`OTHER_CATEGORY`
`static java.lang.String`	`RATINGS_CATEGORY`
`static java.lang.String`	`REMOTE_CONTROL_HARDWARE_CATEGORY`
`static java.lang.String`	`REMOTE_CONTROL_SOFTWARE_CATEGORY`
`static int`	`SINGLE_CLICK_WAITING_TIME` The waiting time for single click performing.

Fields inherited from interface devplugin.ContextMenuIf
`ACTIONKEY_KEYBOARD_EVENT`

Constructor Summary
`Plugin()`

Method Summary
`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.
`int`	`compareTo(ProgramReceiveIf o)`
`protected javax.swing.ImageIcon`	`createImageIcon(java.lang.String fileName)` Helper method that loads an ImageIcon from the plugin jar file and returns it.
`javax.swing.ImageIcon`	`createImageIcon(java.lang.String category, java.lang.String icon)` Helper method that Loads an ImageIcon from the IconTheme with default size
`javax.swing.ImageIcon`	`createImageIcon(java.lang.String category, java.lang.String icon, int size)` Helper method that Loads an ImageIcon from the IconTheme
`javax.swing.ImageIcon`	`createImageIcon(ThemeIcon icon)` Helper method that Loads an ImageIcon from the IconTheme
`protected javax.swing.ImageIcon`	`createImageIconForFileName(java.lang.String fileName)` Helper method that loads an ImageIcon from the file system and returns it.
`AfterDataUpdateInfoPanel`	`getAfterDataUpdateInfoPanel()` Gets a panel that contains infos that should be shown for this Plugins after a data update.
`PluginsProgramFilter[]`	`getAvailableFilter()` Returns the available program filters that the plugin supports.
`java.lang.Class<? extends PluginsFilterComponent>[]`	`getAvailableFilterComponentClasses()` Returns the available plugins filter component classes.
`ActionMenu`	`getButtonAction()` Gets the action to use for the main menu and the toolbar.
`ActionMenu`	`getContextMenuActions(Channel channel)` Gets the actions for the context menu of a channel.
`ActionMenu`	`getContextMenuActions(Program program)` Gets the actions for the context menu of a program.
`java.lang.String`	`getId()` Gets the ID of this plugin.
`ImportanceValue`	`getImportanceValueForProgram(Program p)` Gets the importance value of a program.The importance of all active plugins is used to determinate the opacity of the used colors of a program, therefor a mean value of all values is used.
`PluginInfo`	`getInfo()` Gets the meta information about the plugin.
`javax.swing.Icon`	`getMarkIcon()` Gets the icon used for marking programs in the program table.
`ThemeIcon`	`getMarkIconFromTheme()` This gets the ThemeIcon containing your mark icon.
`protected java.lang.String`	`getMarkIconName()` Gets the name of the file, containing your mark icon (in the jar-File).
`javax.swing.Icon[]`	`getMarkIcons(Program p)` Gets the icons used for marking programs in the program table.
`javax.swing.Icon[]`	`getMarkIconsForProgram(Program p)` This gets the mark icons for a Program.
`int`	`getMarkPriorityForProgram(Program p)` Gets the mark priority for the given program that this Plugin uses.
`protected java.awt.Frame`	`getParentFrame()` Gets the parent frame.
`java.lang.String`	`getPluginCategory()` Gets the category of this plugin.
`PluginCenterPanelWrapper`	`getPluginCenterPanelWrapper()` Gets the PluginCenterPanelWrapper for this plugin.
`static PluginManager`	`getPluginManager()` Use this method to call methods of the plugin manager.
`protected Program`	`getProgramFromContextMenuActionEvent(java.awt.event.ActionEvent evt)` Gets the Program from the ActionEvent that was passed to a context menu action NOTE: At the moment the Program is passed as ActionEvent source.
`ProgramReceiveTarget[]`	`getProgramReceiveTargets()` Returns an array of receive targets or `null` if there is no target
`javax.swing.Icon[]`	`getProgramTableIcons(Program program)` Gets the icons this Plugin provides for the given program.
`java.lang.String`	`getProgramTableIconText()` Gets the description text for the program table icons provided by this Plugin.
`ProgramRatingIf[]`	`getRatingInterfaces()` If this plugin can rate programs, this interface makes it possible to offer this ratings to other plugins.
`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()` Gets the version of this plugin.
`void`	`handleTvBrowserSettingsChanged()` Is called when settings of TV-Browser or Plugins were changed, so this Plugin can react on that change.
`void`	`handleTvBrowserStartFinished()` This method is called when the TV-Browser start is finished.
`void`	`handleTvDataAdded(ChannelDayProgram newProg)` This method is automatically called, when TV data was added.
`void`	`handleTvDataAdded(MutableChannelDayProgram newProg)` This method is automatically called, when TV data was added.
`void`	`handleTvDataDeleted(ChannelDayProgram oldProg)` This method is automatically called, when TV data was deleted.
`void`	`handleTvDataTouched(ChannelDayProgram removedDayProgram, ChannelDayProgram addedDayProgram)` This method is automatically called, when TV data was touched (that means something was done with it).
`void`	`handleTvDataUpdateFinished()` This method is automatically called, when the TV data update is finished.
`void`	`handleTvDataUpdateStarted()` Deprecated. since 3.3.3 Use `handleTvDataUpdateStarted(Date)` instead
`void`	`handleTvDataUpdateStarted(Date until)` Is called when a TV data update is started.
`boolean`	`isAllowedToDeleteProgramFilter(PluginsProgramFilter programFilter)` Is used to track if a program filter be deleted.
`void`	`layoutWindow(java.lang.String windowId, java.awt.Window window)` Sets the window position and size for the given window from remembered values for that id.
`void`	`layoutWindow(java.lang.String windowId, java.awt.Window window, java.awt.Dimension defaultSize)` Sets the window position and size for the given window from remembered values for that id.
`protected void`	`loadRootNode(PluginTreeNode node)`
`void`	`loadSettings(java.util.Properties settings)` Called by the host-application during start-up.
`void`	`onActivation()` This method is automatically called immediately before the plugin gets activated.
`void`	`onDeactivation()` This method is automatically called immediately after deactivating the plugin.
`void`	`readData(java.io.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.
`boolean`	`receiveValues(java.lang.String[] values, ProgramReceiveTarget receiveTarget)` Receives a list of Strings from another plugin with a target.
`protected boolean`	`saveMe()` Says the plugin proxy manager to store the settings and data of this plugin.
`void`	`setParent(java.awt.Frame parent)` Called by the host-application to provide the parent frame.
`static void`	`setPluginManager(PluginManager manager)` Called by the host-application to provide access to the plugin manager.
`void`	`storeRootNode()` Saves the entries under the root node in a file.
`protected void`	`storeRootNode(PluginTreeNode node)`
`java.util.Properties`	`storeSettings()` Called by the host-application during shut-down.
`java.lang.String`	`toString()`
`void`	`writeData(java.io.ObjectOutputStream out)` Counterpart to loadData.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

ALL_CATEGORY

public static final java.lang.String ALL_CATEGORY

See Also:: Constant Field Values

REMOTE_CONTROL_SOFTWARE_CATEGORY

public static final java.lang.String REMOTE_CONTROL_SOFTWARE_CATEGORY

See Also:: Constant Field Values

REMOTE_CONTROL_HARDWARE_CATEGORY

public static final java.lang.String REMOTE_CONTROL_HARDWARE_CATEGORY

See Also:: Constant Field Values

ADDITONAL_DATA_SERVICE_SOFTWARE_CATEGORY

public static final java.lang.String ADDITONAL_DATA_SERVICE_SOFTWARE_CATEGORY

See Also:: Constant Field Values

ADDITONAL_DATA_SERVICE_HARDWARE_CATEGORY

public static final java.lang.String ADDITONAL_DATA_SERVICE_HARDWARE_CATEGORY

See Also:: Constant Field Values

RATINGS_CATEGORY

public static final java.lang.String RATINGS_CATEGORY

See Also:: Constant Field Values

OTHER_CATEGORY

public static final java.lang.String OTHER_CATEGORY

See Also:: Constant Field Values

BIG_ICON

public static final java.lang.String BIG_ICON

The name to use for the big icon (the 22x22 one for the toolbar) of the button action.

See Also:: getButtonAction(), Constant Field Values

NO_ICON_RESIZE

public static final java.lang.String NO_ICON_RESIZE

Key for button action to disable icon resize. Set value to true to disable button resize.

See Also:: Constant Field Values

ACTION_ID_KEY

public static final java.lang.String ACTION_ID_KEY

A key for sub action menu entries unique ID.

See Also:: Constant Field Values

DISABLED_ON_TASK_MENU

public static final java.lang.String DISABLED_ON_TASK_MENU

The name to use for disabling a menu part for showing in ProgramInfo.

Since:: 2.6
See Also:: Constant Field Values

SINGLE_CLICK_WAITING_TIME

public static final int SINGLE_CLICK_WAITING_TIME

The waiting time for single click performing.

Since:: 2.7

mLocalizer

public static final Localizer mLocalizer

The localizer used by this class.

Constructor Detail

Plugin

public Plugin()

Method Detail

setPluginManager

public static final void setPluginManager(PluginManager manager)

Called by the host-application to provide access to the plugin manager.

Parameters:: manager - The plugin manager the plugins should use.

getPluginManager

public static final PluginManager getPluginManager()

Use this method to call methods of the plugin manager.

The plugin manager is your connection to TV-Browser. Every communication between TV-Browser and the plugin is either initiated by TV-Browser or made by using the plugin manager.

Returns:: The plugin manager.

getId

public final java.lang.String getId()

Gets the ID of this plugin.

Specified by:: getId in interface ContextMenuIf
Specified by:: getId in interface Marker
Specified by:: getId in interface ProgramReceiveIf

Returns:: The ID of this plugin.

setParent

public final void setParent(java.awt.Frame parent)

Called by the host-application to provide the parent frame.

Parameters:: parent - The parent frame.

getParentFrame

protected final java.awt.Frame getParentFrame()

Gets the parent frame.

The parent frame may be used for showing dialogs.

Returns:: The parent frame.

createImageIcon

protected final javax.swing.ImageIcon createImageIcon(java.lang.String fileName)

Helper method that loads an ImageIcon from the plugin jar file and returns it.

Parameters:: fileName - The name of the icon file.
Returns:: The icon.

createImageIconForFileName

protected final javax.swing.ImageIcon createImageIconForFileName(java.lang.String fileName)

Helper method that loads an ImageIcon from the file system and returns it.

Parameters:: fileName - The name of the icon file.
Returns:: The icon.
Since:: 2.3

createImageIcon

public final javax.swing.ImageIcon createImageIcon(java.lang.String category,
                                                   java.lang.String icon,
                                                   int size)

Helper method that Loads an ImageIcon from the IconTheme

Parameters:: category - Category the Icon resists in; icon - Icon to load (without extension); size - Size of the Icon
Returns:: The Icon
Since:: 2.2

createImageIcon

public final javax.swing.ImageIcon createImageIcon(java.lang.String category,
                                                   java.lang.String icon)

Helper method that Loads an ImageIcon from the IconTheme with default size

Parameters:: category - Category the Icon resists in; icon - Icon to load (without extension)
Returns:: The Icon
Since:: 2.2

createImageIcon

public final javax.swing.ImageIcon createImageIcon(ThemeIcon icon)

Helper method that Loads an ImageIcon from the IconTheme

Parameters:: icon - Icon to load
Returns:: The Icon
Since:: 2.2

readData

public void readData(java.io.ObjectInputStream in)
              throws java.io.IOException,
                     java.lang.ClassNotFoundException

Called by the host-application during start-up.

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

Parameters:: in - The stream to read the objects from.
Throws:: java.io.IOException - If reading failed.; java.lang.ClassNotFoundException - If an object could not be casted correctly.
See Also:: writeData(ObjectOutputStream)

writeData

public void writeData(java.io.ObjectOutputStream out)
               throws java.io.IOException

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.

Parameters:: out - The stream to write the objects to
Throws:: java.io.IOException - If writing failed.
See Also:: readData(ObjectInputStream)

loadSettings

public void loadSettings(java.util.Properties settings)

Called by the host-application during start-up.

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

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

storeSettings

public java.util.Properties storeSettings()

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.

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

getVersion

public static Version getVersion()

Gets the version of this plugin.

Override this to provide a check of the plugin for the version to load from main plugins dir or the user plugins dir. The plugin with the highest version will be loaded.

Returns:: The version of this plugin.
Since:: 2.6

getInfo

public PluginInfo getInfo()

Gets the meta information about the plugin.

Override this method to provide information about your plugin.

Returns:: The meta information about the plugin.

getContextMenuActions

public ActionMenu getContextMenuActions(Program program)

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

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:: getProgramFromContextMenuActionEvent(ActionEvent)

getContextMenuActions

public ActionMenu getContextMenuActions(Channel channel)

Gets the actions for the context menu of a channel.

Override this method to provide context menu items for channels.

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.

Parameters:: channel - The channel 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.
Since:: 3.0
See Also:: getContextMenuActions(Program)

getProgramFromContextMenuActionEvent

protected final Program getProgramFromContextMenuActionEvent(java.awt.event.ActionEvent evt)

Gets the Program from the ActionEvent that was passed to a context menu action

NOTE: At the moment the Program is passed as ActionEvent source. Please use this method to get the program and not directly the ActionEvent source. Because in future versions of TV-Browser the Program may be passed in another way!!

Parameters:: evt - The ActionEvent to get the Program from.
Returns:: The Program from the ActionEvent.
See Also:: getContextMenuActions(Program)

getButtonAction

public ActionMenu getButtonAction()

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.

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

getProgramTableIconText

public java.lang.String getProgramTableIconText()

Gets the description text for the program table icons provided by this Plugin.

Override this method if your plugin provides icons for the program table (shown below the start time). The returned String will be shown in settings dialog (german: Aussehen->Sendungsanzeige->Plugin-Icons).

Returns:: The description text for the program table icons or null if the plugin does not provide this feature.
See Also:: getProgramTableIcons(Program)

getProgramTableIcons

public javax.swing.Icon[] getProgramTableIcons(Program program)

Gets the icons this Plugin provides for the given program. These icons will be shown in the program table under the start time.

Override this method to return the icons for the program table (shown below the start time).

This method is only called, if the option to show program table icons for this plugin is set in the options.

Parameters:: program - The program to get the icons for.
Returns:: The icons for the given program or null if the plugin does not provide this feature.
See Also:: getProgramTableIconText()

getSettingsTab

public SettingsTab getSettingsTab()

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.

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

getMarkIcon

public final javax.swing.Icon getMarkIcon()

Gets the icon used for marking programs in the program table.

Specified by:: getMarkIcon in interface Marker

Returns:: the icon to use for marking programs in the program table.
See Also:: getMarkIconName()

getMarkIcons

public final javax.swing.Icon[] getMarkIcons(Program p)

Gets the icons used for marking programs in the program table.

Specified by:: getMarkIcons in interface Marker

Returns:: the icons to use for marking programs in the program table.
Since:: 2.5

getMarkIconsForProgram

public javax.swing.Icon[] getMarkIconsForProgram(Program p)

This gets the mark icons for a Program. Please cache the icons in the Plugin.

Parameters:: p - The Program to get the icons for.
Returns:: The icons for the Program.
Since:: 2.5

getMarkIconFromTheme

public ThemeIcon getMarkIconFromTheme()

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

Returns:: ThemeIcon that identifies the Icon in the Theme
Since:: 2.2

getMarkIconName

protected java.lang.String getMarkIconName()

Gets the name of the file, containing your mark icon (in the jar-File). Should be 16x16.

This icon is used for marking programs in the program table.

Override this method if your plugin is able to mark programs As an alternative you can use an Icon from the Icon-Theme using getMarkIconFromTheme()

Returns:: the name of the file, containing your icon for the toolbar or null if the plugin does not provide this feature.
See Also:: getMarkIcon(), Program.mark(Plugin), Program.unmark(Plugin)

handleTvDataUpdateFinished

public void handleTvDataUpdateFinished()

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.

See Also:: handleTvBrowserStartFinished(), handleTvDataAdded(ChannelDayProgram), handleTvDataDeleted(ChannelDayProgram), handleTvDataTouched(ChannelDayProgram, ChannelDayProgram)

handleTvDataAdded

public void handleTvDataAdded(MutableChannelDayProgram newProg)

This method is automatically called, when TV data was added. (E.g. after an update).

The TV data can be modified by the plugin!

Override this method if you want to change/add data fields of the programs. If you only want to access the programs without changing any fields, please use handleTvDataAdded(ChannelDayProgram) instead.

Parameters:: newProg - The new ChannelDayProgram.
See Also:: handleTvDataDeleted(ChannelDayProgram), handleTvDataTouched(ChannelDayProgram, ChannelDayProgram)

handleTvDataAdded

public void handleTvDataAdded(ChannelDayProgram newProg)

This method is automatically called, when TV data was added. (E.g. after an update).

The TV data cannot be changed in here because the saving of the data was already done.

So use this method if you want to mark or do something else than changing with the program. If you want to change/add data use handleTvDataAdded(MutableChannelDayProgram) instead.

Parameters:: newProg - The new ChannelDayProgram.
See Also:: handleTvDataDeleted(ChannelDayProgram), handleTvDataTouched(ChannelDayProgram, ChannelDayProgram)

handleTvDataDeleted

public void handleTvDataDeleted(ChannelDayProgram oldProg)

This method is automatically called, when TV data was deleted. (E.g. after an update). It is not called however, if programs are removed at startup of the TVB due to their age!

Override this method to react on this event.

Parameters:: oldProg - The old ChannelDayProgram which was deleted.
See Also:: handleTvDataAdded(ChannelDayProgram), handleTvDataTouched(ChannelDayProgram, ChannelDayProgram)

handleTvDataTouched

public void handleTvDataTouched(ChannelDayProgram removedDayProgram,
                                ChannelDayProgram addedDayProgram)

This method is automatically called, when TV data was touched (that means something was done with it). (E.g. after an update).

Parameters:: removedDayProgram - The old ChannelDayProgram.; addedDayProgram - The new ChannelDayProgram.
Since:: 2.7.3
See Also:: handleTvDataAdded(ChannelDayProgram), handleTvDataDeleted(ChannelDayProgram), handleTvDataUpdateFinished()

onActivation

public void onActivation()

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

Since:: 1.1

onDeactivation

public void onDeactivation()

This method is automatically called immediately after deactivating the plugin. ATTENTION: Don't use any logger, thread or access to Frames in this method.

Since:: 1.1

canUseProgramTree

public boolean canUseProgramTree()

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

Returns:: true, if the programs of this plugin are handled by the plugin tree view
Since:: 1.1
See Also:: getRootNode()

handleTvBrowserStartFinished

public void handleTvBrowserStartFinished()

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

Since:: 2.2

getRootNode

public PluginTreeNode getRootNode()

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

Returns:: The root node.
See Also:: canUseProgramTree()

loadRootNode

protected void loadRootNode(PluginTreeNode node)

storeRootNode

public void storeRootNode()

Saves the entries under the root node in a file.

storeRootNode

protected void storeRootNode(PluginTreeNode node)

canReceiveProgramsWithTarget

public boolean canReceiveProgramsWithTarget()

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.
Since:: 2.5
See Also:: 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:: true, if the programs were correctly received and the target really exists.
See Also:: ProgramReceiveIf.canReceiveProgramsWithTarget()

receiveValues

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

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.
Since:: 2.7
See Also:: canReceiveProgramsWithTarget()

getProgramReceiveTargets

public ProgramReceiveTarget[] getProgramReceiveTargets()

Description copied from interface: ProgramReceiveIf

Returns an array of receive targets 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)

getAvailableFilter

public PluginsProgramFilter[] getAvailableFilter()

Returns the available program filters that the plugin supports.

Returns:: The available program filters that the plugin supports or null if it supports no filter.
Since:: 2.5

isAllowedToDeleteProgramFilter

public boolean isAllowedToDeleteProgramFilter(PluginsProgramFilter programFilter)

Is used to track if a program filter be deleted. Should be make sure only the plugin itself can delete program filters.

Parameters:: programFilter - The program filter to delete.
Returns:: True if the program filter component can be deleted.

toString

public java.lang.String toString()

Overrides:: toString in class java.lang.Object

getAvailableFilterComponentClasses

public java.lang.Class<? extends PluginsFilterComponent>[] getAvailableFilterComponentClasses()

Returns the available plugins filter component classes.
ATTENTON: Use return (Class[]) new Class[] {MyFilterComponent1.class,MyFilterComponent2.class}; because the creation of a class array with generic type didn't work.

Returns:: The available plugins filter components classes or null if no plugins filter components are supported.
Since:: 2.5

getMarkPriorityForProgram

public int getMarkPriorityForProgram(Program p)

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

The mark priority can be

Specified by:: getMarkPriorityForProgram in interface Marker

Parameters:: p - The program to get the mark priority for.
Returns:: The mark priority for the given program for this plugin.
Since:: 2.5.1

saveMe

protected final boolean saveMe()

Says the plugin proxy manager to store the settings and data of this plugin.

Returns:: True if the settings could be saved successfully.
Since:: 2.5.3

layoutWindow

public final void layoutWindow(java.lang.String windowId,
                               java.awt.Window window)

Sets the window position and size for the given window from remembered values for that id.

Parameters:: windowId - The relative id of the window. The ID only needs to unique for this plugin.; window - The window to layout.
Since:: 2.7

layoutWindow

public final void layoutWindow(java.lang.String windowId,
                               java.awt.Window window,
                               java.awt.Dimension defaultSize)

Sets the window position and size for the given window from remembered values for that id.

Parameters:: windowId - The relative id of the window. The ID only needs to unique for this plugin.; window - The window to layout.; defaultSize - The default size for the window.
Since:: 2.7

getRatingInterfaces

public ProgramRatingIf[] getRatingInterfaces()

If this plugin can rate programs, this interface makes it possible to offer this ratings to other plugins. You can get all ProgramRatingIfs of all plugins using PluginManager.getAllProgramRatingIfs() The plugin can return more than one ratingif, e.g. average ratings, user rating ...

Returns:: the RatingIfs of this plugin
Since:: 2.7

compareTo

public int compareTo(ProgramReceiveIf o)

Specified by:: compareTo in interface java.lang.Comparable<ProgramReceiveIf>

getImportanceValueForProgram

public ImportanceValue getImportanceValueForProgram(Program p)

Gets the importance value of a program.The importance of all active plugins is used to determinate the opacity of the used colors of a program, therefor a mean value of all values is used.

The importance value can be created as a weighted total of the following values.

Parameters:: p - The program to get the importance value for.
Returns:: The importance value for the given program.
Since:: 3.0

getPluginCategory

public java.lang.String getPluginCategory()

Gets the category of this plugin.

The category can be one of this values. Note: Don't use the NO_CATEGORY it's only for backward compatibility.

Returns:: The category of this plugin.
Since:: 3.0.2

getPluginCenterPanelWrapper

public PluginCenterPanelWrapper getPluginCenterPanelWrapper()

Gets the PluginCenterPanelWrapper for this plugin.

Returns:: The PluginCenterPanelWrapper for this plugin or null.
Since:: 3.2

getAfterDataUpdateInfoPanel

public AfterDataUpdateInfoPanel getAfterDataUpdateInfoPanel()

Gets a panel that contains infos that should be shown for this Plugins after a data update.

Returns:: The panel with the infos.
Since:: 3.2

handleTvBrowserSettingsChanged

public void handleTvBrowserSettingsChanged()

Is called when settings of TV-Browser or Plugins were changed, so this Plugin can react on that change.

Since:: 3.2

handleTvDataUpdateStarted

public void handleTvDataUpdateStarted()

Deprecated. since 3.3.3 Use handleTvDataUpdateStarted(Date) instead

Is called when a TV data update is started.

Since:: 3.2

handleTvDataUpdateStarted

public void handleTvDataUpdateStarted(Date until)

Is called when a TV data update is started.

Since:: 3.3.3

Overview

Package

Class

Tree

Deprecated

Index

Help

TV-Browser 3.3.3 API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

devplugin Class Plugin

ALL_CATEGORY

REMOTE_CONTROL_SOFTWARE_CATEGORY

REMOTE_CONTROL_HARDWARE_CATEGORY

ADDITONAL_DATA_SERVICE_SOFTWARE_CATEGORY

ADDITONAL_DATA_SERVICE_HARDWARE_CATEGORY

RATINGS_CATEGORY

OTHER_CATEGORY

BIG_ICON

NO_ICON_RESIZE

ACTION_ID_KEY

DISABLED_ON_TASK_MENU

SINGLE_CLICK_WAITING_TIME

mLocalizer

Plugin

setPluginManager

getPluginManager

getId

setParent

getParentFrame

createImageIcon

createImageIconForFileName

createImageIcon

createImageIcon

createImageIcon

readData

writeData

loadSettings

storeSettings

getVersion

getInfo

getContextMenuActions

getContextMenuActions

getProgramFromContextMenuActionEvent

getButtonAction

getProgramTableIconText

getProgramTableIcons

getSettingsTab

getMarkIcon

getMarkIcons

getMarkIconsForProgram

getMarkIconFromTheme

getMarkIconName

handleTvDataUpdateFinished

handleTvDataAdded

handleTvDataAdded

handleTvDataDeleted

handleTvDataTouched

onActivation

onDeactivation

canUseProgramTree

handleTvBrowserStartFinished

getRootNode

loadRootNode

storeRootNode

storeRootNode

canReceiveProgramsWithTarget

receivePrograms

receiveValues

getProgramReceiveTargets

getAvailableFilter

isAllowedToDeleteProgramFilter

toString

getAvailableFilterComponentClasses

getMarkPriorityForProgram

saveMe

layoutWindow

layoutWindow

getRatingInterfaces

compareTo

getImportanceValueForProgram

getPluginCategory

getPluginCenterPanelWrapper

getAfterDataUpdateInfoPanel

handleTvBrowserSettingsChanged

handleTvDataUpdateStarted

handleTvDataUpdateStarted

devplugin
Class Plugin