|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface PluginProxy
Encapsulates a plugin and manages the access to it.
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.
| Nested Class Summary | |
|---|---|
static class |
PluginProxy.Comparator
comparator for plugin proxy (sorting by name) |
| Method Summary | |
|---|---|
void |
addToArtificialPluginTree(MutableProgram program)
|
boolean |
canUseProgramTree()
|
PluginTreeNode |
getArtificialRootNode()
|
ActionMenu |
getButtonAction()
Gets the action to use for the main menu and the toolbar. |
String |
getPluginFileName()
return the file name of the plugin contained in this proxy |
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(Throwable t)
Handles a runtime exception that was caused by the plugin. |
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. |
boolean |
hasArtificialPluginTree()
|
boolean |
isActivated()
Gets whether the plugin is currently activated. |
boolean |
isAllowedToDeleteProgramFilter(PluginsProgramFilter programFilter)
|
void |
onActivation()
This method is automatically called, when the plugin after activating the plugin. |
void |
onDeactivation()
This method is automatically called, when the plugin after deactivating the plugin. |
| Methods inherited from interface devplugin.PluginAccess |
|---|
getAvailableFilter, getAvailableFilterComponentClasses, getId, getInfo, getMarkIcon, getMarkIcons, getProgramTableIcons, getProgramTableIconText |
| Methods inherited from interface tvbrowser.core.plugin.ButtonActionIf |
|---|
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 |
|---|
boolean isActivated()
SettingsTabProxy getSettingsTab()
null if the plugin does not
provide this feature.ActionMenu getButtonAction()
getButtonAction in interface ButtonActionIfnull
if the plugin does not provide this feature.void handleTvDataUpdateFinished()
handleTvDataAdded(ChannelDayProgram),
handleTvDataDeleted(ChannelDayProgram)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(Throwable t)
t - The exception to handleString getPluginFileName()
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
|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||