Package org.primefaces.component.menuitem

Class UIMenuItemBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

org.primefaces.component.menuitem.UIMenuItemBase

All Implemented Interfaces:

EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AjaxSource, Confirmable, PrimeClientBehaviorHolder, UIOutcomeTarget, MenuElement, MenuItem

Direct Known Subclasses:

UIMenuItem

public abstract class UIMenuItemBase
extends javax.faces.component.UICommand
implements AjaxSource, UIOutcomeTarget, MenuItem, Confirmable, javax.faces.component.behavior.ClientBehaviorHolder, PrimeClientBehaviorHolder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UIMenuItemBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UICommand

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
UIMenuItemBase()

Method Summary

Modifier and Type	Method	Description
String	getContainerStyle()
String	getContainerStyleClass()
String	getDelay()
String	getFamily()
String	getForm()
String	getFragment()
SerializableFunction<MenuItem,String>	getFunction()	Lambda alternative to the MenuItem.getCommand().
String	getIcon()
String	getIconPos()
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.
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.
boolean	isAjax()
boolean	isAsync()
boolean	isDisableClientWindow()
boolean	isDisabled()
boolean	isEscape()
boolean	isGlobal()
boolean	isIgnoreAutoUpdate()
boolean	isIgnoreComponentNotFound()
boolean	isIncludeViewParams()
boolean	isPartialSubmit()
boolean	isResetValues()
void	setAjax(boolean ajax)
void	setAsync(boolean async)
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	setGlobal(boolean global)
void	setIcon(String icon)
void	setIconPos(String iconPos)
void	setIgnoreAutoUpdate(boolean ignoreAutoUpdate)
void	setIgnoreComponentNotFound(boolean ignoreComponentNotFound)
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	setPartialSubmit(boolean partialSubmit)
void	setPartialSubmitFilter(String partialSubmitFilter)
void	setProcess(String process)
void	setRel(String rel)
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)

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.primefaces.component.api.AjaxSource

isAjaxified, isPartialSubmitSet, isResetValuesSet

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

Methods inherited from interface org.primefaces.component.api.Confirmable

getConfirmationScript, requiresConfirmation, setConfirmationScript

Methods inherited from interface org.primefaces.model.menu.MenuElement

getId, isRendered, setId

Methods inherited from interface org.primefaces.model.menu.MenuItem

getClientId, getCommand, getParams, getValue, isDynamic, isImmediate, setParam, shouldRenderChildren

Methods inherited from interface org.primefaces.component.api.PrimeClientBehaviorHolder

getBehaviorEventMapping

Methods inherited from interface org.primefaces.component.api.UIOutcomeTarget

getChildren, getHref, getParams

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIMenuItemBase

public UIMenuItemBase()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

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)

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

getOnclick

public String getOnclick()

Specified by:

getOnclick in interface MenuItem

setOnclick

public void setOnclick(String onclick)

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)

getOnstart

public String getOnstart()

Specified by:

getOnstart in interface AjaxSource

setOnstart

public void setOnstart(String onstart)

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface MenuItem

setDisabled

public void setDisabled(boolean disabled)

getOncomplete

public String getOncomplete()

Specified by:

getOncomplete in interface AjaxSource

setOncomplete

public void setOncomplete(String oncomplete)

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)

isGlobal

public boolean isGlobal()

Specified by:

isGlobal in interface AjaxSource

setGlobal

public void setGlobal(boolean global)

getDelay

public String getDelay()

Specified by:

getDelay in interface AjaxSource

setDelay

public void setDelay(String delay)

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface AjaxSource

setTimeout

public void setTimeout(int timeout)

isAsync

public boolean isAsync()

Specified by:

isAsync in interface AjaxSource

setAsync

public void setAsync(boolean async)

isAjax

public boolean isAjax()

Specified by:

isAjax in interface MenuItem

setAjax

public void setAjax(boolean ajax)

getIcon

public String getIcon()

Specified by:

getIcon in interface MenuItem

setIcon

public void setIcon(String icon)

getIconPos

public String getIconPos()

Specified by:

getIconPos in interface MenuItem

setIconPos

public void setIconPos(String iconPos)

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)

isIgnoreAutoUpdate

public boolean isIgnoreAutoUpdate()

Specified by:

isIgnoreAutoUpdate in interface AjaxSource

setIgnoreAutoUpdate

public void setIgnoreAutoUpdate(boolean ignoreAutoUpdate)

getTitle

public String getTitle()

Specified by:

getTitle in interface MenuItem

setTitle

public void setTitle(String title)

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)

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)

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)

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)

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)

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.

isIgnoreComponentNotFound

public boolean isIgnoreComponentNotFound()

Specified by:

isIgnoreComponentNotFound in interface AjaxSource

setIgnoreComponentNotFound

public void setIgnoreComponentNotFound(boolean ignoreComponentNotFound)