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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDefaultMenuItem.Builder
-
Constructor Summary
Constructors Constructor Description DefaultMenuItem()Creates a new menu item without value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DefaultMenuItem.Builderbuilder()List<javax.faces.component.UIComponent>getChildren()StringgetClientId()StringgetCommand()AMethodExpressionin the form of a string which is called after the menu item has been clicked.StringgetConfirmationScript()StringgetContainerStyle()StringgetContainerStyleClass()StringgetDelay()StringgetForm()StringgetFragment()SerializableFunction<MenuItem,String>getFunction()Lambda alternative to theMenuItem.getCommand().StringgetHref()StringgetIcon()StringgetIconPos()StringgetId()Allows access the id property which is managed and auto-assigned by callers like menu model implementations and used to identify the element.StringgetOnclick()StringgetOncomplete()StringgetOnerror()StringgetOnstart()StringgetOnsuccess()StringgetOutcome()The JSF outcome of a navigation case which is resolved by the configuredNavigationHandler.Map<String,List<String>>getParams()StringgetPartialSubmitFilter()StringgetProcess()StringgetRel()StringgetStyle()StringgetStyleClass()StringgetTarget()intgetTimeout()StringgetTitle()StringgetUpdate()StringgetUrl()The URL to redirect to after the menu item has been clicked.ObjectgetValue()booleanisAjax()booleanisAjaxified()booleanisAsync()booleanisDisableClientWindow()booleanisDisabled()booleanisDynamic()booleanisEscape()booleanisGlobal()booleanisIgnoreAutoUpdate()booleanisIgnoreComponentNotFound()booleanisImmediate()booleanisIncludeViewParams()booleanisPartialSubmit()booleanisPartialSubmitSet()booleanisRendered()booleanisResetValues()booleanisResetValuesSet()booleanrequiresConfirmation()voidsetAjax(boolean ajax)voidsetAsync(boolean async)voidsetCommand(String command)voidsetConfirmationScript(String confirmationScript)voidsetContainerStyle(String containerStyle)voidsetContainerStyleClass(String containerStyleClass)voidsetDelay(String delay)voidsetDisableClientWindow(boolean disableClientWindow)voidsetDisabled(boolean disabled)voidsetEscape(boolean escape)voidsetForm(String form)voidsetFragment(String fragment)voidsetFunction(SerializableFunction<MenuItem,String> function)voidsetGlobal(boolean global)voidsetHref(String href)voidsetIcon(String icon)voidsetIconPos(String iconPos)voidsetId(String id)Sets the id property which is described inMenuElement.getId().voidsetIgnoreAutoUpdate(boolean ignoreAutoUpdate)voidsetIgnoreComponentNotFound(boolean ignoreComponentNotFound)voidsetImmediate(boolean immediate)voidsetIncludeViewParams(boolean includeViewParams)voidsetOnclick(String onclick)voidsetOncomplete(String oncomplete)voidsetOnerror(String onerror)voidsetOnstart(String onstart)voidsetOnsuccess(String onsuccess)voidsetOutcome(String outcome)voidsetParam(String key, Object value)voidsetParams(Map<String,List<String>> params)voidsetPartialSubmit(boolean partialSubmit)voidsetPartialSubmitFilter(String partialSubmitFilter)voidsetProcess(String process)voidsetRel(String rel)voidsetRendered(boolean rendered)voidsetResetValues(boolean resetValues)voidsetStyle(String style)voidsetStyleClass(String styleClass)voidsetTarget(String target)voidsetTimeout(int timeout)voidsetTitle(String title)voidsetUpdate(String update)voidsetUrl(String url)voidsetValue(Object value)booleanshouldRenderChildren()
-
-
-
Method Detail
-
getId
public String getId()
Description copied from interface:MenuElementAllows 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 theidattribute in the generated XHTML.- Specified by:
getIdin interfaceMenuElement- Returns:
- the id property
-
setId
public void setId(String id)
Description copied from interface:MenuElementSets the id property which is described inMenuElement.getId(). You should have a good reason to call this if you're not extending, but only using PrimeFaces. The property is unrelated to theidattribute in the generated XHTML.- Specified by:
setIdin interfaceMenuElement- Parameters:
id- the id value
-
getIconPos
public String getIconPos()
- Specified by:
getIconPosin interfaceMenuItem
-
setIconPos
public void setIconPos(String iconPos)
-
setIcon
public void setIcon(String icon)
-
setTitle
public void setTitle(String title)
-
isDisabled
public boolean isDisabled()
- Specified by:
isDisabledin interfaceMenuItem
-
setDisabled
public void setDisabled(boolean disabled)
-
getOnclick
public String getOnclick()
- Specified by:
getOnclickin interfaceMenuItem
-
setOnclick
public void setOnclick(String onclick)
-
setStyle
public void setStyle(String style)
-
getStyleClass
public String getStyleClass()
- Specified by:
getStyleClassin interfaceMenuItem
-
setStyleClass
public void setStyleClass(String styleClass)
- Specified by:
setStyleClassin interfaceMenuItem
-
getHref
public String getHref()
- Specified by:
getHrefin interfaceUIOutcomeTarget
-
setHref
public void setHref(String href)
-
getUrl
public String getUrl()
Description copied from interface:MenuItemThe URL to redirect to after the menu item has been clicked. Similar tooutcomewhich 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 aurlwhich is notnullcausescommandto be ignored.
-
setUrl
public void setUrl(String url)
-
setTarget
public void setTarget(String target)
-
getOutcome
public String getOutcome()
Description copied from interface:MenuItemThe JSF outcome of a navigation case which is resolved by the configuredNavigationHandler. Similar tourl, buturlallows to specify fully qualified URLs.- Specified by:
getOutcomein interfaceMenuItem- Specified by:
getOutcomein interfaceUIOutcomeTarget- Returns:
- the outcome.
-
setOutcome
public void setOutcome(String outcome)
-
setAjax
public void setAjax(boolean ajax)
-
setValue
public void setValue(Object value)
-
isIncludeViewParams
public boolean isIncludeViewParams()
- Specified by:
isIncludeViewParamsin interfaceMenuItem- Specified by:
isIncludeViewParamsin interfaceUIOutcomeTarget
-
setIncludeViewParams
public void setIncludeViewParams(boolean includeViewParams)
-
getFragment
public String getFragment()
- Specified by:
getFragmentin interfaceMenuItem- Specified by:
getFragmentin interfaceUIOutcomeTarget
-
setFragment
public void setFragment(String fragment)
-
getParams
public Map<String,List<String>> getParams()
- Specified by:
getParamsin interfaceMenuItem- Specified by:
getParamsin interfaceUIOutcomeTarget
-
shouldRenderChildren
public boolean shouldRenderChildren()
- Specified by:
shouldRenderChildrenin interfaceMenuItem
-
getChildren
public List<javax.faces.component.UIComponent> getChildren()
- Specified by:
getChildrenin interfaceUIOutcomeTarget
-
getCommand
public String getCommand()
Description copied from interface:MenuItemAMethodExpressionin the form of a string which is called after the menu item has been clicked. It is ignored whenurlis notnull.- Specified by:
getCommandin interfaceMenuItem- 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:MenuItemLambda alternative to theMenuItem.getCommand().- Specified by:
getFunctionin interfaceMenuItem- Returns:
- The outcome, which will be used for navigation.
-
setFunction
public void setFunction(SerializableFunction<MenuItem,String> function)
-
isRendered
public boolean isRendered()
- Specified by:
isRenderedin interfaceMenuElement
-
setRendered
public void setRendered(boolean rendered)
-
getOnstart
public String getOnstart()
- Specified by:
getOnstartin interfaceAjaxSource
-
setOnstart
public void setOnstart(String onstart)
-
getOnerror
public String getOnerror()
- Specified by:
getOnerrorin interfaceAjaxSource
-
setOnerror
public void setOnerror(String onerror)
-
getOnsuccess
public String getOnsuccess()
- Specified by:
getOnsuccessin interfaceAjaxSource
-
setOnsuccess
public void setOnsuccess(String onsuccess)
-
getOncomplete
public String getOncomplete()
- Specified by:
getOncompletein interfaceAjaxSource
-
setOncomplete
public void setOncomplete(String oncomplete)
-
getUpdate
public String getUpdate()
- Specified by:
getUpdatein interfaceAjaxSource
-
setUpdate
public void setUpdate(String update)
-
getProcess
public String getProcess()
- Specified by:
getProcessin interfaceAjaxSource
-
setProcess
public void setProcess(String process)
-
isPartialSubmit
public boolean isPartialSubmit()
- Specified by:
isPartialSubmitin interfaceAjaxSource
-
setPartialSubmit
public void setPartialSubmit(boolean partialSubmit)
-
isResetValues
public boolean isResetValues()
- Specified by:
isResetValuesin interfaceAjaxSource
-
setResetValues
public void setResetValues(boolean resetValues)
-
isGlobal
public boolean isGlobal()
- Specified by:
isGlobalin interfaceAjaxSource
-
setGlobal
public void setGlobal(boolean global)
-
isAsync
public boolean isAsync()
- Specified by:
isAsyncin interfaceAjaxSource
-
setAsync
public void setAsync(boolean async)
-
isPartialSubmitSet
public boolean isPartialSubmitSet()
- Specified by:
isPartialSubmitSetin interfaceAjaxSource
-
isResetValuesSet
public boolean isResetValuesSet()
- Specified by:
isResetValuesSetin interfaceAjaxSource
-
isIgnoreAutoUpdate
public boolean isIgnoreAutoUpdate()
- Specified by:
isIgnoreAutoUpdatein interfaceAjaxSource
-
setIgnoreAutoUpdate
public void setIgnoreAutoUpdate(boolean ignoreAutoUpdate)
-
isImmediate
public boolean isImmediate()
- Specified by:
isImmediatein interfaceMenuItem
-
setImmediate
public void setImmediate(boolean immediate)
-
isAjaxified
public boolean isAjaxified()
- Specified by:
isAjaxifiedin interfaceAjaxSource
-
getDelay
public String getDelay()
- Specified by:
getDelayin interfaceAjaxSource
-
setDelay
public void setDelay(String delay)
-
isDisableClientWindow
public boolean isDisableClientWindow()
- Specified by:
isDisableClientWindowin interfaceUIOutcomeTarget
-
setDisableClientWindow
public void setDisableClientWindow(boolean disableClientWindow)
-
getContainerStyle
public String getContainerStyle()
- Specified by:
getContainerStylein interfaceMenuItem
-
setContainerStyle
public void setContainerStyle(String containerStyle)
-
getContainerStyleClass
public String getContainerStyleClass()
- Specified by:
getContainerStyleClassin interfaceMenuItem
-
setContainerStyleClass
public void setContainerStyleClass(String containerStyleClass)
-
getClientId
public String getClientId()
- Specified by:
getClientIdin interfaceMenuItem
-
getTimeout
public int getTimeout()
- Specified by:
getTimeoutin interfaceAjaxSource
-
setTimeout
public void setTimeout(int timeout)
-
getPartialSubmitFilter
public String getPartialSubmitFilter()
- Specified by:
getPartialSubmitFilterin interfaceAjaxSource
-
setPartialSubmitFilter
public void setPartialSubmitFilter(String partialSubmitFilter)
-
getForm
public String getForm()
- Specified by:
getFormin interfaceAjaxSource
-
setForm
public void setForm(String form)
-
getConfirmationScript
public String getConfirmationScript()
- Specified by:
getConfirmationScriptin interfaceConfirmable
-
setConfirmationScript
public void setConfirmationScript(String confirmationScript)
- Specified by:
setConfirmationScriptin interfaceConfirmable
-
requiresConfirmation
public boolean requiresConfirmation()
- Specified by:
requiresConfirmationin interfaceConfirmable
-
setEscape
public void setEscape(boolean escape)
-
setRel
public void setRel(String rel)
-
isIgnoreComponentNotFound
public boolean isIgnoreComponentNotFound()
- Specified by:
isIgnoreComponentNotFoundin interfaceAjaxSource
-
setIgnoreComponentNotFound
public void setIgnoreComponentNotFound(boolean ignoreComponentNotFound)
-
builder
public static DefaultMenuItem.Builder builder()
-
-