|
ICEfaces ICE Components 3.3.0 Java API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
com.icesoft.faces.component.menubar.MenuItemBase
com.icesoft.faces.component.menubar.MenuItem
public class MenuItem
MenuItem is a JSF component class that represent an ICEfaces menuItem.
MenuItem components are the menu items contained by a menuBar. The action and actionListener attributes operate in the same way as the standard component attributes of the same name. The MenuItem component is only used in the static approach to defining the heirarchy of menu items.
This component extends the ICEfaces MenuItemBase component. By default the MenuItem is rendered by the "com.icesoft.faces.View" renderer type.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_ICON
String constant defining default menu icon img |
Fields inherited from class com.icesoft.faces.component.menubar.MenuItemBase |
---|
DEFAULT_CSS_IMAGE_DIR |
Fields inherited from class javax.faces.component.UICommand |
---|
COMPONENT_FAMILY, 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 |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
MenuItem()
|
Method Summary | |
---|---|
javax.faces.el.MethodBinding |
getAction()
Return the value of the action property. |
javax.faces.el.MethodBinding |
getActionListener()
Return the value of the actionListener property. |
java.lang.String |
getAlt()
Return the value of the alt property. |
java.lang.String |
getComponentType()
|
boolean |
getDisabled()
|
java.lang.String |
getEnabledOnUserRole()
Return the value of the enabledOnUserRole property. |
java.lang.String |
getFamily()
Return the value of the COMPONENT_FAMILY of this
component. |
java.lang.String |
getIcon()
Return the value of the icon property. |
java.lang.String |
getImageStyleClass()
|
java.lang.String |
getLabelStyleClass()
|
java.lang.String |
getLink()
Return the value of the link property. |
java.lang.String |
getOnclick()
Return the value of the onclick property. |
java.lang.String |
getRenderedOnUserRole()
Return the value of the renderedOnUserRole property. |
java.lang.String |
getRendererType()
|
java.lang.String |
getSpecifiedIcon()
|
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
java.lang.String |
getTarget()
Return the value of the target property. |
java.lang.String |
getTitle()
Return the value of the renderedOnUserRole property. |
java.lang.Object |
getValue()
Return the value of the value property. |
boolean |
hasActionOrActionListener()
|
boolean |
isDisabled()
Return the value of the disabled property. |
boolean |
isLinkSpecified()
|
boolean |
isRendered()
Return the value of the rendered property. |
void |
queueEvent(javax.faces.event.FacesEvent e)
|
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setAction(javax.faces.el.MethodBinding action)
Set the value of the action property. |
void |
setActionListener(javax.faces.el.MethodBinding actionListener)
Set the value of the actionListener property. |
void |
setAlt(java.lang.String alt)
Set the value of the alt property. |
void |
setDisabled(boolean disabled)
Set the value of the disabled property. |
void |
setEnabledOnUserRole(java.lang.String enabledOnUserRole)
Set the value of the enabledOnUserRole property. |
void |
setIcon(java.lang.String iconValue)
Set the value of the icon property. |
void |
setLink(java.lang.String linkValue)
Set the value of the link property. |
void |
setOnclick(java.lang.String onclick)
Set the value of the onclick property. |
void |
setRenderedOnUserRole(java.lang.String renderedOnUserRole)
Set the value of the renderedOnUserRole property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setTarget(java.lang.String target)
Set the value of the target property. |
void |
setTitle(java.lang.String title)
Set the value of the title property. |
void |
setValue(java.lang.Object value)
Set the value of the value property. |
Methods inherited from class com.icesoft.faces.component.menubar.MenuItemBase |
---|
broadcast, invokeOnComponent, processDecodes |
Methods inherited from class javax.faces.component.UICommand |
---|
addActionListener, getActionExpression, getActionListeners, isImmediate, removeActionListener, setActionExpression, setImmediate |
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, getRenderer, getRendersChildren, getValueBinding, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, 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 |
Field Detail |
---|
public static final java.lang.String DEFAULT_ICON
Constructor Detail |
---|
public MenuItem()
Method Detail |
---|
public java.lang.String getRendererType()
getRendererType
in class javax.faces.component.UIComponentBase
public java.lang.String getComponentType()
public java.lang.String getFamily()
Return the value of the COMPONENT_FAMILY
of this
component.
getFamily
in class javax.faces.component.UICommand
public java.lang.String getIcon()
Return the value of the icon
property.
public java.lang.String getSpecifiedIcon()
public void setIcon(java.lang.String iconValue)
Set the value of the icon
property.
public java.lang.Object getValue()
Return the value of the value
property.
getValue
in class javax.faces.component.UICommand
public void setValue(java.lang.Object value)
Set the value of the value
property.
setValue
in class javax.faces.component.UICommand
public boolean isLinkSpecified()
public java.lang.String getLink()
Return the value of the link
property.
public void setLink(java.lang.String linkValue)
Set the value of the link
property.
public java.lang.String getTarget()
Return the value of the target
property.
public void setTarget(java.lang.String target)
Set the value of the target
property.
public javax.faces.el.MethodBinding getAction()
Return the value of the action
property.
getAction
in interface javax.faces.component.ActionSource
getAction
in class javax.faces.component.UICommand
public void setAction(javax.faces.el.MethodBinding action)
Set the value of the action
property.
setAction
in interface javax.faces.component.ActionSource
setAction
in class javax.faces.component.UICommand
public javax.faces.el.MethodBinding getActionListener()
Return the value of the actionListener
property.
getActionListener
in interface javax.faces.component.ActionSource
getActionListener
in class javax.faces.component.UICommand
public void setActionListener(javax.faces.el.MethodBinding actionListener)
Set the value of the actionListener
property.
setActionListener
in interface javax.faces.component.ActionSource
setActionListener
in class javax.faces.component.UICommand
public boolean hasActionOrActionListener()
public void queueEvent(javax.faces.event.FacesEvent e)
queueEvent
in class MenuItemBase
public void setDisabled(boolean disabled)
Set the value of the disabled
property.
public boolean getDisabled()
public boolean isDisabled()
Return the value of the disabled
property.
public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
Set the value of the enabledOnUserRole
property.
enabledOnUserRole
- public java.lang.String getEnabledOnUserRole()
Return the value of the enabledOnUserRole
property.
public void setRenderedOnUserRole(java.lang.String renderedOnUserRole)
Set the value of the renderedOnUserRole
property.
renderedOnUserRole
- public java.lang.String getRenderedOnUserRole()
Return the value of the renderedOnUserRole
property.
public void setTitle(java.lang.String title)
Set the value of the title
property.
title
- public java.lang.String getTitle()
Return the value of the renderedOnUserRole
property.
public void setAlt(java.lang.String alt)
Set the value of the alt
property.
alt
- public java.lang.String getAlt()
Return the value of the alt
property.
public boolean isRendered()
Return the value of the rendered
property.
isRendered
in class javax.faces.component.UIComponentBase
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
styleClass
- public java.lang.String getStyleClass()
Return the value of the styleClass
property.
public java.lang.String getLabelStyleClass()
public java.lang.String getImageStyleClass()
public void setOnclick(java.lang.String onclick)
Set the value of the onclick
property.
onclick
- public java.lang.String getOnclick()
Return the value of the onclick
property.
public void setStyle(java.lang.String style)
Set the value of the style
property.
style
- public java.lang.String getStyle()
Return the value of the style
property.
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
|
ICEfaces ICE Components 3.3.0 Java API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |