|
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
captureplugin.CapturePlugin
public class CapturePlugin
Plugin to send the TV-Data to an external program
| Field Summary |
|---|
| Fields inherited from class devplugin.Plugin |
|---|
BIG_ICON, DISABLED_ON_TASK_MENU, parent, SINGLE_CLICK_WAITING_TIME |
| Constructor Summary | |
|---|---|
CapturePlugin()
Creates the Plugin |
|
| Method Summary | |
|---|---|
boolean |
canReceiveProgramsWithTarget()
Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target. |
boolean |
canUseProgramTree()
Signal whether this plugin participates in the plugin tree view or not. |
ActionMenu |
getButtonAction()
Gets the action to use for the main menu and the toolbar. |
CapturePluginData |
getCapturePluginData()
Returns the CapturePluginData |
ActionMenu |
getContextMenuActions(Program program)
Gets the actions for the context menu of a program. |
PluginInfo |
getInfo()
Implement this function to provide information about your plugin. |
static CapturePlugin |
getInstance()
Returns this Instance |
ThemeIcon |
getMarkIconFromTheme()
This gets the ThemeIcon containg your mark icon. |
int |
getMarkPriorityForProgram(Program p)
Gets the mark priority for the given program that this Plugin uses. |
ProgramReceiveTarget[] |
getProgramReceiveTargets()
Returns an array of receive target or null if there is no target |
PluginTreeNode |
getRootNode()
Get the Root-Node. |
SettingsTab |
getSettingsTab()
Returns a new SettingsTab object, which is added to the settings-window. |
Frame |
getSuperFrame()
|
static Version |
getVersion()
|
void |
handleTvBrowserStartFinished()
This method is called when the TV-Browser start is finished. |
void |
handleTvDataUpdateFinished()
Check the programs after data update. |
void |
loadSettings(Properties settings)
Called by the host-application during start-up. |
void |
readData(ObjectInputStream in)
Called by the host-application during start-up. |
boolean |
receivePrograms(Program[] programArr,
ProgramReceiveTarget receiveTarget)
Receives a list of programs from another plugin with a target. |
void |
setCapturePluginData(CapturePluginData data)
Sets the CaputePluginData |
void |
showDialog()
This method is invoked by the host-application if the user has choosen your plugin from the menu. |
Properties |
storeSettings()
Called by the host-application during shut-down. |
void |
updateMarkedPrograms()
Updates the marked Programs. |
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 CapturePlugin()
| Method Detail |
|---|
public static CapturePlugin getInstance()
public void readData(ObjectInputStream in)
throws IOException,
ClassNotFoundException
readData in class Pluginin - The stream to read the objects from.
IOException - If reading failed.
ClassNotFoundException - If an object could not be casted correctly.writeData(ObjectOutputStream)
public void writeData(ObjectOutputStream out)
throws IOException
writeData in class Pluginout - The stream to write the objects to
IOException - If writing failed.readData(ObjectInputStream)public void loadSettings(Properties settings)
loadSettings in class Pluginsettings - The settings for this plugin (May be empty).public Properties storeSettings()
storeSettings in class Pluginnull if this plugin
does not need to save any settings.public static Version getVersion()
public PluginInfo getInfo()
getInfo in class Pluginpublic SettingsTab getSettingsTab()
getSettingsTab in class Pluginnull if the plugin does not
provide this feature.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 void updateMarkedPrograms()
public ActionMenu getButtonAction()
PluginOverride this method to provide a menu item in the main menu and a toolbar button.
The following action values will be used:
Action.NAME: The text for the main menu item and the
toolbar button.Action.SHORT_DESCRIPTION: The description for the button
action. Used as tooltip and for the status bar.Action.SMALL_ICON: The icon for the main menu item. Should
be 16x16.BIG_ICON: The icon for the toolbar button. Should be
24x24.
getButtonAction in class Pluginnull
if the plugin does not provide this feature.public void showDialog()
public ThemeIcon getMarkIconFromTheme()
PluginPluginManager.getIconFromTheme(Plugin, String, String, int)
getMarkIconFromTheme in class Pluginpublic void setCapturePluginData(CapturePluginData data)
data - CapturePluginDatapublic CapturePluginData getCapturePluginData()
public PluginTreeNode getRootNode()
getRootNode in class PluginPlugin.canUseProgramTree()public boolean canUseProgramTree()
Plugin
canUseProgramTree in class PluginPlugin.getRootNode()public boolean canReceiveProgramsWithTarget()
Plugin
canReceiveProgramsWithTarget in interface ProgramReceiveIfcanReceiveProgramsWithTarget in class PluginPlugin.receivePrograms(Program[],ProgramReceiveTarget)
public boolean receivePrograms(Program[] programArr,
ProgramReceiveTarget receiveTarget)
Plugin
receivePrograms in interface ProgramReceiveIfreceivePrograms in class PluginprogramArr - The programs passed from the other plugin.receiveTarget - The receive target of the programs.
Plugin.canReceiveProgramsWithTarget()public ProgramReceiveTarget[] getProgramReceiveTargets()
Pluginnull if there is no target
getProgramReceiveTargets in interface ProgramReceiveIfgetProgramReceiveTargets in class PluginPlugin.canReceiveProgramsWithTarget(),
Plugin.receivePrograms(Program[],ProgramReceiveTarget)public void handleTvBrowserStartFinished()
Plugin
handleTvBrowserStartFinished in class Pluginpublic void handleTvDataUpdateFinished()
handleTvDataUpdateFinished in class PluginPlugin.handleTvBrowserStartFinished(),
Plugin.handleTvDataAdded(ChannelDayProgram),
Plugin.handleTvDataDeleted(ChannelDayProgram),
Plugin.handleTvDataChanged()public Frame getSuperFrame()
public int getMarkPriorityForProgram(Program p)
Plugin
The mark priority can be Program.NO_MARK_PRIORITY, Program.MIN_MARK_PRIORITY, Program.LOWER_MEDIUM_MARK_PRIORITY,
Program.MEDIUM_MARK_PRIORITY, Program.HIGHER_MEDIUM_MARK_PRIORITY or
Program.MAX_MARK_PRIORITY.
getMarkPriorityForProgram in interface MarkergetMarkPriorityForProgram in class Pluginp - The program to get the mark prioriy for.
|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||