TV-Browser 2.7.5 API

printplugin
Class PrintPlugin

java.lang.Object
  extended by devplugin.Plugin
      extended by printplugin.PrintPlugin
All Implemented Interfaces:
ContextMenuIf, Marker, ProgramReceiveIf

public class PrintPlugin
extends Plugin


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 devplugin.Plugin
canReceiveProgramsWithTarget, createImageIcon, createImageIcon, createImageIcon, createImageIconForFileName, execute, execute, execute, getAvailableFilter, getAvailableFilterComponentClasses, getButtonIconName, getButtonText, getContextMenuItemText, getId, getJarFile, getMarkIcon, getMarkIconName, getMarkIcons, getMarkIconsForProgram, getParentFrame, getPluginManager, getProgramFromContextMenuActionEvent, getProgramReceiveTargets, getProgramTableIcons, getProgramTableIconText, getRatingInterfaces, getRootNode, handleTvDataAdded, handleTvDataAdded, handleTvDataChanged, handleTvDataChanged, handleTvDataDeleted, handleTvDataTouched, handleTvDataUpdateFinished, isAllowedToDeleteProgramFilter, layoutWindow, layoutWindow, onDeactivation, receivePrograms, receiveValues, saveMe, setJarFile, setParent, setPluginManager, storeRootNode, supportMultipleProgramExecution, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PrintPlugin

public PrintPlugin()
Method Detail

getInstance

public static PrintPlugin getInstance()

getMarkIconFromTheme

public ThemeIcon getMarkIconFromTheme()
Description copied from class: Plugin
This gets the ThemeIcon containg your mark icon. This Function uses the Icon-Theme-Function of the TV-Browser. For details see PluginManager.getIconFromTheme(Plugin, String, String, int)

Overrides:
getMarkIconFromTheme in class Plugin
Returns:
ThemeIcon that identifies the Icon in the Theme

getVersion

public static Version getVersion()

getInfo

public PluginInfo getInfo()
Description copied from class: Plugin
Gets the meta information about the plugin.

Override this method to provide information about your plugin.

Overrides:
getInfo in class Plugin
Returns:
The meta information about the plugin.

onActivation

public void onActivation()
Description copied from class: Plugin
This method is automatically called immediatly before the plugin gets activated.

Overrides:
onActivation in class Plugin

handleTvBrowserStartFinished

public void handleTvBrowserStartFinished()
Description copied from class: Plugin
This method is called when the TV-Browser start is finished.

Overrides:
handleTvBrowserStartFinished in class Plugin

getContextMenuActions

public ActionMenu getContextMenuActions(Program program)
Description copied from class: Plugin
Gets the actions for the context menu of a program.

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:

Specified by:
getContextMenuActions in interface ContextMenuIf
Overrides:
getContextMenuActions in class Plugin
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.
See Also:
Plugin.getProgramFromContextMenuActionEvent(ActionEvent)

canPrintQueue

public boolean canPrintQueue()

getButtonAction

public ActionMenu getButtonAction()
Description copied from class: Plugin
Gets the action to use for the main menu and the toolbar.

Override this method to provide a menu item in the main menu and a toolbar button.

The following action values will be used:

Overrides:
getButtonAction in class Plugin
Returns:
the action to use for the menu and the toolbar or null if the plugin does not provide this feature.

receivePrograms

public void receivePrograms(Program[] programArr)
Description copied from class: Plugin
Receives a list of programs from another plugin.

Override this method to receive programs from other plugins.

Specified by:
receivePrograms in interface ProgramReceiveIf
Overrides:
receivePrograms in class Plugin
Parameters:
programArr - The programs passed from the other plugin.
See Also:
Plugin.canReceivePrograms()

canReceivePrograms

public boolean canReceivePrograms()
Description copied from class: Plugin
Gets whether the plugin supports receiving programs from other plugins.

Override this method and return true, if your plugin is able to receive programs from other plugins.

Specified by:
canReceivePrograms in interface ProgramReceiveIf
Overrides:
canReceivePrograms in class Plugin
Returns:
Whether the plugin supports receiving programs from other plugins.
See Also:
Plugin.receivePrograms(Program[])

canUseProgramTree

public boolean canUseProgramTree()
Description copied from class: Plugin
Signal whether this plugin participates in the plugin tree view or not.

Overrides:
canUseProgramTree in class Plugin
Returns:
true, if the programs of this plugin are handled by the plugin tree view
See Also:
Plugin.getRootNode()

createIcon

public ImageIcon createIcon(String fileName)

loadSettings

public void loadSettings(Properties settings)
Description copied from class: Plugin
Called by the host-application during start-up.

Override this method to load your plugins settings from the file system.

Overrides:
loadSettings in class Plugin
Parameters:
settings - The settings for this plugin (May be empty).

storeSettings

public Properties storeSettings()
Description copied from class: Plugin
Called by the host-application during shut-down.

Override 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.

Overrides:
storeSettings in class Plugin
Returns:
The settings for this plugin or null if this plugin does not need to save any settings.

readData

public void readData(ObjectInputStream in)
              throws IOException,
                     ClassNotFoundException
Description copied from class: Plugin
Called by the host-application during start-up.

Override this method to load any objects from the file system.

Overrides:
readData in class Plugin
Parameters:
in - The stream to read the objects from.
Throws:
IOException - If reading failed.
ClassNotFoundException - If an object could not be casted correctly.
See Also:
Plugin.writeData(ObjectOutputStream)

writeData

public void writeData(ObjectOutputStream out)
               throws IOException
Description copied from class: Plugin
Counterpart to loadData. Called when the application shuts down.

Override this method to store any objects to the file system. ATTENTION: Don't use any logger, thread or access to Frames in this method.

Overrides:
writeData in class Plugin
Parameters:
out - The stream to write the objects to
Throws:
IOException - If writing failed.
See Also:
Plugin.readData(ObjectInputStream)

getSettings

public Properties getSettings()

getSettingsTab

public SettingsTab getSettingsTab()
Description copied from class: Plugin
Gets the SettingsTab object, which is added to the settings-window.

Override this method to provide a settings tab. The settings tab will be shown in the settings dialog in the plugin section.

Overrides:
getSettingsTab in class Plugin
Returns:
the SettingsTab object or null if the plugin does not provide this feature.

getMarkPriorityForProgram

public int getMarkPriorityForProgram(Program p)
Description copied from class: Plugin
Gets the mark priority for the given program that this Plugin uses.

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.

Specified by:
getMarkPriorityForProgram in interface Marker
Overrides:
getMarkPriorityForProgram in class Plugin
Parameters:
p - The program to get the mark prioriy for.
Returns:
The mark priority for the given program for this plugin.

setMarkPriority

protected void setMarkPriority(int priority)

TV-Browser 2.7.5 API

TV-Browser 2.7.5, Copyright (C) 04-2003 Martin Oberhauser (martin@tvbrowser.org)