calendarexportplugin

Class CalendarExportPlugin

java.lang.Object

devplugin.Plugin

calendarexportplugin.CalendarExportPlugin

All Implemented Interfaces:

ContextMenuIf, Marker, ProgramReceiveIf

public class CalendarExportPlugin
extends Plugin

This Plugin exports the Calendar to a external Application or File

Author:

bodo

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_ACTIVE_EXPORTER List of active Exporters
static String	PROP_ALARM Use Alarm ?
static String	PROP_ALARMBEFORE Minutes before ?
static String	PROP_CATEGORIE Category of Item
static String	PROP_CLASSIFICATION Classification - 0 = Public, 1 = Private
static String	PROP_MARK_ITEMS Mark items if exported
static String	PROP_NULLTIME If true, set length to 0 min
static String	PROP_SHOWTIME Show Time as Busy or Free - 0 = Busy, 1 = Free

Fields inherited from class devplugin.Plugin

BIG_ICON, DISABLED_ON_TASK_MENU, parent, SINGLE_CLICK_WAITING_TIME

Constructor Summary

Constructors

Constructor and Description
CalendarExportPlugin() Create Plugin

Method Summary

Methods

Modifier and Type	Method and Description
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.
protected LocalPluginProgramFormating[]	getAvailableLocalPluginProgramFormatings()
Window	getBestParentFrame()
ActionMenu	getContextMenuActions(Program program) Gets the actions for the context menu of a program.
protected static LocalPluginProgramFormating	getDefaultFormating()
ExporterFactory	getExporterFactory()
PluginInfo	getInfo() Gets the meta information about the plugin.
static CalendarExportPlugin	getInstance()
ThemeIcon	getMarkIconFromTheme() This gets the ThemeIcon containg your mark icon.
ProgramReceiveTarget[]	getProgramReceiveTargets() Returns an array of receive target or null if there is no target
PluginTreeNode	getRootNode() Gets the root node of the plugin for the plugin tree.
protected AbstractPluginProgramFormating[]	getSelectedPluginProgramFormatings()
SettingsTab	getSettingsTab() Get Settings-Tab
static Version	getVersion()
void	loadSettings(Properties settings) Loads the Settings
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.
protected void	setAvailableLocalPluginProgramFormatings(LocalPluginProgramFormating[] value)
protected void	setSelectedPluginProgramFormatings(AbstractPluginProgramFormating[] value)
Properties	storeSettings() Stores the Settings
void	writeData(ObjectOutputStream out) Counterpart to loadData.

Methods inherited from class devplugin.Plugin

canReceivePrograms, createImageIcon, createImageIcon, createImageIcon, createImageIconForFileName, execute, execute, execute, getAvailableFilter, getAvailableFilterComponentClasses, getButtonAction, getButtonIconName, getButtonText, getContextMenuItemText, getId, getJarFile, getMarkIcon, getMarkIconName, getMarkIcons, getMarkIconsForProgram, getMarkPriorityForProgram, getParentFrame, getPluginManager, getProgramFromContextMenuActionEvent, getProgramTableIcons, getProgramTableIconText, getRatingInterfaces, handleTvBrowserStartFinished, handleTvDataAdded, handleTvDataAdded, handleTvDataChanged, handleTvDataChanged, handleTvDataDeleted, handleTvDataTouched, handleTvDataUpdateFinished, isAllowedToDeleteProgramFilter, layoutWindow, layoutWindow, onActivation, 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

Field Detail

PROP_NULLTIME

public static final String PROP_NULLTIME

If true, set length to 0 min

See Also:

Constant Field Values

PROP_CATEGORIE

public static final String PROP_CATEGORIE

Category of Item

See Also:

Constant Field Values

PROP_SHOWTIME

public static final String PROP_SHOWTIME

Show Time as Busy or Free - 0 = Busy, 1 = Free

See Also:

Constant Field Values

PROP_CLASSIFICATION

public static final String PROP_CLASSIFICATION

Classification - 0 = Public, 1 = Private

