com.vividsolutions.jump.workbench.ui.plugin

Class FeatureInstaller

java.lang.Object

com.vividsolutions.jump.workbench.ui.plugin.FeatureInstaller

public class FeatureInstaller
extends java.lang.Object

Adds a plug-in to the JUMP Workbench as a menu item.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FeatureInstaller.JumpMenuListener
static interface	FeatureInstaller.Menu

Constructor Summary

Constructors

Constructor and Description
FeatureInstaller(WorkbenchContext workbenchContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayerNameViewMenuItem(PlugIn executable, java.lang.String[] menuPath, java.lang.String menuItemName) Deprecated.
void	addLayerNameViewMenuItem(PlugIn executable, java.lang.String menuName, java.lang.String menuItemName) Deprecated.
void	addLayerViewMenuItem(PlugIn executable, java.lang.String[] menuPath, java.lang.String menuItemName) Deprecated.
void	addLayerViewMenuItem(PlugIn executable, java.lang.String menuName, java.lang.String menuItemName) Deprecated.
static javax.swing.JMenu	addMainMenu(FeatureInstaller featureInstaller, java.lang.String[] menuPath, java.lang.String menuName, int pos) Create and add a sub menu entry. index < 0 adds it to the end.
javax.swing.JMenuItem	addMainMenuItem(PlugIn plugin, java.lang.String[] menuPath, javax.swing.JMenuItem menuItem, EnableCheck enableCheck) Deprecated. use addMainMenuPlugin() instead
javax.swing.JMenuItem	addMainMenuItem(PlugIn plugin, java.lang.String[] menuPath, javax.swing.JMenuItem menuItem, EnableCheck enableCheck, int pos) Deprecated. use addMainMenuPlugin() instead
void	addMainMenuItem(PlugIn executable, java.lang.String[] menuPath, java.lang.String menuItemName, boolean checkBox, javax.swing.Icon icon, EnableCheck enableCheck) Deprecated.
void	addMainMenuItem(PlugIn executable, java.lang.String menuName, java.lang.String menuItemName, javax.swing.Icon icon, EnableCheck enableCheck) Deprecated.
javax.swing.JMenuItem	addMainMenuItem(java.lang.String[] menuPath, AbstractUiPlugIn plugin) Deprecated. use addMainMenuPlugin() instead
javax.swing.JMenuItem	addMainMenuItem(java.lang.String[] menuPath, AbstractUiPlugIn plugin, EnableCheck enableCheck) Deprecated. use addMainMenuPlugin() instead
javax.swing.JMenuItem	addMainMenuItem(java.lang.String[] menuPath, AbstractUiPlugIn plugin, EnableCheck enableCheck, int pos) Deprecated. use addMainMenuPlugin() instead
javax.swing.JMenuItem	addMainMenuItem(java.lang.String[] menuPath, AbstractUiPlugIn plugin, int pos) Deprecated. use addMainMenuPlugin() instead
javax.swing.JMenuItem	addMainMenuItem(java.lang.String[] menuPath, AbstractUiPlugIn plugin, javax.swing.JMenuItem menuItem, EnableCheck enableCheck, int pos) Deprecated. use addMainMenuPlugin() instead
javax.swing.JMenuItem	addMainMenuItem(java.lang.String[] menuPath, AbstractUiPlugIn plugin, javax.swing.JMenuItem menuItem, int pos) Deprecated. use addMainMenuPlugin() instead
javax.swing.JMenuItem	addMainMenuPlugin(PlugIn executable, java.lang.String[] menuPath)
javax.swing.JMenuItem	addMainMenuPlugin(PlugIn executable, java.lang.String[] menuPath, java.lang.String menuItemName, boolean checkBox, javax.swing.Icon icon, EnableCheck enableCheck) Convenience method without position parameter.
javax.swing.JMenuItem	addMainMenuPlugin(PlugIn executable, java.lang.String[] menuPath, java.lang.String menuItemName, boolean checkBox, javax.swing.Icon icon, EnableCheck enableCheck, int pos) Replacement for the retired methods above and below.
void	addMenuItemShownListener(javax.swing.JMenuItem menuItem, MenuItemShownListener menuItemShownListener)
javax.swing.JMenuItem	addMenuPlugin(java.lang.String menuKey, PlugIn plugin) a generic addMenu method, fetching all settings from workbench properties and the plugin object. used in PluginManager
void	addMenuSeparator(javax.swing.JMenu menu)
void	addMenuSeparator(java.lang.String menu)
void	addMenuSeparator(java.lang.String[] menuPath)
void	addPopupMenuItem(javax.swing.JPopupMenu popupMenu, PlugIn executable, java.lang.String[] menuPath, java.lang.String menuItemName, boolean checkBox, javax.swing.Icon icon, EnableCheck enableCheck) Deprecated. use addPopupMenuPlugin instead
void	addPopupMenuItem(javax.swing.JPopupMenu popupMenu, PlugIn executable, java.lang.String menuItemName, boolean checkBox, javax.swing.Icon icon, EnableCheck enableCheck) Deprecated. use addPopupMenuPlugin instead
javax.swing.JMenuItem	addPopupMenuPlugin(javax.swing.JPopupMenu popupMenu, PlugIn executable) Ultimate convenience method for attaching a plugin to a popupmenu.
javax.swing.JMenuItem	addPopupMenuPlugin(javax.swing.JPopupMenu popupMenu, PlugIn executable, java.lang.String[] menuPath) Convenience method for entries with menupath
javax.swing.JMenuItem	addPopupMenuPlugin(javax.swing.JPopupMenu popupMenu, PlugIn executable, java.lang.String[] menuPath, java.lang.String menuItemName, boolean checkBox, javax.swing.Icon icon, EnableCheck enableCheck) Analogue to addMainMenuPlugin().
javax.swing.JMenuItem	addPopupMenuPlugin(javax.swing.JPopupMenu popupMenu, PlugIn executable, java.lang.String menuItemName, boolean checkBox, javax.swing.Icon icon, EnableCheck enableCheck) Convenience method for entries without menupath
void	addPopupMenuSeparator(javax.swing.JPopupMenu popupMenu, java.lang.String[] menuPath)
static javax.swing.JMenuItem	childMenuItem(java.lang.String childName, FeatureInstaller.Menu menu) Find the first occurrence of a menu item with the given name and return it.
MultiEnableCheck	createFenceExistsCheck() Deprecated. Use the EnableCheckFactory methods instead
MultiEnableCheck	createLayersSelectedCheck() Deprecated. Use the EnableCheckFactory methods instead
static FeatureInstaller.Menu	createMenusIfNecessary(FeatureInstaller.Menu parent, java.lang.String[] menuPath)
static FeatureInstaller.Menu	createMenusIfNecessary(FeatureInstaller.Menu parent, java.lang.String[] menuPath, java.lang.Object[] menuPathPositions)
MultiEnableCheck	createOneLayerSelectedCheck() Deprecated. Use the EnableCheckFactory methods instead
MultiEnableCheck	createVectorsExistCheck() Deprecated. Use the EnableCheckFactory methods instead
java.lang.String	fetchKeyForMenu(java.lang.Object menu)
FeatureInstaller.Menu	fetchMenuForKey(java.lang.String key)
static FeatureInstaller	getInstance()
static javax.swing.JMenuItem	installMnemonic(javax.swing.JMenuItem menuItem, javax.swing.MenuElement parent)
boolean	isSeparatingEnabled()
javax.swing.JMenuBar	menuBar()
javax.swing.JMenu	menuBarMenu(java.lang.String childName)
static javax.swing.JMenu	popupMenu(javax.swing.JPopupMenu popupMenu, java.lang.String childName)
void	setSeparatingEnabled(boolean onoff)
void	updateSeparatorsInAllMenus()
static FeatureInstaller.Menu	wrapMenu(javax.swing.JMenu menu)
static FeatureInstaller.Menu	wrapMenu(javax.swing.JMenuBar menu)
static FeatureInstaller.Menu	wrapMenu(javax.swing.JPopupMenu popupMenu)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FeatureInstaller

public FeatureInstaller(WorkbenchContext workbenchContext)

Method Detail

getInstance

public static final FeatureInstaller getInstance()

createLayersSelectedCheck

public MultiEnableCheck createLayersSelectedCheck()

Deprecated. Use the EnableCheckFactory methods instead

createOneLayerSelectedCheck

public MultiEnableCheck createOneLayerSelectedCheck()

Deprecated. Use the EnableCheckFactory methods instead

createVectorsExistCheck

public MultiEnableCheck createVectorsExistCheck()

Deprecated. Use the EnableCheckFactory methods instead

createFenceExistsCheck

public MultiEnableCheck createFenceExistsCheck()

Deprecated. Use the EnableCheckFactory methods instead

addMenuSeparator

public void addMenuSeparator(java.lang.String menu)

addMenuSeparator

public void addMenuSeparator(java.lang.String[] menuPath)

addMenuSeparator

public void addMenuSeparator(javax.swing.JMenu menu)

addLayerViewMenuItem

public void addLayerViewMenuItem(PlugIn executable,
                        java.lang.String menuName,
                        java.lang.String menuItemName)

Deprecated.

addLayerNameViewMenuItem

public void addLayerNameViewMenuItem(PlugIn executable,
                            java.lang.String menuName,
                            java.lang.String menuItemName)

Deprecated.

addLayerViewMenuItem

public void addLayerViewMenuItem(PlugIn executable,
                        java.lang.String[] menuPath,
                        java.lang.String menuItemName)

Deprecated.

Add a menu item to the main menu that is enabled only if the active internal frame is a LayerViewPanelProxy.

addLayerNameViewMenuItem

public void addLayerNameViewMenuItem(PlugIn executable,
                            java.lang.String[] menuPath,
                            java.lang.String menuItemName)

Deprecated.

Add a menu item to the main menu that is enabled only if the active internal frame is a LayerViewPanelProxy and a LayerNamePanelProxy.

addMainMenuItem

public void addMainMenuItem(PlugIn executable,
                   java.lang.String menuName,
                   java.lang.String menuItemName,
                   javax.swing.Icon icon,
                   EnableCheck enableCheck)

Deprecated.

addMainMenu

public static javax.swing.JMenu addMainMenu(FeatureInstaller featureInstaller,
                            java.lang.String[] menuPath,
                            java.lang.String menuName,
                            int pos)

Create and add a sub menu entry. index < 0 adds it to the end.

Parameters:

featureInstaller -

menuPath -

menuName -

pos -

Returns:

addMainMenuPlugin

public javax.swing.JMenuItem addMainMenuPlugin(PlugIn executable,
                                      java.lang.String[] menuPath)

addMainMenuPlugin

public javax.swing.JMenuItem addMainMenuPlugin(PlugIn executable,
                                      java.lang.String[] menuPath,
                                      java.lang.String menuItemName,
                                      boolean checkBox,
                                      javax.swing.Icon icon,
                                      EnableCheck enableCheck)

Convenience method without position parameter.

See Also:

addMainMenuPlugin(PlugIn executable, String[] menuPath, String menuItemName, boolean checkBox, Icon icon, EnableCheck enableCheck, int pos)

addMainMenuPlugin

public javax.swing.JMenuItem addMainMenuPlugin(PlugIn executable,
                                      java.lang.String[] menuPath,
                                      java.lang.String menuItemName,
                                      boolean checkBox,
                                      javax.swing.Icon icon,
                                      EnableCheck enableCheck,
                                      int pos)

Replacement for the retired methods above and below. Lot's of existing plugins depend on these methods. Rationale was to have the methods return the menuitem to the plugin for further manipulation & attaching listeners etc. Unfortunately the return type is not part of the java method footprint, so we couldn't just change the return type but had to modify the name as well. Also the position parameter was added as it was needed anyway.

Parameters:

executable -

menuPath - string array of sub menu entries to place the entry in

menuItemName - name of the menu item

checkBox - whether to create a JCheckBoxMenuItem or a JMenuItem

icon - an Icon or null

enableCheck - conditions to make the plugin available to the user

pos - defines the position of the menu item in the menu

See Also:

GUIUtil.toSmallIcon(javax.swing.ImageIcon)

addMenuPlugin

public javax.swing.JMenuItem addMenuPlugin(java.lang.String menuKey,
                                  PlugIn plugin)

a generic addMenu method, fetching all settings from workbench properties and the plugin object. used in PluginManager

Parameters:

menuKey -

plugin -

Returns:

menuItem

addMainMenuItem

public javax.swing.JMenuItem addMainMenuItem(java.lang.String[] menuPath,
                                    AbstractUiPlugIn plugin)

Deprecated. use addMainMenuPlugin() instead

Add a Plugin as a JMenuItem with enableCheck conditions.

Parameters:

menuPath - path from the main menu to the menu item

plugin - the plugin associated to this menu item

addMainMenuItem

public javax.swing.JMenuItem addMainMenuItem(java.lang.String[] menuPath,
                                    AbstractUiPlugIn plugin,
                                    int pos)

Deprecated. use addMainMenuPlugin() instead

Add a Plugin as a JMenuItem with enableCheck conditions.

Parameters:

menuPath - path from the main menu to the menu item

plugin - the plugin associated to this menu item

pos - defines the position of the menu item in the menu -1 adds menuItem at the end except for FILE menu where -1 adds menuItem before the separator preceding exit menu item

addMainMenuItem

public javax.swing.JMenuItem addMainMenuItem(java.lang.String[] menuPath,
                                    AbstractUiPlugIn plugin,
                                    EnableCheck enableCheck)

Deprecated. use addMainMenuPlugin() instead

Add a Plugin as a JMenuItem with enableCheck conditions.

Parameters:

menuPath - path from the main menu to the menu item

plugin - the plugin associated to this menu item

enableCheck - conditions making the plugin enabled

addMainMenuItem

public javax.swing.JMenuItem addMainMenuItem(java.lang.String[] menuPath,
                                    AbstractUiPlugIn plugin,
                                    EnableCheck enableCheck,
                                    int pos)

Deprecated. use addMainMenuPlugin() instead

Add a Plugin as a JMenuItem with enableCheck

Parameters:

menuPath - path from the main menu to the menu item

plugin - the plugin associated to this menu item

enableCheck - conditions making the plugin enabled

pos - defines the position of the menu item in the menu -1 adds menuItem at the end except for FILE menu where -1 adds menuItem before the separator preceding exit menu item

addMainMenuItem

public javax.swing.JMenuItem addMainMenuItem(java.lang.String[] menuPath,
                                    AbstractUiPlugIn plugin,
                                    javax.swing.JMenuItem menuItem,
                                    int pos)

Deprecated. use addMainMenuPlugin() instead

Add a Plugin as a JMenuItem or a subclass of JMenuItem to the main menu

Parameters:

menuPath - path from the main menu to the menu item

plugin - the plugin associated to this menu item

menuItem - the menu item (JMenuItem, JCheckBoxMenuItem, JMenu, JRadioButtonMenuItem)

pos - defines the position of the menu item in the menu -1 adds menuItem at the end except for FILE menu where -1 adds menuItem before the separator preceding exit menu item

addMainMenuItem

public javax.swing.JMenuItem addMainMenuItem(java.lang.String[] menuPath,
                                    AbstractUiPlugIn plugin,
                                    javax.swing.JMenuItem menuItem,
                                    EnableCheck enableCheck,
                                    int pos)

Deprecated. use addMainMenuPlugin() instead

New generic addMainMenuItem method using AbstractUiPlugIn.

Parameters:

menuPath - the menu path made of the menu and submenu names

plugin - the plugin to execute with this item

menuItem - the JMenuItem (or JCheckBoxMenuItem or JRadioButtonMenuItem) to the parent menu

enableCheck - conditions making the plugin enabled

pos - defines the position of the menu item in the menu -1 adds menuItem at the end except for FILE menu where -1 adds menuItem before the separator preceding exit menu item

addMainMenuItem

public void addMainMenuItem(PlugIn executable,
                   java.lang.String[] menuPath,
                   java.lang.String menuItemName,
                   boolean checkBox,
                   javax.swing.Icon icon,
                   EnableCheck enableCheck)

Deprecated.

Parameters:

menuPath - separate items with slashes; items will be created if they do not already exist

menuItemName - name of the menu item

checkBox - whether to create a JCheckBoxMenuItem or a JMenuItem

icon - an Icon or null

enableCheck - conditions to make the plugin available to the user

See Also:

GUIUtil.toSmallIcon(javax.swing.ImageIcon)

addMainMenuItem

public javax.swing.JMenuItem addMainMenuItem(PlugIn plugin,
                                    java.lang.String[] menuPath,
                                    javax.swing.JMenuItem menuItem,
                                    EnableCheck enableCheck)

Deprecated. use addMainMenuPlugin() instead

New generic addMainMenuItem method. Adds menuItem at the end of the menu except for FILE menu where menuItem is added before the separator preceding exit menu item

Parameters:

plugin - the plugin to execute with this item

menuPath - the menu path made of the menu and submenu names

menuItem - the JMenuItem (or JCheckBoxMenuItem or JRadioButtonMenuItem) to the parent menu

enableCheck - conditions making the plugin enabled

addMainMenuItem

public javax.swing.JMenuItem addMainMenuItem(PlugIn plugin,
                                    java.lang.String[] menuPath,
                                    javax.swing.JMenuItem menuItem,
                                    EnableCheck enableCheck,
                                    int pos)

Deprecated. use addMainMenuPlugin() instead

New generic addMainMenuItem method.

Parameters:

plugin - the plugin to execute with this item

menuPath - the menu path made of the menu and submenu names

menuItem - the JMenuItem (or JCheckBoxMenuItem or JRadioButtonMenuItem) to the parent menu

enableCheck - conditions making the plugin enabled

pos - defines the position of menuItem in the menu -1 adds menuItem at the end of the menu except for FILE menu where -1 adds menuItem before the separator preceding exit menuItem

addMenuItemShownListener

public void addMenuItemShownListener(javax.swing.JMenuItem menuItem,
                            MenuItemShownListener menuItemShownListener)

addPopupMenuPlugin

public javax.swing.JMenuItem addPopupMenuPlugin(javax.swing.JPopupMenu popupMenu,
                                       PlugIn executable)

Ultimate convenience method for attaching a plugin to a popupmenu.

Parameters:

popupMenu -

executable -

Returns:

menu item

addPopupMenuPlugin

public javax.swing.JMenuItem addPopupMenuPlugin(javax.swing.JPopupMenu popupMenu,
                                       PlugIn executable,
                                       java.lang.String[] menuPath)

Convenience method for entries with menupath

Returns:

menu item

addPopupMenuPlugin

public javax.swing.JMenuItem addPopupMenuPlugin(javax.swing.JPopupMenu popupMenu,
                                       PlugIn executable,
                                       java.lang.String menuItemName,
                                       boolean checkBox,
                                       javax.swing.Icon icon,
                                       EnableCheck enableCheck)

Convenience method for entries without menupath

Parameters:

checkBox - true for item to be checkable

enableCheck - , icon null to leave unspecified

Returns:

menu item

addPopupMenuPlugin

public javax.swing.JMenuItem addPopupMenuPlugin(javax.swing.JPopupMenu popupMenu,
                                       PlugIn executable,
                                       java.lang.String[] menuPath,
                                       java.lang.String menuItemName,
                                       boolean checkBox,
                                       javax.swing.Icon icon,
                                       EnableCheck enableCheck)

Analogue to addMainMenuPlugin(). Adds a plugin to a popup menu.

Parameters:

popupMenu -

executable -

menuPath -

menuItemName -

checkBox -

icon -

enableCheck -

Returns:

menu item

addPopupMenuItem

public void addPopupMenuItem(javax.swing.JPopupMenu popupMenu,
                    PlugIn executable,
                    java.lang.String menuItemName,
                    boolean checkBox,
                    javax.swing.Icon icon,
                    EnableCheck enableCheck)

Deprecated. use addPopupMenuPlugin instead

addPopupMenuItem

public void addPopupMenuItem(javax.swing.JPopupMenu popupMenu,
                    PlugIn executable,
                    java.lang.String[] menuPath,
                    java.lang.String menuItemName,
                    boolean checkBox,
                    javax.swing.Icon icon,
                    EnableCheck enableCheck)

Deprecated. use addPopupMenuPlugin instead

isSeparatingEnabled

public boolean isSeparatingEnabled()

setSeparatingEnabled

public void setSeparatingEnabled(boolean onoff)

updateSeparatorsInAllMenus

public void updateSeparatorsInAllMenus()

fetchKeyForMenu

public java.lang.String fetchKeyForMenu(java.lang.Object menu)

fetchMenuForKey

public FeatureInstaller.Menu fetchMenuForKey(java.lang.String key)

addPopupMenuSeparator

public void addPopupMenuSeparator(javax.swing.JPopupMenu popupMenu,
                         java.lang.String[] menuPath)

popupMenu

public static javax.swing.JMenu popupMenu(javax.swing.JPopupMenu popupMenu,
                          java.lang.String childName)

Returns:

the menu with the given name, or null if no such menu exists

wrapMenu

public static FeatureInstaller.Menu wrapMenu(javax.swing.JPopupMenu popupMenu)

wrapMenu

public static FeatureInstaller.Menu wrapMenu(javax.swing.JMenu menu)

wrapMenu

public static FeatureInstaller.Menu wrapMenu(javax.swing.JMenuBar menu)

menuBar

public javax.swing.JMenuBar menuBar()

menuBarMenu

public javax.swing.JMenu menuBarMenu(java.lang.String childName)

Returns:

the menu with the given name, or null if no such menu exists

createMenusIfNecessary

public static FeatureInstaller.Menu createMenusIfNecessary(FeatureInstaller.Menu parent,
                                           java.lang.String[] menuPath)

createMenusIfNecessary

public static FeatureInstaller.Menu createMenusIfNecessary(FeatureInstaller.Menu parent,
                                           java.lang.String[] menuPath,
                                           java.lang.Object[] menuPathPositions)

Returns:

the leaf

childMenuItem

public static javax.swing.JMenuItem childMenuItem(java.lang.String childName,
                                  FeatureInstaller.Menu menu)

Find the first occurrence of a menu item with the given name and return it.

Parameters:

childName -

menu -

Returns:

JMenuItem

installMnemonic

public static javax.swing.JMenuItem installMnemonic(javax.swing.JMenuItem menuItem,
                                    javax.swing.MenuElement parent)