Package org.primefaces.model.menu

Class DefaultMenuItem

java.lang.Object
org.primefaces.model.menu.DefaultMenuItem
All Implemented Interfaces:
Serializable, AjaxSource, Confirmable, UIOutcomeTarget, MenuElement, MenuItem
public class DefaultMenuItem extends Object implements MenuItem, UIOutcomeTarget, AjaxSource, Serializable
See Also:

  • Constructor Details

    • DefaultMenuItem

      public DefaultMenuItem()
      Creates a new menu item without value.

  • Method Details

    • getId

      public String getId()
      Description copied from interface: MenuElement
      Allows access the id property which is managed and auto-assigned by callers like menu model implementations and used to identify the element. The property is unrelated to the id attribute in the generated XHTML.
      Specified by:
      getId in interface MenuElement
      Returns:
      the id property

    • setId

      public void setId(String id)
      Description copied from interface: MenuElement
      Sets the id property which is described in MenuElement.getId(). You should have a good reason to call this if you're not extending, but only using PrimeFaces. The property is unrelated to the id attribute in the generated XHTML.
      Specified by:
      setId in interface MenuElement
      Parameters:
      id - the id value

    • getIcon

      public String getIcon()
      Specified by:
      getIcon in interface MenuItem

    • getIconPos

      public String getIconPos()
      Specified by:
      getIconPos in interface MenuItem

    • setIconPos

      public void setIconPos(String iconPos)

    • setIcon

      public void setIcon(String icon)

    • getTitle

      public String getTitle()
      Specified by:
      getTitle in interface MenuItem

    • setTitle

      public void setTitle(String title)

    • isDisabled

      public boolean isDisabled()
      Specified by:
      isDisabled in interface MenuItem

    • setDisabled

      public void setDisabled(boolean disabled)

    • getOnclick

      public String getOnclick()
      Specified by:
      getOnclick in interface MenuItem

    • setOnclick

      public void setOnclick(String onclick)

    • getStyle

      public String getStyle()
      Specified by:
      getStyle in interface MenuItem

    • setStyle

      public void setStyle(String style)

    • getStyleClass

      public String getStyleClass()
      Specified by:
      getStyleClass in interface MenuItem

    • setStyleClass

      public void setStyleClass(String styleClass)
      Specified by:
      setStyleClass in interface MenuItem

    • getHref

      public String getHref()
      Specified by:
      getHref in interface UIOutcomeTarget

    • setHref

      public void setHref(String href)

    • getUrl

      public String getUrl()
      Description copied from interface: MenuItem
      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.
      Specified by:
      getUrl in interface MenuItem
      Returns:
      the URL.

    • setUrl

      public void setUrl(String url)

    • getTarget

      public String getTarget()
      Specified by:
      getTarget in interface MenuItem

    • setTarget

      public void setTarget(String target)

    • getOutcome

      public String getOutcome()
      Description copied from interface: MenuItem
      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.
      Specified by:
      getOutcome in interface MenuItem
      Specified by:
      getOutcome in interface UIOutcomeTarget
      Returns:
      the outcome.

    • setOutcome

      public void setOutcome(String outcome)

    • isAjax

      public boolean isAjax()
      Specified by:
      isAjax in interface MenuItem

    • setAjax

      public void setAjax(boolean ajax)

    • getValue

      public Object getValue()
      Specified by:
      getValue in interface MenuItem

    • setValue

      public void setValue(Object value)

    • isIncludeViewParams

      public boolean isIncludeViewParams()
      Specified by:
      isIncludeViewParams in interface MenuItem
      Specified by:
      isIncludeViewParams in interface UIOutcomeTarget

    • setIncludeViewParams

      public void setIncludeViewParams(boolean includeViewParams)

    • getFragment

      public String getFragment()
      Specified by:
      getFragment in interface MenuItem
      Specified by:
      getFragment in interface UIOutcomeTarget

    • setFragment

      public void setFragment(String fragment)

    • getParams

      public Map<String,List<String>> getParams()
      Specified by:
      getParams in interface MenuItem
      Specified by:
      getParams in interface UIOutcomeTarget

    • setParams

      public void setParams(Map<String,List<String>> params)

    • setParam

      public void setParam(String key, Object value)
      Specified by:
      setParam in interface MenuItem

    • shouldRenderChildren

      public boolean shouldRenderChildren()
      Specified by:
      shouldRenderChildren in interface MenuItem

    • getChildren

      public List<javax.faces.component.UIComponent> getChildren()
      Specified by:
      getChildren in interface UIOutcomeTarget

    • isDynamic

      public boolean isDynamic()
      Specified by:
      isDynamic in interface MenuItem

    • getCommand

      public String getCommand()
      Description copied from interface: MenuItem
      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.
      Specified by:
      getCommand in interface MenuItem
      Returns:
      The outcome, which will be used for navigation.

    • setCommand

      public void setCommand(String command)

    • getFunction

      public SerializableFunction<MenuItem,String> getFunction()
      Description copied from interface: MenuItem
      Lambda alternative to the MenuItem.getCommand().
      Specified by:
      getFunction in interface MenuItem
      Returns:
      The outcome, which will be used for navigation.

    • setFunction

      public void setFunction(SerializableFunction<MenuItem,String> function)

    • isRendered

      public boolean isRendered()
      Specified by:
      isRendered in interface MenuElement

    • setRendered

      public void setRendered(boolean rendered)

    • getOnstart

      public String getOnstart()
      Specified by:
      getOnstart in interface AjaxSource

    • setOnstart

      public void setOnstart(String onstart)

    • getOnerror

      public String getOnerror()
      Specified by:
      getOnerror in interface AjaxSource

    • setOnerror

      public void setOnerror(String onerror)

    • getOnsuccess

      public String getOnsuccess()
      Specified by:
      getOnsuccess in interface AjaxSource

    • setOnsuccess

      public void setOnsuccess(String onsuccess)

    • getOncomplete

      public String getOncomplete()
      Specified by:
      getOncomplete in interface AjaxSource

    • setOncomplete

      public void setOncomplete(String oncomplete)

    • getUpdate

      public String getUpdate()
      Specified by:
      getUpdate in interface AjaxSource

    • setUpdate

      public void setUpdate(String update)

    • getProcess

      public String getProcess()
      Specified by:
      getProcess in interface AjaxSource

    • setProcess

      public void setProcess(String process)

    • isPartialSubmit

      public boolean isPartialSubmit()
      Specified by:
      isPartialSubmit in interface AjaxSource

    • setPartialSubmit

      public void setPartialSubmit(boolean partialSubmit)

    • isResetValues

      public boolean isResetValues()
      Specified by:
      isResetValues in interface AjaxSource

    • setResetValues

      public void setResetValues(boolean resetValues)

    • isGlobal

      public boolean isGlobal()
      Specified by:
      isGlobal in interface AjaxSource

    • setGlobal

      public void setGlobal(boolean global)

    • isAsync

      public boolean isAsync()
      Specified by:
      isAsync in interface AjaxSource

    • setAsync

      public void setAsync(boolean async)

    • isPartialSubmitSet

      public boolean isPartialSubmitSet()
      Specified by:
      isPartialSubmitSet in interface AjaxSource

    • isResetValuesSet

      public boolean isResetValuesSet()
      Specified by:
      isResetValuesSet in interface AjaxSource

    • isIgnoreAutoUpdate

      public boolean isIgnoreAutoUpdate()
      Specified by:
      isIgnoreAutoUpdate in interface AjaxSource

    • setIgnoreAutoUpdate

      public void setIgnoreAutoUpdate(boolean ignoreAutoUpdate)

    • isImmediate

      public boolean isImmediate()
      Specified by:
      isImmediate in interface MenuItem

    • setImmediate

      public void setImmediate(boolean immediate)

    • isAjaxified

      public boolean isAjaxified()
      Specified by:
      isAjaxified in interface AjaxSource

    • getDelay

      public String getDelay()
      Specified by:
      getDelay in interface AjaxSource

    • setDelay

      public void setDelay(String delay)

    • isDisableClientWindow

      public boolean isDisableClientWindow()
      Specified by:
      isDisableClientWindow in interface UIOutcomeTarget

    • setDisableClientWindow

      public void setDisableClientWindow(boolean disableClientWindow)

    • getContainerStyle

      public String getContainerStyle()
      Specified by:
      getContainerStyle in interface MenuItem

    • setContainerStyle

      public void setContainerStyle(String containerStyle)

    • getContainerStyleClass

      public String getContainerStyleClass()
      Specified by:
      getContainerStyleClass in interface MenuItem

    • setContainerStyleClass

      public void setContainerStyleClass(String containerStyleClass)

    • getClientId

      public String getClientId()
      Specified by:
      getClientId in interface MenuItem

    • getTimeout

      public int getTimeout()
      Specified by:
      getTimeout in interface AjaxSource

    • setTimeout

      public void setTimeout(int timeout)

    • getPartialSubmitFilter

      public String getPartialSubmitFilter()
      Specified by:
      getPartialSubmitFilter in interface AjaxSource

    • setPartialSubmitFilter

      public void setPartialSubmitFilter(String partialSubmitFilter)

    • getForm

      public String getForm()
      Specified by:
      getForm in interface AjaxSource

    • setForm

      public void setForm(String form)

    • getConfirmationScript

      public String getConfirmationScript()
      Specified by:
      getConfirmationScript in interface Confirmable

    • setConfirmationScript

      public void setConfirmationScript(String confirmationScript)
      Specified by:
      setConfirmationScript in interface Confirmable

    • requiresConfirmation

      public boolean requiresConfirmation()
      Specified by:
      requiresConfirmation in interface Confirmable

    • isEscape

      public boolean isEscape()
      Specified by:
      isEscape in interface MenuItem

    • setEscape

      public void setEscape(boolean escape)

    • getRel

      public String getRel()
      Specified by:
      getRel in interface MenuItem

    • setRel

      public void setRel(String rel)

    • getAriaLabel

      public String getAriaLabel()
      Specified by:
      getAriaLabel in interface MenuItem

    • setAriaLabel

      public void setAriaLabel(String ariaLabel)

    • isIgnoreComponentNotFound

      public boolean isIgnoreComponentNotFound()
      Specified by:
      isIgnoreComponentNotFound in interface AjaxSource

    • setIgnoreComponentNotFound

      public void setIgnoreComponentNotFound(boolean ignoreComponentNotFound)

    • getBadge

      public Object getBadge()
      Specified by:
      getBadge in interface MenuItem

    • setBadge

      public void setBadge(Object badge)

    • builder

      public static DefaultMenuItem.Builder builder()