devplugin

Class AbstractTvDataService

java.lang.Object

devplugin.AbstractTvDataService

All Implemented Interfaces:

ContextMenuIf, ButtonActionIf, TvDataService

Direct Known Subclasses:

BbcBackstageDataService, DreamboxDataService, RadioTimesDataService, SchedulesDirectDataService, SweDBTvDataService, TvBrowserDataService

public abstract class AbstractTvDataService
extends Object
implements TvDataService, TvDataService

Superclass for all TvDataServices.

Extend this class to provide your own TvDataService.

Constructor Summary

Constructors

Constructor and Description
AbstractTvDataService()

Method Summary

Methods

Modifier and Type	Method and Description
Channel[]	checkForAvailableChannels(ProgressMonitor monitor)
Version	getAPIVersion() Gets the Version of the implemented API Since TV-Browser 0.9.7 getAPIVersion must return 1.0
Channel[]	getAvailableChannels() Gets the list of the channels that are available by this data service.
ActionMenu	getButtonAction() Gets the action menu with the action supported for toolbar actions.
String	getButtonActionDescription() Gets the description for this ButtonActionIf.
ActionMenu	getContextMenuActions(Program program) Gets the actions for the context menu of a program.
String	getId() Gets the id of this ButtonActionIf.
Frame	getParentFrame() Gets the parent frame.
static PluginManager	getPluginManager() Use this method to call methods of the plugin manager.
static Version	getVersion() Gets the version of this data service.
void	handleTvBrowserStartFinished() This method is called when the TV-Browser start is complete.
void	setParent(Frame parent) Called by the host-application to provide the parent frame.
static void	setPluginManager(PluginManager manager) Called by the host-application to provide access to the plugin manager.
boolean	supportsAutoUpdate() Gets if the data service supports auto upate of data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface devplugin.TvDataService

checkForAvailableChannelGroups, checkForAvailableChannels, getAvailableChannels, getAvailableGroups, getInfo, getSettingsPanel, hasSettingsPanel, loadSettings, setWorkingDirectory, storeSettings, supportsDynamicChannelGroups, supportsDynamicChannelList, updateTvData

Methods inherited from interface tvdataservice.TvDataService

getInfo, getSettingsPanel, hasSettingsPanel, loadSettings, setWorkingDirectory, storeSettings, supportsDynamicChannelList, updateTvData

Constructor Detail

AbstractTvDataService

public AbstractTvDataService()

Method Detail

getAvailableChannels

public final Channel[] getAvailableChannels()

Description copied from interface: TvDataService

Gets the list of the channels that are available by this data service.

Specified by:

getAvailableChannels in interface TvDataService

checkForAvailableChannels

public final Channel[] checkForAvailableChannels(ProgressMonitor monitor)
                                          throws TvBrowserException

Specified by:

checkForAvailableChannels in interface TvDataService

Throws:

TvBrowserException

getAPIVersion

public final Version getAPIVersion()

Description copied from interface: TvDataService

Gets the Version of the implemented API Since TV-Browser 0.9.7 getAPIVersion must return 1.0

Specified by:

getAPIVersion in interface TvDataService

getPluginManager

public static final PluginManager getPluginManager()

Use this method to call methods of the plugin manager.

The plugin manager is your connection to TV-Browser. Every communication between TV-Browser and the data service is either initiated by TV-Browser or made by using the plugin manager.

Returns:

The plugin manager.

Since:

2.6

setPluginManager

public static final void setPluginManager(PluginManager manager)

Called by the host-application to provide access to the plugin manager.

Parameters:

manager - The plugin manager the plugins should use.

getVersion

public static Version getVersion()

Gets the version of this data service.

Returns:

The version of this data service.

setParent

public final void setParent(Frame parent)

Called by the host-application to provide the parent frame.

Parameters:

parent - The parent frame.

Since:

2.7

getParentFrame

public final Frame getParentFrame()

Gets the parent frame.

The parent frame may be used for showing dialogs.

Returns:

The parent frame.

Since:

2.7

handleTvBrowserStartFinished

public void handleTvBrowserStartFinished()

This method is called when the TV-Browser start is complete.

Since:

2.7

supportsAutoUpdate

public boolean supportsAutoUpdate()

Gets if the data service supports auto upate of data.

Specified by:

supportsAutoUpdate in interface TvDataService

Returns:

True if the data service supports the auto update, false otherwise.

Since:

2.7

getButtonAction

public ActionMenu getButtonAction()

Gets the action menu with the action supported for toolbar actions.

Specified by:

getButtonAction in interface ButtonActionIf

Returns:

The action menu with the supported toolbar actions

getId

public final String getId()

Gets the id of this ButtonActionIf.

Specified by:

getId in interface ContextMenuIf

Specified by:

getId in interface ButtonActionIf

Returns:

The id of this ButtonActionIf.

getButtonActionDescription

public String getButtonActionDescription()

Gets the description for this ButtonActionIf.

Specified by:

getButtonActionDescription in interface ButtonActionIf

Returns:

The description for this ButtonActionIf.

getContextMenuActions

public ActionMenu getContextMenuActions(Program program)

Gets the actions for the context menu of a program.

Specified by:

getContextMenuActions in interface ContextMenuIf

Parameters:

program - The program the context menu will be shown for.

Returns:

the actions this plugin provides for the given program or null if the plugin does not provide this feature.