McvToolbarEditor (McIDAS-V 1.7 Developer Documentation)

java.lang.Object
- edu.wisc.ssec.mcidasv.ui.McvToolbarEditor

All Implemented Interfaces:: java.awt.event.ActionListener, java.util.EventListener

public class McvToolbarEditor
extends java.lang.Object
implements java.awt.event.ActionListener

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`McvToolbarEditor.IconCellRenderer` Renders a toolbar action and its icon within the `TwoListPanel`'s `JList`s.
`private static class`	`McvToolbarEditor.SpaceIcon` `SpaceIcon` is a class that represents a "space" entry in the `TwoListPanel` that holds the current toolbar actions.

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String`	`CMD_ADDSPACE` Add a "space" entry
`private static java.lang.String`	`CMD_EXPORTMENUPLUGIN` action command
`private static java.lang.String`	`CMD_EXPORTPLUGIN` action command
`private static java.lang.String`	`CMD_RELOAD` Action command for reloading the toolbar list with original items
`private javax.swing.JComponent`	`contents` All of the toolbar editor's GUI components.
`protected static int`	`ICON_SIZE` Size of the icons to be shown in the `TwoListPanel`.
`private static java.lang.String`	`MENU_PLUGINEXPORT`
`private javax.swing.JComboBox`	`menuIdBox` Used to export toolbars to plugin.
`private javax.swing.JTextField`	`menuNameFld` Used to export toolbars to plugin.
`private javax.swing.JCheckBox`	`menuOverwriteCbx` Used to export toolbars to plugin.
`private static java.lang.String`	`MSG_ENTER_NAME`
`private static java.lang.String`	`MSG_SELECT_ENTRIES`
`(package private) ucar.unidata.xml.XmlResourceCollection`	`resources` The toolbar XML resources.
`private static java.lang.String`	`SPACE` ID that represents a "space" in the toolbar.
`private int`	`spaceCount` Provides simple IDs for the space entries.
`private static java.lang.String`	`TT_EXPORT_SELECT`
`private static java.lang.String`	`TT_EXPORT_SELECTMENU`
`private static java.lang.String`	`TT_OVERWRITE`
`private ucar.unidata.ui.TwoListPanel`	`twoListPanel` The GUI component that stores both available and selected actions.
`private UIManager`	`uiManager` Used to notify the application that a toolbar update should occur.

Constructor Summary

Constructors
Constructor and Description

McvToolbarEditor(UIManager mngr)
Builds a toolbar editor and associates it with the UIManager.

Constructors
Constructor and Description
`McvToolbarEditor(UIManager mngr)` Builds a toolbar editor and associates it with the `UIManager`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(java.awt.event.ActionEvent ae)` Handles events such as exporting plugins, reloading contents, and adding spaces.
`boolean`	`anyChanges()` Has `twoListPanel` been changed?
`void`	`doApply()` Writes out the toolbar xml.
`private void`	`doExport(java.util.List<java.lang.Object> tfos)` Export the actions
`private void`	`doExportToMenu(java.util.List<java.lang.Object> tfos)` Export the selected actions as a menu to the plugin manager.
`protected javax.swing.Icon`	`getActionIcon(java.lang.String actionId)` Returns the icon associated with `actionId`.
`private java.util.List<ucar.unidata.util.TwoFacedObject>`	`getAllActions()` Returns a `List` of `TwoFacedObject`s containing all of the actions known to McIDAS-V.
`javax.swing.JComponent`	`getContents()` Returns the `JComponent` that contains all of the toolbar editor's UI components.
`private java.util.List<ucar.unidata.util.TwoFacedObject>`	`getCurrentToolbar()`
`ucar.unidata.ui.TwoListPanel`	`getTLP()` Returns the `TwoListPanel` being used to store the lists of available and selected actions.
`private void`	`init()` Initializes the editor window contents.
`static boolean`	`isSpace(ucar.unidata.util.TwoFacedObject tfo)` Determines if a given toolbar entry (in the form of a `TwoFacedObject`) represents a space.
`private java.util.List<ucar.unidata.util.TwoFacedObject>`	`sortTwoFaced(java.util.List<ucar.unidata.util.TwoFacedObject> objs)` Sorts a `List` of `TwoFacedObjects` by label.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ICON_SIZE
```
protected static final int ICON_SIZE
```
    Size of the icons to be shown in the TwoListPanel.
    
    See Also:
    
    Constant Field Values
  - MENU_PLUGINEXPORT
```
private static final java.lang.String MENU_PLUGINEXPORT
```
    See Also:
    
    Constant Field Values
  - MSG_ENTER_NAME
```
private static final java.lang.String MSG_ENTER_NAME
```
    See Also:
    
    Constant Field Values
  - MSG_SELECT_ENTRIES
```
private static final java.lang.String MSG_SELECT_ENTRIES
```
    See Also:
    
    Constant Field Values
  - CMD_ADDSPACE
```
private static final java.lang.String CMD_ADDSPACE
```
    Add a "space" entry
    
    See Also:
    
    Constant Field Values
  - CMD_RELOAD
```
private static final java.lang.String CMD_RELOAD
```
    Action command for reloading the toolbar list with original items
    
    See Also:
    
    Constant Field Values
  - CMD_EXPORTPLUGIN