See Also:

Constant Field Values

PROP_ALARM

public static final String PROP_ALARM

Use Alarm ?

See Also:

Constant Field Values

PROP_ALARMBEFORE

public static final String PROP_ALARMBEFORE

Minutes before ?

See Also:

Constant Field Values

PROP_ACTIVE_EXPORTER

public static final String PROP_ACTIVE_EXPORTER

List of active Exporters

See Also:

Constant Field Values

PROP_MARK_ITEMS

public static final String PROP_MARK_ITEMS

Mark items if exported

See Also:

Constant Field Values

Constructor Detail

CalendarExportPlugin

public CalendarExportPlugin()

Create Plugin

Method Detail

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.

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

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:

• Action.NAME: The text for the context menu item.
• Action.SMALL_ICON: The icon for the context menu item. Should be 16x16.

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)

canReceiveProgramsWithTarget

public boolean canReceiveProgramsWithTarget()

Description copied from class: Plugin

Gets whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.

Specified by:

canReceiveProgramsWithTarget in interface ProgramReceiveIf

Overrides:

canReceiveProgramsWithTarget in class Plugin

Returns:

Whether the ProgramReceiveIf supports receiving programs from other plugins with a special target.

See Also:

Plugin.receivePrograms(Program[],ProgramReceiveTarget)

receivePrograms

public boolean receivePrograms(Program[] programArr,
                      ProgramReceiveTarget receiveTarget)

Description copied from class: Plugin

Receives a list of programs from another plugin with a target.

Specified by:

receivePrograms in interface ProgramReceiveIf

Overrides:

receivePrograms in class Plugin

Parameters:

programArr - The programs passed from the other plugin.

receiveTarget - The receive target of the programs.

Returns:

If the programs were correct received (the target really exists).

See Also:

Plugin.canReceiveProgramsWithTarget()

getProgramReceiveTargets

public ProgramReceiveTarget[] getProgramReceiveTargets()

Description copied from class: Plugin

Returns an array of receive target or null if there is no target

Specified by:

getProgramReceiveTargets in interface ProgramReceiveIf

Overrides:

getProgramReceiveTargets in class Plugin

Returns:

The supported receive targets.

See Also:

Plugin.canReceiveProgramsWithTarget(), Plugin.receivePrograms(Program[],ProgramReceiveTarget)

getSettingsTab

public SettingsTab getSettingsTab()

Get Settings-Tab

Overrides:

getSettingsTab in class Plugin

Returns:

SettingsTab

storeSettings

public Properties storeSettings()

Stores the Settings

Overrides:

storeSettings in class Plugin

Returns:

Settings

loadSettings

public void loadSettings(Properties settings)

Loads the Settings

Overrides:

loadSettings in class Plugin

Parameters:

settings - Settings for this Plugin

getExporterFactory

public ExporterFactory getExporterFactory()

Returns:

ExporterFactory

getInstance

public static CalendarExportPlugin getInstance()

Returns:

Instance of this Plugin

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()

getRootNode

public PluginTreeNode getRootNode()

Description copied from class: Plugin

Gets the root node of the plugin for the plugin tree.

Overrides:

getRootNode in class Plugin

Returns:

The root node.

See Also:

Plugin.canUseProgramTree()

getBestParentFrame

public Window getBestParentFrame()

Returns:

get best Parent-Frame for Dialogs

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)

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)

getDefaultFormating

protected static LocalPluginProgramFormating getDefaultFormating()

getAvailableLocalPluginProgramFormatings

protected LocalPluginProgramFormating[] getAvailableLocalPluginProgramFormatings()

setAvailableLocalPluginProgramFormatings

protected void setAvailableLocalPluginProgramFormatings(LocalPluginProgramFormating[] value)

getSelectedPluginProgramFormatings

protected AbstractPluginProgramFormating[] getSelectedPluginProgramFormatings()

setSelectedPluginProgramFormatings

protected void setSelectedPluginProgramFormatings(AbstractPluginProgramFormating[] value)