public interface PluginAccess extends ButtonActionIf, Marker, ProgramReceiveIf, ContextMenuIf
Contains all operations that may be called on a plugin from another plugin.
ACTIONKEY_KEYBOARD_EVENT
Modifier and Type | Method and Description |
---|---|
PluginsProgramFilter[] |
getAvailableFilter()
Returns the available program filters that the plugin supports.
|
java.lang.Class<? extends PluginsFilterComponent>[] |
getAvailableFilterComponentClasses()
Returns the available plugins filter component classes.
|
PluginCommunication |
getCommunicationClass()
If this Plugin grants access to functions it will provide a communication class for other Plugins to use.
|
java.lang.String |
getId()
Gets the ID of this plugin.
|
PluginInfo |
getInfo()
Gets the meta information about the plugin.
|
javax.swing.Icon |
getMarkIcon()
Gets the icon to use for marking programs in the program table.
|
javax.swing.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.
|
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.
|
ToolTipIcon[] |
getProgramTableToolTipIcons(Program program)
Gets the ToolTipIcons for the program table icons provided by this
Plugin.
|
getButtonAction, getButtonActionDescription
getMarkPriorityForProgram
canReceiveProgramsWithTarget, getProgramReceiveTargets, receivePrograms, receiveValues
getContextMenuActions
java.lang.String getId()
getId
in interface ButtonActionIf
getId
in interface ContextMenuIf
getId
in interface Marker
getId
in interface ProgramReceiveIf
PluginInfo getInfo()
java.lang.String getProgramTableIconText()
Return null
if your plugin does not provide this feature.
null
if the plugin does not provide this feature.getProgramTableIcons(Program)
ToolTipIcon[] getProgramTableToolTipIcons(Program program)
Override this method if your plugin provides icons for the program table (shown below the start time) and you want the icons to be shown in the tooltip.
program
- The program to get the ToolTipIcons for.null
if the plugin does not provide this feature.getProgramTableIcons(Program)
javax.swing.Icon[] getProgramTableIcons(Program program)
Return null
if your plugin does not provide this feature.
program
- The programs to get the icons for.null
.getProgramTableIconText()
javax.swing.Icon getMarkIcon()
getMarkIcon
in interface Marker
javax.swing.Icon[] getMarkIcons(Program p)
getMarkIcons
in interface Marker
PluginsProgramFilter[] getAvailableFilter()
null
if it supports no filter.java.lang.Class<? extends PluginsFilterComponent>[] getAvailableFilterComponentClasses()
(Class extends PluginsFilterComponent>[]) new Class[] {MyFilterComponent1.class,MyFilterComponent2.class};
because the creation of a class array with generic type didn't work.null
if no plugins filter components are supported.ProgramRatingIf[] getProgramRatingIfs()
PluginManager.getAllProgramRatingIfs()
The plugin can return more than one ratingif, e.g. average ratings, user rating ...PluginCommunication getCommunicationClass()
null
if there is no communication class for this Plugin.TV-Browser 3.4.3, Copyright (C) 2004-2008 TV-Browser Team (dev@tvbrowser.org)