Package io.guise.framework.component

Interface Menu

All Superinterfaces:
ActionControl, ActionListenable, ActionModel, Component, CompositeComponent, Container, ContainerControl, Control, DepictedObject, Displayable, Enableable, InfoModel, InputFocusableComponent, Iterable<Component>, LabelDisplayableComponent, LabelModel, LayoutComponent, Model, PresentationModel, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable
All Known Implementing Classes:
AbstractMenu, AccordionMenu, DropMenu
public interface Menu extends ContainerControl, ActionControl, LabelDisplayableComponent
A group of components arranged as a menu. This component uses a MenuPrototype and a MenuLayout.
Author:
Garret Wilson
See Also:

  • Field Details

    • OPEN_PROPERTY

      static final String OPEN_PROPERTY
      The open bound property.

    • ROLLOVER_OPEN_ENABLED_PROPERTY

      static final String ROLLOVER_OPEN_ENABLED_PROPERTY
      The bound property of whether children will be displayed upon rollover.

  • Method Details

    • getLayout

      MenuLayout getLayout()
      Specified by:
      getLayout in interface LayoutComponent
      Returns:
      The layout definition for the menu.

    • isOpen

      boolean isOpen()
      Returns:
      Whether the menu is open.

    • setOpen

      void setOpen(boolean newOpen)
      Sets whether the menu is open. This is a bound property of type Boolean.
      Parameters:
      newOpen - true if the menu should be open.
      See Also:

    • isRolloverOpenEnabled

      boolean isRolloverOpenEnabled()
      Returns:
      Whether the menu children will be shown during rollover.

    • setRolloverOpenEnabled

      void setRolloverOpenEnabled(boolean newRolloverOpenEnabled)
      Sets whether the menu children will be shown during rollover. If rollover open is enabled, the open state will not actually be changed during rollover. This is a bound property of type Boolean.
      Parameters:
      newRolloverOpenEnabled - true if the component should allow display during rollover, else false.
      See Also: