Interface MenuItem

All Superinterfaces:
Confirmable, MenuElement
All Known Implementing Classes:
DefaultMenuItem, UIMenuItem, UIMenuItemBase

public interface MenuItem extends MenuElement, Confirmable
  • Method Details

    • getIcon

      String getIcon()
    • getIconPos

      String getIconPos()
    • getTitle

      String getTitle()
    • shouldRenderChildren

      boolean shouldRenderChildren()
    • isDisabled

      boolean isDisabled()
    • getOnclick

      String getOnclick()
    • getStyle

      String getStyle()
    • getStyleClass

      String getStyleClass()
    • getUrl

      String getUrl()
      The URL to redirect to after the menu item has been clicked. Similar to outcome which allows to specify a navigation case, but the value is not touched (no prepending of the contextPath, not appending the sessionId or windowId), just encoded. Specifying a url which is not null causes command to be ignored.
      Returns:
      the URL.
    • getTarget

      String getTarget()
    • getOutcome

      String getOutcome()
      The JSF outcome of a navigation case which is resolved by the configured NavigationHandler. Similar to url, but url allows to specify fully qualified URLs.
      Returns:
      the outcome.
    • getFragment

      String getFragment()
    • isIncludeViewParams

      boolean isIncludeViewParams()
    • isAjax

      boolean isAjax()
    • getValue

      Object getValue()
    • setStyleClass

      void setStyleClass(String styleClass)
    • getParams

      Map<String,List<String>> getParams()
    • setParam

      void setParam(String key, Object value)
    • isDynamic

      boolean isDynamic()
    • getCommand

      String getCommand()
      A MethodExpression in the form of a string which is called after the menu item has been clicked. It is ignored when url is not null.
      Returns:
      The outcome, which will be used for navigation.
    • getFunction

      Lambda alternative to the getCommand().
      Returns:
      The outcome, which will be used for navigation.
    • isImmediate

      boolean isImmediate()
    • getClientId

      String getClientId()
    • getContainerStyle

      String getContainerStyle()
    • getContainerStyleClass

      String getContainerStyleClass()
    • isEscape

      boolean isEscape()
    • getRel

      String getRel()
    • getAriaLabel

      String getAriaLabel()
    • getBadge

      Object getBadge()