Package com.luciad.lucy.gui

Class TLcyComboBoxActionBar

java.lang.Object
com.luciad.lucy.gui.ALcyActionBar
com.luciad.lucy.gui.TLcyComboBoxActionBar
All Implemented Interfaces:
ILcyActionBar, ILcyToolBar
public class TLcyComboBoxActionBar extends ALcyActionBar implements ILcyToolBar

General

Implementation of ILcyActionBar that is represented as a combo box. Its items are displayed in the drop-down. Sub-menus aren't supported.

It is meant to contain a series of ILcyActiveSettabless that behave similar to radio buttons (only one button of a series is active at a time). It does not support check box style active settables. This means aDeactivatePossible of the insertActiveSettable method must be false. It can also contain regular ILcdActions. The active settable that is active is displayed as the current value of the combo box, also when it is collapsed.

The difference with a regular sub-menu of a TLcyToolBar is that a combo box provides feedback on the currently selected item without having to expand the menu.

Example

Consider a TLcyComboBoxActionBar having a series of active settables, each enabling a certain projection on the map. The active settables themselves listen to the map, and when the projection is changed, they update their 'active' state accordingly. Suppose there also is a regular action that can be used to pop up a dialog, showing some additional projection properties.

If you select such a projection active settable from the combo box, it gets activated by this action bar. The active settable that used to be active now becomes inactive, as it was notified by the map that another projection was activated (by a third party). At all times, the collapsed combo box shows the current map projection. If you select the regular action from the combo, the dialog is shown, but the active state of all active settables remains unchanged.

Limitations

  • The combo box is not editable, so no values can be typed.
  • It does not support sub-menus (throws exceptions).
  • aDeactivatePossible of the insertActiveSettable method must be false, an exception is thrown otherwise.
  • Only the name of an action or active settable is displayed. Other things such as the icon are ignored.
  • It does not support ILcyCustomizableRepresentationAction or ILcyCustomizableRepresentationActiveSettable
  • It does not have separators between groups.
  • Actions that hide or disable themselves shouldn't be added to this combo box as it does not respect the enabled and visible state of the actions.
