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 and Description
static class	DefaultMenuItem.Builder

Constructor Summary

Constructors

Constructor and Description
DefaultMenuItem() Creates a new menu item without value.
DefaultMenuItem(Object value) Deprecated. Use builder() instead.
DefaultMenuItem(Object value, String icon) Deprecated. Use builder() instead.
DefaultMenuItem(Object value, String icon, String url) Deprecated. Use builder() instead.

Method Summary

Modifier and Type	Method and Description
static DefaultMenuItem.Builder	builder()
List<javax.faces.component.UIComponent>	getChildren()
String	getClientId()
String	getCommand() A MethodExpression in the form of a string which is called after the menu item has been clicked.
String	getConfirmationScript()
String	getContainerStyle()
String	getContainerStyleClass()
String	getDelay()
String	getForm()
String	getFragment()
SerializableFunction<MenuItem,String>	getFunction() Lambda alternative to the MenuItem.getCommand().
String	getHref()
String	getIcon()
String	getIconPos()
String	getId() Allows access the id property which is managed and auto-assigned by callers like menu model implementations and used to identify the element.
String	getOnclick()
String	getOncomplete()
String	getOnerror()
String	getOnstart()
String	getOnsuccess()
String	getOutcome() The JSF outcome of a navigation case which is resolved by the configured NavigationHandler.
Map<String,List<String>>	getParams()
String	getPartialSubmitFilter()
String	getProcess()
String	getRel()
String	getStyle()
String	getStyleClass()
String	getTarget()
int	getTimeout()
String	getTitle()
String	getUpdate()
String	getUrl() The URL to redirect to after the menu item has been clicked.
Object	getValue()
boolean	isAjax()
boolean	isAjaxified()
boolean	isAsync()
boolean	isDisableClientWindow()
boolean	isDisabled()
boolean	isDynamic()
boolean	isEscape()
boolean	isGlobal()
boolean	isIgnoreAutoUpdate()
boolean	isImmediate()
boolean	isIncludeViewParams()
boolean	isPartialSubmit()
boolean	isPartialSubmitSet()
boolean	isRendered()
boolean	isResetValues()
boolean	isResetValuesSet()
boolean	requiresConfirmation()
void	setAjax(boolean ajax)
void	setAsync(boolean async)
void	setCommand(String command)
void	setConfirmationScript(String confirmationScript)
void	setContainerStyle(String containerStyle)
void	setContainerStyleClass(String containerStyleClass)
void	setDelay(String delay)
void	setDisableClientWindow(boolean disableClientWindow)
void	setDisabled(boolean disabled)
void	setEscape(boolean escape)
void	setForm(String form)
void	setFragment(String fragment)
void	setFunction(SerializableFunction<MenuItem,String> function)
void	setGlobal(boolean global)
void	setHref(String href)
void	setIcon(String icon)
void	setIconPos(String iconPos)
void	setId(String id) Sets the id property which is described in MenuElement.getId().
void	setIgnoreAutoUpdate(boolean ignoreAutoUpdate)
void	setImmediate(boolean immediate)
void	setIncludeViewParams(boolean includeViewParams)
void	setOnclick(String onclick)
void	setOncomplete(String oncomplete)
void	setOnerror(String onerror)
void	setOnstart(String onstart)
void	setOnsuccess(String onsuccess)
void	setOutcome(String outcome)
void	setParam(String key, Object value)
void	setParams(Map<String,List<String>> params)
void	setPartialSubmit(boolean partialSubmit)
void	setPartialSubmitFilter(String partialSubmitFilter)
void	setProcess(String process)
void	setRel(String rel)
void	setRendered(boolean rendered)
void	setResetValues(boolean resetValues)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setTarget(String target)
void	setTimeout(int timeout)
void	setTitle(String title)
void	setUpdate(String update)
void	setUrl(String url)
void	setValue(Object value)
boolean	shouldRenderChildren()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultMenuItem

public DefaultMenuItem()

Creates a new menu item without value.

DefaultMenuItem

@Deprecated
public DefaultMenuItem(Object value)

Deprecated. Use builder() instead.

Creates a new menu item with the specified

Parameters:

value - the value of the item used as label

DefaultMenuItem

@Deprecated
public DefaultMenuItem(Object value,
                                   String icon)

Deprecated. Use builder() instead.

Creates a new menu item with the specified

Parameters:

value - the value of the item used as label

icon - the icon to be displayed next to the label

DefaultMenuItem

public DefaultMenuItem(Object value,
                       String icon,
                       String url)

Deprecated. Use builder() instead.

Creates a menu item with the specified

Parameters:

value - the value of the item used as label

icon - the icon to be displayed next to the label

url - a URL to redirect to after the menu item has been clicked (specifying a url which is not null causes command to be ignored) (another form of redirection is provided by the outcome property)

Method Detail

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 UIOutcomeTarget

Specified by:

getOutcome in interface MenuItem

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 UIOutcomeTarget

Specified by:

isIncludeViewParams in interface MenuItem

setIncludeViewParams

public void setIncludeViewParams(boolean includeViewParams)

getFragment

public String getFragment()

Specified by:

getFragment in interface UIOutcomeTarget

Specified by:

getFragment in interface MenuItem

setFragment

public void setFragment(String fragment)

getParams

public Map<String,List<String>> getParams()

Specified by:

getParams in interface UIOutcomeTarget

Specified by:

getParams in interface MenuItem

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)

builder

public static DefaultMenuItem.Builder builder()