|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objecttvbrowser.core.plugin.AbstractPluginProxy
tvbrowser.core.plugin.BeanShellPluginProxy
public class BeanShellPluginProxy
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface tvbrowser.core.plugin.PluginProxy |
|---|
PluginProxy.Comparator |
| Field Summary |
|---|
| Fields inherited from class tvbrowser.core.plugin.AbstractPluginProxy |
|---|
mLocalizer |
| Constructor Summary | |
|---|---|
BeanShellPluginProxy(File bshFile)
|
|
| Method Summary | |
|---|---|
protected boolean |
doCanReceivePrograms()
Deprecated. Since 2.5 |
protected boolean |
doCanReceiveProgramsWithTarget()
Really gets whether the plugin supports receiving programs from other plugins with target. |
boolean |
doCanUseProgramTree()
|
protected PluginsProgramFilter[] |
doGetAvailableFilter()
Really returns the available program filters that the plugin supports. |
protected Class<? extends PluginsFilterComponent>[] |
doGetAvailableFilterComponentClasses()
Really gets the available filter component classes. |
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[] |
doGetMarkIcons(Program p)
Really gets the icon to use for marking programs in the program table. |
protected int |
doGetMarkPriorityForProgram(Program p)
Really gets the mark priority for the given Program. |
protected ProgramReceiveTarget[] |
doGetProgramReceiveTargets()
Really return an array of receive target or null if there is no target |
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 |
doHandleTvDataAdded(MutableChannelDayProgram 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 |
doHandleTvDataTouched(ChannelDayProgram removedDayProgram,
ChannelDayProgram addedDayProgram)
This method is automatically called, when TV data was added. |
protected void |
doHandleTvDataUpdateFinished()
This method is automatically called, when the TV data update is finished. |
protected boolean |
doIsAllowedToDeleteProgramFilter(PluginsProgramFilter programFilter)
Really return if a program filter can be deleted. |
protected void |
doLoadSettings(File userDirectory)
Really loads the settings for this plugin. |
void |
doOnActivation()
|
void |
doOnDeactivation()
|
protected void |
doReceivePrograms(Program[] programArr)
Deprecated. Since 2.5 |
protected boolean |
doReceivePrograms(Program[] programArr,
ProgramReceiveTarget receiveTarget)
Really receives a list of programs from another plugin with target. |
protected boolean |
doReceiveValues(String[] values,
ProgramReceiveTarget receiveTarget)
Really receives a list of Strings from another plugin with a target. |
protected void |
doSaveSettings(File userDirectory)
|
protected void |
doSaveSettings(File userDirectory,
boolean log)
Really saves the settings for this plugin. |
String |
getButtonActionDescription()
Gets the description for this ButtonActionIf. |
String |
getId()
Gets the id of this ButtonActionIf. |
String |
getPluginFileName()
return the file name of the plugin contained in this proxy |
ProgramRatingIf[] |
getProgramRatingIfs()
If this plugin can rate programs, this interface makes it possible to offer this ratings to other plugins. |
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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public BeanShellPluginProxy(File bshFile)
| Method Detail |
|---|
void setParentFrame(Frame parent)
AbstractPluginProxy
setParentFrame in class AbstractPluginProxyparent - The parent frame to set.
protected void doLoadSettings(File userDirectory)
throws TvBrowserException
AbstractPluginProxy
doLoadSettings in class AbstractPluginProxyuserDirectory - 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 AbstractPluginProxyuserDirectory - The directory where the user data is stored.
TvBrowserException - If saving failed.protected PluginInfo doGetInfo()
AbstractPluginProxy
doGetInfo in class AbstractPluginProxyprotected boolean doCanReceivePrograms()
AbstractPluginProxy
doCanReceivePrograms in class AbstractPluginProxyAbstractPluginProxy.doCanReceivePrograms()protected void doReceivePrograms(Program[] programArr)
AbstractPluginProxy
doReceivePrograms in class AbstractPluginProxyprogramArr - The programs passed from the other plugin.AbstractPluginProxy.doReceivePrograms(devplugin.Program[])protected SettingsTabProxy doGetSettingsTab()
AbstractPluginProxy
doGetSettingsTab in class AbstractPluginProxynull if the plugin does
not provide this feature.protected ActionMenu goGetContextMenuActions(Program program)
AbstractPluginProxy
goGetContextMenuActions in class AbstractPluginProxyprogram - 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 AbstractPluginProxynull
if the plugin does not provide this feature.AbstractPluginProxy.getButtonAction()protected Icon[] doGetMarkIcons(Program p)
AbstractPluginProxy
doGetMarkIcons in class AbstractPluginProxyprotected String doGetProgramTableIconText()
AbstractPluginProxy
Return null if your plugin does not provide this feature.
doGetProgramTableIconText in class AbstractPluginProxynull 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 AbstractPluginProxyprogram - The programs to get the icons for.
null.AbstractPluginProxy.getProgramTableIconText()protected void doHandleTvDataUpdateFinished()
AbstractPluginProxy
doHandleTvDataUpdateFinished in class AbstractPluginProxyAbstractPluginProxy.handleTvDataAdded(ChannelDayProgram),
AbstractPluginProxy.handleTvDataDeleted(ChannelDayProgram)protected void doHandleTvDataAdded(ChannelDayProgram newProg)
AbstractPluginProxyThe TV data may be modified by the plugin! So this method must be called before new TV data is saved.
doHandleTvDataAdded in class AbstractPluginProxynewProg - The new ChannelDayProgram.AbstractPluginProxy.handleTvDataDeleted(ChannelDayProgram),
AbstractPluginProxy.handleTvDataUpdateFinished()protected void doHandleTvBrowserStartFinished()
doHandleTvBrowserStartFinished in class AbstractPluginProxyprotected void doHandleTvDataDeleted(ChannelDayProgram oldProg)
AbstractPluginProxy
doHandleTvDataDeleted in class AbstractPluginProxyoldProg - The old ChannelDayProgram which was deleted.AbstractPluginProxy.handleTvDataAdded(ChannelDayProgram),
AbstractPluginProxy.handleTvDataUpdateFinished()public String getId()
ButtonActionIf
public void doOnActivation()
doOnActivation in class AbstractPluginProxypublic void doOnDeactivation()
doOnDeactivation in class AbstractPluginProxypublic boolean doCanUseProgramTree()
doCanUseProgramTree in class AbstractPluginProxypublic PluginTreeNode getRootNode()
protected boolean doCanReceiveProgramsWithTarget()
AbstractPluginProxy
doCanReceiveProgramsWithTarget in class AbstractPluginProxyAbstractPluginProxy.receivePrograms(Program[],ProgramReceiveTarget)
protected boolean doReceivePrograms(Program[] programArr,
ProgramReceiveTarget receiveTarget)
AbstractPluginProxy
doReceivePrograms in class AbstractPluginProxyprogramArr - The programs passed from the other plugin with target.receiveTarget - The target of the programs.AbstractPluginProxy.canReceiveProgramsWithTarget()protected ProgramReceiveTarget[] doGetProgramReceiveTargets()
AbstractPluginProxynull if there is no target
doGetProgramReceiveTargets in class AbstractPluginProxyAbstractPluginProxy.canReceiveProgramsWithTarget(),
AbstractPluginProxy.receivePrograms(Program[],ProgramReceiveTarget)protected PluginsProgramFilter[] doGetAvailableFilter()
AbstractPluginProxy
doGetAvailableFilter in class AbstractPluginProxynull if it supports no filter.protected boolean doIsAllowedToDeleteProgramFilter(PluginsProgramFilter programFilter)
AbstractPluginProxy
doIsAllowedToDeleteProgramFilter in class AbstractPluginProxyprogramFilter - The program filter to delete.
protected Class<? extends PluginsFilterComponent>[] doGetAvailableFilterComponentClasses()
AbstractPluginProxy
doGetAvailableFilterComponentClasses in class AbstractPluginProxynull if no plugins filter components are supported.protected int doGetMarkPriorityForProgram(Program p)
AbstractPluginProxy
doGetMarkPriorityForProgram in class AbstractPluginProxyp - The program to get the mark priority for.
public String getPluginFileName()
PluginProxy
public ProgramRatingIf[] getProgramRatingIfs()
PluginProxyPluginManager.getAllProgramRatingIfs()
The plugin can return more than one ratingif, e.g. average ratings, user rating ...
public String getButtonActionDescription()
ButtonActionIf
protected void doHandleTvDataAdded(MutableChannelDayProgram newProg)
AbstractPluginProxyThe TV data can be modified by the plugin!
Override this method if you want to change/add data.
Don't do other things than changing/adding data,
use AbstractPluginProxy.handleTvDataAdded(ChannelDayProgram) istead.
doHandleTvDataAdded in class AbstractPluginProxynewProg - The new ChannelDayProgram.AbstractPluginProxy.handleTvDataDeleted(ChannelDayProgram),
#handleTvDataChanged()
protected boolean doReceiveValues(String[] values,
ProgramReceiveTarget receiveTarget)
AbstractPluginProxy
doReceiveValues in class AbstractPluginProxyvalues - The value array passed from the other plugin.
True if the value array was handled correct,
false otherwise.AbstractPluginProxy.canReceiveProgramsWithTarget()
protected void doHandleTvDataTouched(ChannelDayProgram removedDayProgram,
ChannelDayProgram addedDayProgram)
AbstractPluginProxyThe TV data may be modified by the plugin! So this method must be called before new TV data is saved.
doHandleTvDataTouched in class AbstractPluginProxyAbstractPluginProxy.handleTvDataAdded(ChannelDayProgram),
AbstractPluginProxy.handleTvDataDeleted(ChannelDayProgram),
AbstractPluginProxy.handleTvDataUpdateFinished()
|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||