public class BeanShellPluginProxy extends AbstractPluginProxy
mLocalizer
Constructor and Description |
---|
BeanShellPluginProxy(File bshFile) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
doCanReceivePrograms()
Really gets whether the plugin supports receiving programs from other
plugins.
|
boolean |
doCanUseProgramTree() |
protected ActionMenu |
doGetButtonAction()
Really gets the action to use for the main menu and the toolbar.
|
protected PluginInfo |
doGetInfo()
Really gets the meta information about the plugin.
|
protected Icon |
doGetMarkIcon()
Really gets the icon to use for marking programs in the program table.
|
protected Icon[] |
doGetProgramTableIcons(Program program)
Really gets the icons this Plugin provides for the given program.
|
protected String |
doGetProgramTableIconText()
Gets the description text for the program table icons provided by this
Plugin.
|
protected SettingsTabProxy |
doGetSettingsTab()
Rally gets the SettingsTab object, which is added to the settings-window.
|
protected void |
doHandleTvBrowserStartFinished() |
protected void |
doHandleTvDataAdded(ChannelDayProgram newProg)
This method is automatically called, when TV data was added.
|
protected void |
doHandleTvDataDeleted(ChannelDayProgram oldProg)
This method is automatically called, when TV data was deleted.
|
protected void |
doHandleTvDataUpdateFinished()
This method is automatically called, when the TV data update is finished.
|
protected void |
doLoadSettings(File userDirectory)
Really loads the settings for this plugin.
|
void |
doOnActivation() |
void |
doOnDeactivation() |
protected void |
doReceivePrograms(Program[] programArr)
Really receives a list of programs from another plugin.
|
protected void |
doSaveSettings(File userDirectory) |
protected void |
doSaveSettings(File userDirectory,
boolean log)
Really saves the settings for this plugin.
|
String |
getId()
Gets the ID of this plugin.
|
PluginTreeNode |
getRootNode() |
protected ActionMenu |
goGetContextMenuActions(Program program)
Really gets the actions for the context menu of a program.
|
(package private) void |
setParentFrame(Frame parent)
Sets the parent frame to the plugin.
|
assertActivatedState, canReceivePrograms, canUseProgramTree, getButtonAction, getContextMenuActions, getInfo, getMarkIcon, getProgramTableIcons, getProgramTableIconText, getSettingsTab, handlePluginException, handleTvBrowserStartFinished, handleTvDataAdded, handleTvDataDeleted, handleTvDataUpdateFinished, isActivated, loadSettings, onActivation, onDeactivation, receivePrograms, saveSettings, setActivated, toString
public BeanShellPluginProxy(File bshFile)
void setParentFrame(Frame parent)
AbstractPluginProxy
setParentFrame
in class AbstractPluginProxy
parent
- The parent frame to set.protected void doLoadSettings(File userDirectory) throws TvBrowserException
AbstractPluginProxy
doLoadSettings
in class AbstractPluginProxy
userDirectory
- The directory where the user data is stored.TvBrowserException
- If loading failed.protected void doSaveSettings(File userDirectory) throws TvBrowserException
TvBrowserException
protected void doSaveSettings(File userDirectory, boolean log) throws TvBrowserException
AbstractPluginProxy
doSaveSettings
in class AbstractPluginProxy
userDirectory
- The directory where the user data is stored.TvBrowserException
- If saving failed.protected PluginInfo doGetInfo()
AbstractPluginProxy
doGetInfo
in class AbstractPluginProxy
protected boolean doCanReceivePrograms()
AbstractPluginProxy
doCanReceivePrograms
in class AbstractPluginProxy
AbstractPluginProxy.receivePrograms(Program[])
protected void doReceivePrograms(Program[] programArr)
AbstractPluginProxy
doReceivePrograms
in class AbstractPluginProxy
programArr
- The programs passed from the other plugin.AbstractPluginProxy.canReceivePrograms()
protected SettingsTabProxy doGetSettingsTab()
AbstractPluginProxy
doGetSettingsTab
in class AbstractPluginProxy
null
if the plugin does
not provide this feature.protected ActionMenu goGetContextMenuActions(Program program)
AbstractPluginProxy
goGetContextMenuActions
in class AbstractPluginProxy
program
- The program the context menu will be shown for.null
if the plugin does not provide this feature.AbstractPluginProxy.getContextMenuActions(Program)
protected ActionMenu doGetButtonAction()
AbstractPluginProxy
doGetButtonAction
in class AbstractPluginProxy
null
if the plugin does not provide this feature.AbstractPluginProxy.getButtonAction()
protected Icon doGetMarkIcon()
AbstractPluginProxy
doGetMarkIcon
in class AbstractPluginProxy
protected String doGetProgramTableIconText()
AbstractPluginProxy
Return null
if your plugin does not provide this feature.
doGetProgramTableIconText
in class AbstractPluginProxy
null
if the plugin does not provide this feature.AbstractPluginProxy.getProgramTableIcons(Program)
protected Icon[] doGetProgramTableIcons(Program program)
AbstractPluginProxy
Return null
if your plugin does not provide this feature.
doGetProgramTableIcons
in class AbstractPluginProxy
program
- The programs to get the icons for.null
.AbstractPluginProxy.getProgramTableIconText()
protected void doHandleTvDataUpdateFinished()
AbstractPluginProxy
protected void doHandleTvDataAdded(ChannelDayProgram newProg)
AbstractPluginProxy
The TV data may be modified by the plugin! So this method must be called before new TV data is saved.
doHandleTvDataAdded
in class AbstractPluginProxy
newProg
- The new ChannelDayProgram.AbstractPluginProxy.handleTvDataDeleted(ChannelDayProgram)
,
AbstractPluginProxy.handleTvDataUpdateFinished()
protected void doHandleTvBrowserStartFinished()
doHandleTvBrowserStartFinished
in class AbstractPluginProxy
protected void doHandleTvDataDeleted(ChannelDayProgram oldProg)
AbstractPluginProxy
doHandleTvDataDeleted
in class AbstractPluginProxy
oldProg
- The old ChannelDayProgram which was deleted.AbstractPluginProxy.handleTvDataAdded(ChannelDayProgram)
,
AbstractPluginProxy.handleTvDataUpdateFinished()
public String getId()
PluginAccess
public void doOnActivation()
doOnActivation
in class AbstractPluginProxy
public void doOnDeactivation()
doOnDeactivation
in class AbstractPluginProxy
public boolean doCanUseProgramTree()
doCanUseProgramTree
in class AbstractPluginProxy
public PluginTreeNode getRootNode()
TV-Browser 2.2.6, Copyright (C) 04-2003 Martin Oberhauser (martin@tvbrowser.org)