Package org.primefaces.model.menu
Interface MenuItem
-
- All Superinterfaces:
Confirmable
,MenuElement
- All Known Implementing Classes:
DefaultMenuItem
,UIMenuItem
,UIMenuItemBase
public interface MenuItem extends MenuElement, Confirmable
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getClientId()
String
getCommand()
AMethodExpression
in the form of a string which is called after the menu item has been clicked.String
getContainerStyle()
String
getContainerStyleClass()
String
getFragment()
SerializableFunction<MenuItem,String>
getFunction()
Lambda alternative to thegetCommand()
.String
getIcon()
String
getIconPos()
String
getOnclick()
String
getOutcome()
The JSF outcome of a navigation case which is resolved by the configuredNavigationHandler
.Map<String,List<String>>
getParams()
String
getRel()
String
getStyle()
String
getStyleClass()
String
getTarget()
String
getTitle()
String
getUrl()
The URL to redirect to after the menu item has been clicked.Object
getValue()
boolean
isAjax()
boolean
isDisabled()
boolean
isDynamic()
boolean
isEscape()
boolean
isImmediate()
boolean
isIncludeViewParams()
void
setParam(String key, Object value)
void
setStyleClass(String styleClass)
boolean
shouldRenderChildren()
-
Methods inherited from interface org.primefaces.component.api.Confirmable
getConfirmationScript, requiresConfirmation, setConfirmationScript
-
Methods inherited from interface org.primefaces.model.menu.MenuElement
getId, isRendered, setId
-
-
-
-
Method Detail
-
getIcon
String getIcon()
-
getIconPos
String getIconPos()
-
getTitle
String getTitle()
-
shouldRenderChildren
boolean shouldRenderChildren()
-
isDisabled
boolean isDisabled()
-
getOnclick
String getOnclick()
-
getStyle
String getStyle()
-
getStyleClass
String getStyleClass()
-
getUrl
String getUrl()
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.- Returns:
- the URL.
-
getTarget
String getTarget()
-
getOutcome
String getOutcome()
The JSF outcome of a navigation case which is resolved by the configuredNavigationHandler
. Similar tourl
, buturl
allows to specify fully qualified URLs.- Returns:
- the outcome.
-
getFragment
String getFragment()
-
isIncludeViewParams
boolean isIncludeViewParams()
-
isAjax
boolean isAjax()
-
getValue
Object getValue()
-
setStyleClass
void setStyleClass(String styleClass)
-
isDynamic
boolean isDynamic()
-
getCommand
String getCommand()
AMethodExpression
in the form of a string which is called after the menu item has been clicked. It is ignored whenurl
is notnull
.- Returns:
- The outcome, which will be used for navigation.
-
getFunction
SerializableFunction<MenuItem,String> getFunction()
Lambda alternative to thegetCommand()
.- Returns:
- The outcome, which will be used for navigation.
-
isImmediate
boolean isImmediate()
-
getClientId
String getClientId()
-
getContainerStyle
String getContainerStyle()
-
getContainerStyleClass
String getContainerStyleClass()
-
isEscape
boolean isEscape()
-
getRel
String getRel()
-
-