Class WMenuItem

public class WMenuItem extends WContainerWidget
A single item in a menu.

Since JWt 3.3.0, this item is now a proper widget, which renders a single item in a menu.

An optional contents item can be associated with a menu item, which is inserted and shown in the widget stack of the menu to which this menu item belongs.


A menu item renders as a >li&;lt with additional markup/style classes provided by the theme. Unless you use the bootstrap theme, you will need to provide appropriate CSS.

  • Constructor Details

  • Method Details

    • remove

      public void remove()
      Description copied from class: WContainerWidget
      remove in class WContainerWidget
      See Also:
    • setText

      public void setText(CharSequence text)
      Sets the text for this item.

      Unless a custom path component was defined, the getPathComponent() is also updated based on the new text.

      The item widget is updated using updateItemWidget().

      See Also:
    • getText

      public WString getText()
      Returns the text for this item.

      See Also:
    • setIcon

      public void setIcon(String path)
      Sets the item icon path.

      The icon should have a width of 16 pixels.

      See Also:
    • getIcon

      public String getIcon()
      Returns the item icon path.

      See Also:
    • setCheckable

      public void setCheckable(boolean checkable)
      Sets if the item is checkable.

      When an item is checkable, a checkbox is displayed to the left of the item text (instead of an icon).

      See Also:
    • isCheckable

      public boolean isCheckable()
      Returns whether the item is checkable.

      See Also:
    • setPathComponent

      public void setPathComponent(String path)
      Sets the path component for this item.

      The path component is used by the menu item in the application internal path (see WApplication#setInternalPath()), when internal paths are enabled (see WMenu#setInternalPathEnabled()) for the menu.

      You may specify an empty path to let a menu item be the "default" menu option.

      For example, if WMenu.getInternalBasePath() is "/examples/" and getPathComponent() for is "charts/" , then the internal path for the item will be "/examples/charts/" .

      By default, the path is automatically derived from getText(). If a WString.isLiteral() is used, the path is based on the text itself, otherwise on the WString.getKey(). It is converted to lower case, and replacing whitespace and special characters with '_'.

      See Also:
    • getPathComponent

      public String getPathComponent()
      Returns the path component for this item.

      You may want to reimplement this to customize the path component set by the item in the application internal path.

      See Also:
    • setInternalPathEnabled

      public void setInternalPathEnabled(boolean enabled)
      Configures internal path support for the item.

      This configures whether the item supports internal paths (in a menu which supports internal paths).

      The default value is true for all items but section headers and separators.

      See Also:
    • isInternalPathEnabled

      public boolean isInternalPathEnabled()
      Returns whether an item participates in internal paths.

      See Also:
    • setLink

      public void setLink(WLink link)
      Sets the associated link.
    • getLink

      public WLink getLink()
      Returns the associated link.

      See Also:
    • setMenu

      public void setMenu(WMenu menu)
      Sets a sub menu.

      In most cases, the sub menu would use the same contents stack as the parent menu.

      Note that adding a submenu makes this item not selectable by default.

      Note: If the parent menu is a WPopupMenu, the submenu should also be a WPopupMenu.

      See Also:
    • getMenu

      public WMenu getMenu()
      Returns the submenu.

      See Also:
    • setChecked

      public void setChecked(boolean checked)
      Sets the checked state.

      This is only used when isCheckable() == true.

      See Also:
    • isChecked

      public boolean isChecked()
      Returns the checked state.

      This is only used when isCheckable() == true.

      See Also:
    • setSelectable

      public void setSelectable(boolean selectable)
      Sets whether the menu item can be selected.

      Only a menu item that can be selected can be the result of a popup menu selection.

      The default value is true for a normal menu item, and false for a menu item that has a popup submenu.

      An item that is selectable but is disabled can still not be selected.

      setSelectable in class WWebWidget
    • isSelectable

      public boolean isSelectable()
      Returns whether the menu item can be selected.

      See Also:
    • setData

      public void setData(Object data)
      Sets associated additional data with the item.

      You can use this to associate model information with a menu item.

    • getData

      public Object getData()
      Returns additional data of the item.

      See Also:
    • getCheckBox

      public WCheckBox getCheckBox()
      Returns the checkbox for a checkable item.

      See Also:
    • setCloseable

      public void setCloseable(boolean closeable)
      Make it possible to close this item interactively or by close().

      See Also:
    • isCloseable

      public boolean isCloseable()
      Returns whether the item is closeable.

      See Also:
    • close

      public void close()
      Closes this item.

      Hides the item widget and emits WMenu.itemClosed() signal. Only closeable items can be closed.

      See Also:
    • getParentMenu

      public WMenu getParentMenu()
      Returns the menu that contains this item.
    • setContents

      public void setContents(WWidget contents, ContentLoading policy)
      Sets the contents widget for this item.

      The contents is a widget that will be shown in the WMenu contents stack when the item is selected. For this widget, the load policy specifies whether the contents widgets is transmitted only when it the item is activated for the first time (LazyLoading) or transmitted prior to first rendering.

    • setContents

      public final void setContents(WWidget contents)
      Sets the contents widget for this item.

      Calls setContents(contents, ContentLoading.Lazy)

    • getContents

      public WWidget getContents()
      Returns the contents widget for this item.

      See Also:
    • getRemoveContents

      public WWidget getRemoveContents()
      Removes the contents widget from this item.
    • select

      public void select()
      Selects this item.

      If the item was previously closed it will be shown.

      See Also:
    • triggered

      public Signal1<WMenuItem> triggered()
      Signal emitted when an item is activated.

      Returns this item as argument.

    • isSeparator

      public boolean isSeparator()
      Returns whether this item is a separator.

      See Also:
    • isSectionHeader

      public boolean isSectionHeader()
      Returns whether this item is a section header.

      See Also:
    • getAnchor

      public WAnchor getAnchor()
      Returns the anchor of this menu item.

      Can be used to add widgets to the menu.

    • renderSelected

      public void renderSelected(boolean selected)
      Renders the item as selected or unselected.

      The default implementation sets the styleclass for itemWidget() to 'item' for an unselected not closeable, 'itemselected' for selected not closeable, 'citem' for an unselected closeable and 'citemselected' for selected closeable item.

      Note that this method is called from within a stateless slot implementation, and thus should be stateless as well.

    • enableAjax

      public void enableAjax()
      Description copied from class: WWidget
      Progresses to an Ajax-enabled widget.

      This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.

      You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.

      enableAjax in class WWebWidget
      See Also:
    • setHidden

      public void setHidden(boolean hidden, WAnimation animation)
      Description copied from class: WWidget
      Hides or shows the widget.

      Hides or show the widget (including all its descendant widgets). When setting hidden = false, this widget and all descendant widgets that are not hidden will be shown. A widget is only visible if it and all its ancestors in the widget tree are visible, which may be checked using isVisible().

      setHidden in class WWebWidget
    • setDisabled

      public void setDisabled(boolean disabled)
      Description copied from class: WWidget
      Sets whether the widget is disabled.

      Enables or disables the widget (including all its descendant widgets). setDisabled(false) will enable this widget and all descendant widgets that are not disabled. A widget is only enabled if it and all its ancestors in the widget tree are disabled.

      Typically, a disabled form widget will not allow changing the value, and disabled widgets will not react to mouse click events.

      setDisabled in class WWebWidget
      See Also:
    • render

      protected void render(EnumSet<RenderFlag> flags)
      Description copied from class: WWidget
      Renders the widget.

      This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

      The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

      render in class WWebWidget