|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectdevplugin.Plugin
imdbplugin.ImdbPlugin
public class ImdbPlugin
| Field Summary |
|---|
| Fields inherited from class devplugin.Plugin |
|---|
BIG_ICON, DISABLED_ON_TASK_MENU, parent, SINGLE_CLICK_WAITING_TIME |
| Constructor Summary | |
|---|---|
ImdbPlugin()
|
|
| Method Summary | |
|---|---|
ActionMenu |
getContextMenuActions(Program program)
Gets the actions for the context menu of a program. |
Channel[] |
getExcludedChannels()
|
PluginInfo |
getInfo()
Gets the meta information about the plugin. |
Icon[] |
getProgramTableIcons(Program program)
Gets the icons this Plugin provides for the given program. |
String |
getProgramTableIconText()
Gets the description text for the program table icons provided by this Plugin. |
ProgramRatingIf[] |
getRatingInterfaces()
If this plugin can rate programs, this interface makes it possible to offer this ratings to other plugins. |
SettingsTab |
getSettingsTab()
Gets the SettingsTab object, which is added to the settings-window. |
static Version |
getVersion()
|
void |
handleTvBrowserStartFinished()
This method is called when the TV-Browser start is finished. |
void |
loadSettings(Properties settings)
Called by the host-application during start-up. |
void |
readData(ObjectInputStream in)
Called by the host-application during start-up. |
void |
setExcludedChannels(Channel[] excludedChannels)
|
void |
showUpdateDialog()
|
Properties |
storeSettings()
Called by the host-application during shut-down. |
void |
updateCurrentDateAndClearCache()
Force an update of the currently shown programs in the program table where we need to add/update a rating. |
void |
writeData(ObjectOutputStream out)
Counterpart to loadData. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public ImdbPlugin()
| Method Detail |
|---|
public PluginInfo getInfo()
PluginOverride this method to provide information about your plugin.
getInfo in class Pluginpublic static Version getVersion()
public Icon[] getProgramTableIcons(Program program)
PluginOverride this method to return the icons for the program table (shown below the start time).
This method is only called, if the option to show program table icons for this plugin is set in the options.
getProgramTableIcons in class Pluginprogram - The programs to get the icons for.
null if the plugin
does not provide this feature.Plugin.getProgramTableIconText()public ActionMenu getContextMenuActions(Program program)
Plugin
Override this method to provide context menu items for programs (e.g. in
the program table). If your plugin shows a context menu only for some
programs, but not for all, then you should explicitly return a non-null
menu for the example program. Otherwise your context menu will not be shown
in the settings dialog for the context menu order.
The following action values will be used:
Action.NAME: The text for the context menu item.Action.SMALL_ICON: The icon for the context menu item.
Should be 16x16.
getContextMenuActions in interface ContextMenuIfgetContextMenuActions in class Pluginprogram - The program the context menu will be shown for.
null if the plugin does not provide this feature.Plugin.getProgramFromContextMenuActionEvent(ActionEvent)public String getProgramTableIconText()
PluginOverride this method if your plugin provides icons for the program table (shown below the start time). The returned String will be shown in settings dialog (german: Aussehen->Sendungsanzeige->Plugin-Icons).
getProgramTableIconText in class Pluginnull if the plugin does not provide this feature.Plugin.getProgramTableIcons(Program)public void handleTvBrowserStartFinished()
Plugin
handleTvBrowserStartFinished in class Pluginpublic void showUpdateDialog()
public void loadSettings(Properties settings)
PluginOverride this method to load your plugins settings from the file system.
loadSettings in class Pluginsettings - The settings for this plugin (May be empty).public Properties storeSettings()
PluginOverride this method to store your plugins settings to the file system. ATTENTION: Don't use any logger, thread or access to Frames in this method.
storeSettings in class Pluginnull if this plugin
does not need to save any settings.
public void readData(ObjectInputStream in)
throws IOException,
ClassNotFoundException
PluginOverride this method to load any objects from the file system.
readData in class Pluginin - The stream to read the objects from.
IOException - If reading failed.
ClassNotFoundException - If an object could not be casted correctly.Plugin.writeData(ObjectOutputStream)
public void writeData(ObjectOutputStream out)
throws IOException
PluginOverride this method to store any objects to the file system. ATTENTION: Don't use any logger, thread or access to Frames in this method.
writeData in class Pluginout - The stream to write the objects to
IOException - If writing failed.Plugin.readData(ObjectInputStream)public SettingsTab getSettingsTab()
PluginOverride this method to provide a settings tab. The settings tab will be shown in the settings dialog in the plugin section.
getSettingsTab in class Pluginnull if the plugin does not
provide this feature.public void updateCurrentDateAndClearCache()
public Channel[] getExcludedChannels()
public void setExcludedChannels(Channel[] excludedChannels)
public ProgramRatingIf[] getRatingInterfaces()
PluginPluginManager.getAllProgramRatingIfs()
The plugin can return more than one ratingif, e.g. average ratings, user rating ...
getRatingInterfaces in class Plugin
|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||