public interface PluginProxy extends PluginAccess, InfoIf
All operations that are only accessable from TV-Browser itself is defined in
this interface. All operations that are accessable by other plugins are
defined in PluginAccess
.
Modifier and Type | Interface and Description |
---|---|
static class |
PluginProxy.Comparator
comparator for plugin proxy (sorting by name)
|
ACTIONKEY_KEYBOARD_EVENT
Modifier and Type | Method and Description |
---|---|
void |
addToArtificialPluginTree(MutableProgram program) |
boolean |
canUseProgramTree() |
ProgramInfo[] |
getAddtionalProgramInfoForProgram(Program p,
java.lang.String uniqueId)
Gets additional program infos for the given program.
|
AfterDataUpdateInfoPanel |
getAfterDataUpdateInfoPanel()
Gets a panel that contains infos that should be
shown for this Plugins after a data update.
|
PluginTreeNode |
getArtificialRootNode() |
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.
|
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.
|
PluginCenterPanelWrapper |
getPluginCenterPanelWrapper()
Gets the PluginCenterPanelWrapper for this plugin.
|
java.lang.String |
getPluginFileName()
return the file name of the plugin contained in this proxy
|
javax.swing.Icon |
getPluginIcon()
get the icon to represent this plugin in the settings
|
ProgramRatingIf[] |
getProgramRatingIfs()
If this plugin can rate programs, this interface makes it possible to offer this ratings
to other plugins.
|
PluginTreeNode |
getRootNode() |
SettingsTabProxy |
getSettingsTab()
Gets the SettingsTab object, which is added to the settings-window.
|
void |
handlePluginException(java.lang.Throwable t)
Handles a runtime exception that was caused by the 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 |
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(Date until)
Is called when a TV data update is started.
|
boolean |
hasArtificialPluginTree() |
boolean |
isActivated()
Gets whether the plugin is currently activated.
|
boolean |
isAllowedToDeleteProgramFilter(PluginsProgramFilter programFilter) |
void |
onActivation()
This method is automatically called after activating the plugin (either
during the TV-Browser startup phase or after manually activating the
disabled plugin in the settings).
|
void |
onDeactivation()
This method is automatically called after deactivating the plugin.
|
getAvailableFilter, getAvailableFilterComponentClasses, getCommunicationClass, getId, getInfo, getMarkIcon, getMarkIcons, getProgramTableIcons, getProgramTableIconText, getProgramTableToolTipIcons
getButtonActionDescription
getMarkPriorityForProgram
canReceiveProgramsWithTarget, getProgramReceiveTargets, receivePrograms, receiveValues
getContextMenuActions
getId, getInfo, getPluginCategory
boolean isActivated()
SettingsTabProxy getSettingsTab()
null
if the plugin does not
provide this feature.ActionMenu getButtonAction()
getButtonAction
in interface ButtonActionIf
null
if the plugin does not provide this feature.void handleTvDataUpdateFinished()
void handleTvDataAdded(ChannelDayProgram newProg)
The TV data may be modified by the plugin! So this method must be called before new TV data is saved.
newProg
- The new ChannelDayProgram.handleTvDataDeleted(ChannelDayProgram)
,
handleTvDataUpdateFinished()
void handleTvDataTouched(ChannelDayProgram removedDayProgram, ChannelDayProgram addedDayProgram)
removedDayProgram
- The old ChannelDayProgram.addedDayProgram
- The new ChannelDayProgram.handleTvDataAdded(ChannelDayProgram)
,
handleTvDataDeleted(ChannelDayProgram)
,
handleTvDataUpdateFinished()
void handleTvDataDeleted(ChannelDayProgram oldProg)
oldProg
- The old ChannelDayProgram which was deleted.handleTvDataAdded(ChannelDayProgram)
,
handleTvDataUpdateFinished()
void onActivation()
void onDeactivation()
boolean canUseProgramTree()
PluginTreeNode getRootNode()
void handleTvBrowserStartFinished()
void handlePluginException(java.lang.Throwable t)
t
- The exception to handlejava.lang.String getPluginFileName()
javax.swing.Icon getPluginIcon()
boolean hasArtificialPluginTree()
void addToArtificialPluginTree(MutableProgram program)
PluginTreeNode getArtificialRootNode()
boolean isAllowedToDeleteProgramFilter(PluginsProgramFilter programFilter)
ProgramRatingIf[] getProgramRatingIfs()
PluginManager.getAllProgramRatingIfs()
The plugin can return more than one ratingif, e.g. average ratings, user rating ...getProgramRatingIfs
in interface PluginAccess
ActionMenu getContextMenuActions(Channel channel)
channel
- The channel the context menu will be shown for.null
if the plugin does not provide this feature.ImportanceValue getImportanceValueForProgram(Program p)
The importance value can be created as a weighted total of the following values.
p
- The program to get the importance value for.PluginCenterPanelWrapper getPluginCenterPanelWrapper()
PluginCenterPanelWrapper
for this plugin or null
.AfterDataUpdateInfoPanel getAfterDataUpdateInfoPanel()
void handleTvBrowserSettingsChanged()
void handleTvDataUpdateStarted(Date until)
until
- The last date the data is updated for.ProgramInfo[] getAddtionalProgramInfoForProgram(Program p, java.lang.String uniqueId)
example Program
.
Every additional info must have an unique ID, so the
name might be changed but the ID never must.
p
- The program to get the additional program info for.uniqueId
- If not null
the id of the program info to get.null
if no additional info is available.TV-Browser 3.4.4, Copyright (C) 2004-2008 TV-Browser Team (dev@tvbrowser.org)