Since:
2012.0

  • Constructor Details

    • TLcyComboBoxActionBar

      public TLcyComboBoxActionBar()
      Creates a new TLcyComboBoxActionBar, ready to be used.

    • TLcyComboBoxActionBar

      public TLcyComboBoxActionBar(ALcyHelpManager aHelpManager)
      Creates a new TLcyComboBoxActionBar, ready to be used.
      Parameters:
      aHelpManager - The help manager.

  • Method Details

    • isAutoHide

      public boolean isAutoHide()

      Returns the autoHide property of the action bar.

      When the autoHide property is true, the component of the action bar will become invisible when it is empty.

      This action bar is considered empty when the combo-box does not contain any items.

      Overrides:
      isAutoHide in class ALcyActionBar
      Returns:
      the autoHide property of the action bar.
      See Also:

    • setAutoHide

      public void setAutoHide(boolean aAutoHide)

      Set the autoHide property of the action bar.

      When set to true, the component of the action bar will become invisible when the action bar is empty.

      The default implementation of this method considers an action bar empty when the component representing the action bar is a Container without any visible child components.

      This action bar is considered empty when the combo-box does not contain any items.

      Overrides:
      setAutoHide in class ALcyActionBar
      Parameters:
      aAutoHide - true when the an empty action bar must be invisible, false otherwise.
      See Also:

    • getComponent

      public Component getComponent()
      Description copied from interface: ILcyActionBar

      Returns the visual component representing this action bar, so that it can be added to the application UI.

      Components should not be added to it or removed from it directly using Swing. Use the various insert methods instead.

      Specified by:
      getComponent in interface ILcyActionBar
      Returns:
      the visual component representing this action bar.

    • createItem

      protected Component createItem(ILcdAction aAction, TLcyGroupDescriptor aGroupDescriptor, String[] aMenus, TLcyGroupDescriptor[] aMenuGroupDescriptors)
      Description copied from class: ALcyActionBar
      Creates a gui widget to represent the given action. E.g. a menu bar could create a JMenuItem to represent the given action. A toolbar could create a JButton to represent the given action.
      Specified by:
      createItem in class ALcyActionBar
      Parameters:
      aAction - The action to create a gui widget for.
      aGroupDescriptor - The group descriptor, for information only.
      aMenus - The menus, for information only.
      aMenuGroupDescriptors - The menu group descriptors, for information only.
      Returns:
      The created gui widget.

    • createItem

      protected Component createItem(ILcyActiveSettable aActiveSettable, TLcyGroupDescriptor aGroupDescriptor, String[] aMenus, TLcyGroupDescriptor[] aMenuGroupDescriptors, boolean aDeactivatePossible)
      Description copied from class: ALcyActionBar
      Creates a gui widget to represent the given active settable. E.g. a menu bar could create a JCheckBoxMenuItem to represent the given action or a JRadioButtonMenuItem when aDeactivatePossible is false. A toolbar could create a JToggleButton to represent the given active settable.
      Specified by:
      createItem in class ALcyActionBar
      Parameters:
      aActiveSettable - The active settable to create a gui widget for.
      aGroupDescriptor - The group descriptor, for information only.
      aMenus - The menus, for information only.
      aMenuGroupDescriptors - The menu group descriptors, for information only.
      aDeactivatePossible - True means the active settable can be deactivated using the created gui widget (e.g. a checkbox), false means it cannot be deactivated by the created gui widget, probably only by another widget (e.g. radio button).
      Returns:
      The created gui widget.

    • getItemContainer

      protected Container getItemContainer(String[] aMenus, TLcyGroupDescriptor[] aMenuGroupDescriptors)
      Description copied from class: ALcyActionBar
      Retrieves the (sub)menu container that contains the actions or active settables at the given (sub)menus. If no such container exists, null is returned. If the aMenus is null or an empty array, it shall not return null but it must return the top level container.

      Specified by:
      getItemContainer in class ALcyActionBar
      Parameters:
      aMenus - The (sub)menus to retrieve the container for. If null or an empty array, the top level container should be returned.
      aMenuGroupDescriptors - The menu group descriptors, just for information. Could be null, or the length of the array can possibly mismatch the length of the menus.
      Returns:
      the container that contains the actions or active settables at the given (sub)menus.

    • createItemContainer

      protected Container createItemContainer(String[] aMenus, TLcyGroupDescriptor[] aMenuGroupDescriptors)
      Description copied from class: ALcyActionBar
      Creates a new container for the given (sub)menus. The actions and active settables that need to be added to the given (sub)menus will be added to the created container. The created menu must not be inserted into its parent.

      An example implemention could look like this:

      return new JMenu( aMenus[ aMenus.length - 1 ] )
      Specified by:
      createItemContainer in class ALcyActionBar
      Parameters:
      aMenus - The (sub)menus to create the menu item container for. Is never null and length of array is at least 1.
      aMenuGroupDescriptors - The menu group descriptors for the menus. Could be null, or the length of the array can possibly mismatch the length of the menus.
      Returns:
      a new container for the given (sub)menus.

    • insertSeparator

      protected void insertSeparator(int aIndex, Container aContainerSFCT)
      Description copied from class: ALcyActionBar
      Inserts a separator at the given index into the given component.

      Implementation can be left empty, but if and only if implementation of ALcyActionBar.removeSeparator(int, java.awt.Container) is left empty as well.

      Specified by:
      insertSeparator in class ALcyActionBar
      Parameters:
      aIndex - The index of where to insert the separator. -1 means insert it at the end.
      aContainerSFCT - The container to insert the separator into.

    • removeSeparator

      protected void removeSeparator(int aIndex, Container aContainerSFCT)
      Description copied from class: ALcyActionBar
      Removes the separator at the given index from the given component.

      Implementation can be left empty, but if and only if implementation of ALcyActionBar.insertSeparator(int, java.awt.Container) is left empty as well.

      Specified by:
      removeSeparator in class ALcyActionBar
      Parameters:
      aIndex - The index where to remove the separator from the given component.
      aContainerSFCT - The container to remove the separator from.

    • getChildren

      protected Component[] getChildren(Container aParent)
      Description copied from class: ALcyActionBar
      Returns all children of a given parent, including separators etc.

      This implementation returns aParent.getComponents(), but subclasses using for instance JMenus should be aware that they should return ( ( JMenu ) aParent ).getMenuComponents() when the given parent is a JMenu.

      Overrides:
      getChildren in class ALcyActionBar
      Parameters:
      aParent - The parent to retrieve the children from.
      Returns:
      An array containing all children of the given parent.

    • getParent

      protected Container getParent(Component aComponent)
      Description copied from class: ALcyActionBar
      Returns the parent of a given component.

      This implementation returns aComponent.getParent(), but subclasses using for instance JPopupMenus (these are used for example by JMenus) must return ( ( JPopupMenu ) aComponent ).getInvoker() when the given component is a JPopupMenu.

      Overrides:
      getParent in class ALcyActionBar
      Parameters:
      aComponent - The component to retrieve the parent for.
      Returns:
      The parent of the given component, or null.