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
-
Constructor Summary
Constructors Constructor Description UIMenuItemBase()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getContainerStyle()
String
getContainerStyleClass()
String
getDelay()
String
getFamily()
String
getForm()
String
getFragment()
SerializableFunction<MenuItem,String>
getFunction()
Lambda alternative to theMenuItem.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 configuredNavigationHandler
.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
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamily
in classjavax.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 tooutcome
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 aurl
which is notnull
causescommand
to be ignored.
-
setUrl
public void setUrl(String url)
-
setTarget
public void setTarget(String target)
-
setStyle
public void setStyle(String style)
-
getStyleClass
public String getStyleClass()
- Specified by:
getStyleClass
in interfaceMenuItem
-
setStyleClass
public void setStyleClass(String styleClass)
- Specified by:
setStyleClass
in interfaceMenuItem
-
getOnclick
public String getOnclick()
- Specified by:
getOnclick
in interfaceMenuItem
-
setOnclick
public void setOnclick(String onclick)
-
getUpdate
public String getUpdate()
- Specified by:
getUpdate
in interfaceAjaxSource
-
setUpdate
public void setUpdate(String update)
-
getProcess
public String getProcess()
- Specified by:
getProcess
in interfaceAjaxSource
-
setProcess
public void setProcess(String process)
-
getOnstart
public String getOnstart()
- Specified by:
getOnstart
in interfaceAjaxSource
-
setOnstart
public void setOnstart(String onstart)
-
isDisabled
public boolean isDisabled()
- Specified by:
isDisabled
in interfaceMenuItem
-
setDisabled
public void setDisabled(boolean disabled)
-
getOncomplete
public String getOncomplete()
- Specified by:
getOncomplete
in interfaceAjaxSource
-
setOncomplete
public void setOncomplete(String oncomplete)
-
getOnerror
public String getOnerror()
- Specified by:
getOnerror
in interfaceAjaxSource
-
setOnerror
public void setOnerror(String onerror)
-
getOnsuccess
public String getOnsuccess()
- Specified by:
getOnsuccess
in interfaceAjaxSource
-
setOnsuccess
public void setOnsuccess(String onsuccess)
-
isGlobal
public boolean isGlobal()
- Specified by:
isGlobal
in interfaceAjaxSource
-
setGlobal
public void setGlobal(boolean global)
-
getDelay
public String getDelay()
- Specified by:
getDelay
in interfaceAjaxSource
-
setDelay
public void setDelay(String delay)
-
getTimeout
public int getTimeout()
- Specified by:
getTimeout
in interfaceAjaxSource
-
setTimeout
public void setTimeout(int timeout)
-
isAsync
public boolean isAsync()
- Specified by:
isAsync
in interfaceAjaxSource
-
setAsync
public void setAsync(boolean async)
-
setAjax
public void setAjax(boolean ajax)
-
setIcon
public void setIcon(String icon)
-
getIconPos
public String getIconPos()
- Specified by:
getIconPos
in interfaceMenuItem
-
setIconPos
public void setIconPos(String iconPos)
-
isPartialSubmit
public boolean isPartialSubmit()
- Specified by:
isPartialSubmit
in interfaceAjaxSource
-
setPartialSubmit
public void setPartialSubmit(boolean partialSubmit)
-
isResetValues
public boolean isResetValues()
- Specified by:
isResetValues
in interfaceAjaxSource
-
setResetValues
public void setResetValues(boolean resetValues)
-
isIgnoreAutoUpdate
public boolean isIgnoreAutoUpdate()
- Specified by:
isIgnoreAutoUpdate
in interfaceAjaxSource
-
setIgnoreAutoUpdate
public void setIgnoreAutoUpdate(boolean ignoreAutoUpdate)
-
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 configuredNavigationHandler
. Similar tourl
, buturl
allows to specify fully qualified URLs.- Specified by:
getOutcome
in interfaceMenuItem
- Specified by:
getOutcome
in interfaceUIOutcomeTarget
- Returns:
- the outcome.
-
setOutcome
public void setOutcome(String outcome)
-
isIncludeViewParams
public boolean isIncludeViewParams()
- Specified by:
isIncludeViewParams
in interfaceMenuItem
- Specified by:
isIncludeViewParams
in interfaceUIOutcomeTarget
-
setIncludeViewParams
public void setIncludeViewParams(boolean includeViewParams)
-
getFragment
public String getFragment()
- Specified by:
getFragment
in interfaceMenuItem
- Specified by:
getFragment
in interfaceUIOutcomeTarget
-
setFragment
public void setFragment(String fragment)
-
isDisableClientWindow
public boolean isDisableClientWindow()
- Specified by:
isDisableClientWindow
in interfaceUIOutcomeTarget
-
setDisableClientWindow
public void setDisableClientWindow(boolean disableClientWindow)
-
getContainerStyle
public String getContainerStyle()
- Specified by:
getContainerStyle
in interfaceMenuItem
-
setContainerStyle
public void setContainerStyle(String containerStyle)
-
getContainerStyleClass
public String getContainerStyleClass()
- Specified by:
getContainerStyleClass
in interfaceMenuItem
-
setContainerStyleClass
public void setContainerStyleClass(String containerStyleClass)
-
getPartialSubmitFilter
public String getPartialSubmitFilter()
- Specified by:
getPartialSubmitFilter
in interfaceAjaxSource
-
setPartialSubmitFilter
public void setPartialSubmitFilter(String partialSubmitFilter)
-
getForm
public String getForm()
- Specified by:
getForm
in interfaceAjaxSource
-
setForm
public void setForm(String form)
-
setEscape
public void setEscape(boolean escape)
-
setRel
public void setRel(String rel)
-
getFunction
public SerializableFunction<MenuItem,String> getFunction()
Description copied from interface:MenuItem
Lambda alternative to theMenuItem.getCommand()
.- Specified by:
getFunction
in interfaceMenuItem
- Returns:
- The outcome, which will be used for navigation.
-
isIgnoreComponentNotFound
public boolean isIgnoreComponentNotFound()
- Specified by:
isIgnoreComponentNotFound
in interfaceAjaxSource
-
setIgnoreComponentNotFound
public void setIgnoreComponentNotFound(boolean ignoreComponentNotFound)
-
-