devplugin

Interface PluginAccess

All Superinterfaces:

ButtonActionIf, ContextMenuIf, Marker, ProgramReceiveIf

All Known Subinterfaces:

PluginProxy

All Known Implementing Classes:

AbstractPluginProxy, BeanShellPluginProxy, JavaPluginProxy

public interface PluginAccess
extends ButtonActionIf, Marker, ProgramReceiveIf, ContextMenuIf

An access to another plugin.

Contains all operations that may be called on a plugin from another plugin.

Author:

Til Schneider, www.murfman.de

Method Summary

Methods

Modifier and Type	Method and Description
PluginsProgramFilter[]	getAvailableFilter() Returns the available program filters that the plugin supports.
Class<? extends PluginsFilterComponent>[]	getAvailableFilterComponentClasses() Returns the available plugins filter component classes.
String	getId() Gets the ID of this plugin.
PluginInfo	getInfo() Gets the meta information about the plugin.
Icon	getMarkIcon() Gets the icon to use for marking programs in the program table.
Icon[]	getMarkIcons(Program p) Gets the icons to use for marking programs in the program table.
ProgramRatingIf[]	getProgramRatingIfs() If this plugin can rate programs, this interface makes it possible to offer this ratings to other plugins.
Icon[]	getProgramTableIcons(Program program) Gets the icons this Plugin provides for the given program.
String	getProgramTableIconText() Gets the description text for the program table icons provided by this Plugin.

Methods inherited from interface tvbrowser.core.plugin.ButtonActionIf

getButtonAction, getButtonActionDescription

Methods inherited from interface devplugin.Marker

getMarkPriorityForProgram

Methods inherited from interface devplugin.ProgramReceiveIf

canReceivePrograms, canReceiveProgramsWithTarget, getProgramReceiveTargets, receivePrograms, receivePrograms, receiveValues

Methods inherited from interface devplugin.ContextMenuIf

getContextMenuActions

Method Detail

getId

String getId()

Gets the ID of this plugin.

Specified by:

getId in interface ButtonActionIf

Specified by:

getId in interface ContextMenuIf

Specified by:

getId in interface Marker

Specified by:

getId in interface ProgramReceiveIf

Returns:

The ID of this plugin.

getInfo

PluginInfo getInfo()

Gets the meta information about the plugin.

Returns:

The meta information about the plugin.

getProgramTableIconText

String getProgramTableIconText()

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

Return null if your plugin does not provide this feature.

Returns:

The description text for the program table icons or null if the plugin does not provide this feature.

See Also:

getProgramTableIcons(Program)

getProgramTableIcons

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.

Return null if your plugin does not provide this feature.

Parameters:

program - The programs to get the icons for.

Returns:

The icons for the given program or null.

See Also:

getProgramTableIconText()

getMarkIcon

Icon getMarkIcon()

Gets the icon to use for marking programs in the program table. Should be 16x16.

Specified by:

getMarkIcon in interface Marker

Returns:

the icon to use for marking programs in the program table.

getMarkIcons

Icon[] getMarkIcons(Program p)

Gets the icons to use for marking programs in the program table. Should be 16x16.

Specified by:

getMarkIcons in interface Marker

Returns:

the icons to use for marking programs in the program table.

Since:

2.5

getAvailableFilter

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

getAvailableFilterComponentClasses

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

getProgramRatingIfs

ProgramRatingIf[] getProgramRatingIfs()

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