|
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
printplugin.PrintPlugin
public class PrintPlugin
| Field Summary |
|---|
| Fields inherited from class devplugin.Plugin |
|---|
BIG_ICON, DISABLED_ON_TASK_MENU, parent, SINGLE_CLICK_WAITING_TIME |
| Constructor Summary | |
|---|---|
PrintPlugin()
|
|
| Method Summary | |
|---|---|
boolean |
canPrintQueue()
|
boolean |
canReceivePrograms()
Gets whether the plugin supports receiving programs from other plugins. |
boolean |
canUseProgramTree()
Signal whether this plugin participates in the plugin tree view or not. |
ImageIcon |
createIcon(String fileName)
|
ActionMenu |
getButtonAction()
Gets the action to use for the main menu and the toolbar. |
ActionMenu |
getContextMenuActions(Program program)
Gets the actions for the context menu of a program. |
PluginInfo |
getInfo()
Gets the meta information about the plugin. |
static PrintPlugin |
getInstance()
|
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. |
Properties |
getSettings()
|
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 |
onActivation()
This method is automatically called immediatly before the plugin gets activated. |
void |
readData(ObjectInputStream in)
Called by the host-application during start-up. |
void |
receivePrograms(Program[] programArr)
Receives a list of programs from another plugin. |
protected void |
setMarkPriority(int priority)
|
Properties |
storeSettings()
Called by the host-application during shut-down. |
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 PrintPlugin()
| Method Detail |
|---|
public static PrintPlugin getInstance()
public ThemeIcon getMarkIconFromTheme()
PluginPluginManager.getIconFromTheme(Plugin, String, String, int)
getMarkIconFromTheme in class Pluginpublic static Version getVersion()
public PluginInfo getInfo()
PluginOverride this method to provide information about your plugin.
getInfo in class Pluginpublic void onActivation()
Plugin
onActivation in class Pluginpublic void handleTvBrowserStartFinished()
Plugin
handleTvBrowserStartFinished in class Pluginpublic 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 boolean canPrintQueue()
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 receivePrograms(Program[] programArr)
PluginOverride this method to receive programs from other plugins.
receivePrograms in interface ProgramReceiveIfreceivePrograms in class PluginprogramArr - The programs passed from the other plugin.Plugin.canReceivePrograms()public boolean canReceivePrograms()
Plugin
Override this method and return true, if your plugin is able
to receive programs from other plugins.
canReceivePrograms in interface ProgramReceiveIfcanReceivePrograms in class PluginPlugin.receivePrograms(Program[])public boolean canUseProgramTree()
Plugin
canUseProgramTree in class PluginPlugin.getRootNode()public ImageIcon createIcon(String fileName)
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 Properties getSettings()
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 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.
protected void setMarkPriority(int priority)
|
TV-Browser 2.7.5 API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||