|
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.MenuBar
public class MenuBar
MenuBar is a JSF component class representing the ICEfaces menu bar.
The menuBar component provides a robust menu system that supports:
1. Nested child menuItem and menuItemSeparator components. Support for menuItemCheckbox and menuItemRadio components are planned for a future release.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_ORIENTATION
String contant default orientation |
static java.lang.String |
ID_PREFIX
String constant menu id prefix |
static java.lang.String |
ORIENTATION_HORIZONTAL
String contant horizontal orientation |
static java.lang.String |
ORIENTATION_VERTICAL
String constant vertical orientation |
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 | |
---|---|
MenuBar()
default no args constructor |
Method Summary | |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event)
|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
java.lang.String |
getComponentRootStyle()
|
java.lang.String |
getComponentType()
|
java.lang.String |
getFamily()
Return the value of the COMPONENT_FAMILY of this
component. |
java.lang.String |
getImageDir()
Return the value of the imageDir property. |
java.lang.String |
getItemImageStyleClass()
|
java.lang.String |
getItemLabelStyleClass()
|
java.lang.String |
getItemStyleClass()
|
java.lang.String |
getJsCall(javax.faces.context.FacesContext context)
|
java.lang.String |
getNoIcons()
Return the value of the noIcons property. |
java.lang.String |
getOrientation()
Return the value of the orientation property. |
java.lang.String |
getRenderedOnUserRole()
Return the value of the renderedOnUserRole property. |
java.lang.String |
getRendererType()
|
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 |
getSubMenuIndicatorStyleClass()
|
java.lang.String |
getSubMenuStyleClass()
|
boolean |
invokeOnComponent(javax.faces.context.FacesContext context,
java.lang.String clientId,
javax.faces.component.ContextCallback callback)
|
boolean |
isDisplayOnClick()
|
boolean |
isKeyboardNavigationEnabled()
|
boolean |
isRendered()
Return the value of the rendered property. |
boolean |
isScrollableDivMode()
|
void |
processDecodes(javax.faces.context.FacesContext context)
|
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 |
setDisplayOnClick(boolean displayOnClick)
|
void |
setImageDir(java.lang.String imageDir)
Set the value of the imageDir property. |
void |
setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)
|
void |
setNoIcons(java.lang.String b)
Set the value of the noIcons property. |
void |
setOrientation(java.lang.String orient)
Set the value of the orientation property. |
void |
setRenderedOnUserRole(java.lang.String renderedOnUserRole)
Set the value of the renderedOnUserRole property. |
void |
setScrollableDivMode(boolean scrollableDivMode)
|
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. |
Methods inherited from class javax.faces.component.UICommand |
---|
addActionListener, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, clearInitialState, decode, 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 ORIENTATION_VERTICAL
public static final java.lang.String ORIENTATION_HORIZONTAL
public static final java.lang.String DEFAULT_ORIENTATION
public static final java.lang.String ID_PREFIX
Constructor Detail |
---|
public MenuBar()
Method Detail |
---|
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 getComponentType()
public java.lang.String getRendererType()
getRendererType
in class javax.faces.component.UIComponentBase
public java.lang.String getNoIcons()
public void setNoIcons(java.lang.String b)
b
- 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.String getImageDir()
Return the value of the imageDir
property.
public void setImageDir(java.lang.String imageDir)
Set the value of the imageDir
property.
imageDir
- public java.lang.String getOrientation()
Return the value of the orientation
property.
public void setOrientation(java.lang.String orient)
Set the value of the orientation
property.
orient
- public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class javax.faces.component.UIComponentBase
public void queueEvent(javax.faces.event.FacesEvent e)
queueEvent
in class javax.faces.component.UICommand
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UICommand
javax.faces.event.AbortProcessingException
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 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 getItemStyleClass()
public java.lang.String getItemLabelStyleClass()
public java.lang.String getItemImageStyleClass()
public java.lang.String getSubMenuStyleClass()
public java.lang.String getSubMenuIndicatorStyleClass()
public java.lang.String getComponentRootStyle()
public void setDisplayOnClick(boolean displayOnClick)
public boolean isDisplayOnClick()
public void setScrollableDivMode(boolean scrollableDivMode)
public boolean isScrollableDivMode()
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
java.io.IOException
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
public boolean invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
invokeOnComponent
in class javax.faces.component.UIComponentBase
javax.faces.FacesException
public boolean isKeyboardNavigationEnabled()
public void setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)
public java.lang.String getJsCall(javax.faces.context.FacesContext context)
|
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 |