GuiPlugin

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> dinopolis >> gpstool >> [ plugin overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.dinopolis.gpstool.plugin.GuiPlugin

SOURCE |

Download org.dinopolis.gpstool.plugin.GuiPlugin

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.dinopolis.gpstool.plugin
Interface GuiPlugin

All Superinterfaces:: Plugin

public interface GuiPlugin
extends Plugin

This interface is used for all plugins that want to provide any kind of gui-interface for the application. The plugins may provide menu items that are placed into a sub menu (in the "plugins" menu) or if they provide a larger quantity of actions, the plugin may provide actions for a main menu item.

The plugins are informed about start and stop, so they may initialize and free their resources on startup and on closing of the application.

If the plugin wants to draw anything on the map, it may return a layer in the getLayer() 55 method.

Version:: $Revision: 1.5 $

Method Summary

Layer getLayer()
          If the plugin wants to draw anything on the map it may return a layer here or null if not.

javax.swing.JMenu getMainMenu()
          The plugin may return a JMenu object to be used in the main menu of the application and may (should) contain other menu items.

org.dinopolis.gpstool.gui.MouseMode[] getMouseModes()
          Every plugin may provide one or more mouse modes.

javax.swing.JMenuItem getSubMenu()
          The application provides a sub menu for every plugin that may be used.

boolean isActive()
          Returns if the plugin is active or not.

void setActive(boolean active)
          Called by the application to switch the layer on or off.

Methods inherited from interface org.dinopolis.gpstool.plugin.Plugin

getPluginDescription, getPluginIdentifier, getPluginName, getPluginVersion, initializePlugin, startPlugin, stopPlugin

Method Detail

getMainMenu

public javax.swing.JMenu getMainMenu()

The plugin may return a JMenu object to be used in the main menu of the application and may (should) contain other menu items. The menuitems returned should provide an icon, a mnemonic key, and a localized name (and a accelerator key).

getSubMenu

public javax.swing.JMenuItem getSubMenu()

The application provides a sub menu for every plugin that may be used. The JMenuItem (or JMenu) returned is added to a submenu in the "plugins" menu item. The menuitems returned should provide an icon, a mnemonic key, and a localized name (and a accelerator key).

getMouseModes

public org.dinopolis.gpstool.gui.MouseMode[] getMouseModes()

Every plugin may provide one or more mouse modes. These mouse modes may react on mouse clicks, drags, etc.

getLayer

public Layer getLayer()

If the plugin wants to draw anything on the map it may return a layer here or null if not. If this method is called more than once, the plugin should return always the same layer!

setActive

public void setActive(boolean active)

Called by the application to switch the layer on or off. If the layer is switched off, it must not paint anything and should not consume any calculational power.

isActive

public boolean isActive()

Returns if the plugin is active or not.