```
private static final java.lang.String CMD_EXPORTPLUGIN
```
    action command
    
    See Also:
    
    Constant Field Values
  - CMD_EXPORTMENUPLUGIN
```
private static final java.lang.String CMD_EXPORTMENUPLUGIN
```
    action command
    
    See Also:
    
    Constant Field Values
  - TT_EXPORT_SELECT
```
private static final java.lang.String TT_EXPORT_SELECT
```
    See Also:
    
    Constant Field Values
  - TT_EXPORT_SELECTMENU
```
private static final java.lang.String TT_EXPORT_SELECTMENU
```
    See Also:
    
    Constant Field Values
  - TT_OVERWRITE
```
private static final java.lang.String TT_OVERWRITE
```
    See Also:
    
    Constant Field Values
  - SPACE
```
private static final java.lang.String SPACE
```
    ID that represents a "space" in the toolbar.
    
    See Also:
    
    Constant Field Values
  - spaceCount
```
private int spaceCount
```
    Provides simple IDs for the space entries.
  - uiManager
```
private UIManager uiManager
```
    Used to notify the application that a toolbar update should occur.
  - contents
```
private javax.swing.JComponent contents
```
    All of the toolbar editor's GUI components.
  - twoListPanel
```
private ucar.unidata.ui.TwoListPanel twoListPanel
```
    The GUI component that stores both available and selected actions.
  - resources
```
ucar.unidata.xml.XmlResourceCollection resources
```
    The toolbar XML resources.
  - menuNameFld
```
private javax.swing.JTextField menuNameFld
```
    Used to export toolbars to plugin.
  - menuIdBox
```
private javax.swing.JComboBox menuIdBox
```
    Used to export toolbars to plugin.
  - menuOverwriteCbx
```
private javax.swing.JCheckBox menuOverwriteCbx
```
    Used to export toolbars to plugin.
- Constructor Detail
  - McvToolbarEditor
```
public McvToolbarEditor(UIManager mngr)
```
    Builds a toolbar editor and associates it with the UIManager.
    
    Parameters:
    
    mngr - The application's UI Manager.
- Method Detail
  - getActionIcon
```
protected javax.swing.Icon getActionIcon(java.lang.String actionId)
```
    Returns the icon associated with actionId.
  - isSpace
```
public static boolean isSpace(ucar.unidata.util.TwoFacedObject tfo)
```
    Determines if a given toolbar entry (in the form of a TwoFacedObject) represents a space.
    
    Parameters:
    
    tfo - The entry to test.
    
    Returns:
    
    Whether or not the entry represents a space.
  - getCurrentToolbar
```
private java.util.List<ucar.unidata.util.TwoFacedObject> getCurrentToolbar()
```
    Returns:
    
    Current toolbar contents as action IDs mapped to labels.
  - getAllActions
```
private java.util.List<ucar.unidata.util.TwoFacedObject> getAllActions()
```
    Returns a List of TwoFacedObjects containing all of the actions known to McIDAS-V.
  - getTLP
```
public ucar.unidata.ui.TwoListPanel getTLP()
```
    Returns the TwoListPanel being used to store the lists of available and selected actions.
  - getContents
```
public javax.swing.JComponent getContents()
```
    Returns the JComponent that contains all of the toolbar editor's UI components.
  - init
```
private void init()
```
    Initializes the editor window contents.
  - doExportToMenu
```
private void doExportToMenu(java.util.List<java.lang.Object> tfos)
```
    Export the selected actions as a menu to the plugin manager.
    
    Parameters:
    
    tfos - selected actions
  - doExport
```
private void doExport(java.util.List<java.lang.Object> tfos)
```
    Export the actions
    
    Parameters:
    
    tfos - the actions
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent ae)
```
    Handles events such as exporting plugins, reloading contents, and adding spaces.
    
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
    
    Parameters:
    
    ae - The event that invoked this method.
  - anyChanges
```
public boolean anyChanges()
```
    Has twoListPanel been changed?
    
    Returns:
    
    true if there have been changes, false otherwise.
  - doApply
```
public void doApply()
```
    Writes out the toolbar xml.
  - sortTwoFaced
```
private java.util.List<ucar.unidata.util.TwoFacedObject> sortTwoFaced(java.util.List<ucar.unidata.util.TwoFacedObject> objs)
```
    Sorts a List of TwoFacedObjects by label. Case is ignored.
    
    Parameters:
    
    objs - The list that needs some sortin' out.
    
    Returns:
    
    The sorted contents of objs.

Class McvToolbarEditor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ICON_SIZE

MENU_PLUGINEXPORT

MSG_ENTER_NAME

MSG_SELECT_ENTRIES

CMD_ADDSPACE

CMD_RELOAD

CMD_EXPORTPLUGIN

CMD_EXPORTMENUPLUGIN

TT_EXPORT_SELECT

TT_EXPORT_SELECTMENU

TT_OVERWRITE

SPACE

spaceCount

uiManager

contents

twoListPanel

resources

menuNameFld

menuIdBox

menuOverwriteCbx

Constructor Detail

McvToolbarEditor

Method Detail

getActionIcon

isSpace

getCurrentToolbar

getAllActions

getTLP

getContents

init

doExportToMenu

doExport

actionPerformed

anyChanges

doApply

sortTwoFaced