|
ICEfaces ACE 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
org.icefaces.ace.component.menu.AbstractMenu
org.icefaces.ace.component.menubar.MenuBarBase
public class MenuBarBase
Menubar is a horizontal navigation component.
For more information, see the MenuBar Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
MenuBarBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_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 | |
---|---|
MenuBarBase()
|
Method Summary | |
---|---|
java.lang.String |
getDirection()
Return the value of the direction property. |
java.lang.String |
getEffect()
Return the value of the effect property. |
int |
getEffectDuration()
Return the value of the effectDuration property. |
java.lang.String |
getFamily()
|
MenuModel |
getModel()
Return the value of the model property. |
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 |
getWidgetVar()
Return the value of the widgetVar property. |
boolean |
isAutoSubmenuDisplay()
Return the value of the autoSubmenuDisplay property. |
void |
setAutoSubmenuDisplay(boolean autoSubmenuDisplay)
Set the value of the autoSubmenuDisplay property. |
void |
setDirection(java.lang.String direction)
Set the value of the direction property. |
void |
setEffect(java.lang.String effect)
Set the value of the effect property. |
void |
setEffectDuration(int effectDuration)
Set the value of the effectDuration property. |
void |
setModel(MenuModel model)
Set the value of the model 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 |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
Methods inherited from class org.icefaces.ace.component.menu.AbstractMenu |
---|
buildMenuFromModel, isBuiltFromModel, isDynamic, markAsBuiltFromModel, processDecodes, setTransientRecursive, shouldBuildFromModel |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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, 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 COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public MenuBarBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void setAutoSubmenuDisplay(boolean autoSubmenuDisplay)
Set the value of the autoSubmenuDisplay
property.
Contents: When set to true, submenus are displayed on mouseover of a menuitem.
setAutoSubmenuDisplay
in interface IMenuBar
public boolean isAutoSubmenuDisplay()
Return the value of the autoSubmenuDisplay
property.
Contents: When set to true, submenus are displayed on mouseover of a menuitem.
isAutoSubmenuDisplay
in interface IMenuBar
public void setDirection(java.lang.String direction)
Set the value of the direction
property.
Contents: Forces the direction in which the submenus will be displayed, regardless of the position of the menu in the viewport. Possible values are combinations of "up", "down", and "middle" with "left", "right", and "center", separated by a space. The value "auto" can also be used in place of any of those values (e.g. "up", "up right", "left", "left auto", "center"). Note that the "center" value only applies to first-level submenus, while the "middle" value only applies to deeper-level submenus (i.e. all but first-level submenus).
setDirection
in interface IMenuBar
public java.lang.String getDirection()
Return the value of the direction
property.
Contents: Forces the direction in which the submenus will be displayed, regardless of the position of the menu in the viewport. Possible values are combinations of "up", "down", and "middle" with "left", "right", and "center", separated by a space. The value "auto" can also be used in place of any of those values (e.g. "up", "up right", "left", "left auto", "center"). Note that the "center" value only applies to first-level submenus, while the "middle" value only applies to deeper-level submenus (i.e. all but first-level submenus). Default = 'auto'.
getDirection
in interface IMenuBar
public void setEffect(java.lang.String effect)
Set the value of the effect
property.
Contents: Sets the effect for the menu display, default value is FADE. Possible values are "FADE", "SLIDE", "NONE". Use "NONE" to disable animation at all.
setEffect
in interface IMenuBar
public java.lang.String getEffect()
Return the value of the effect
property.
Contents: Sets the effect for the menu display, default value is FADE. Possible values are "FADE", "SLIDE", "NONE". Use "NONE" to disable animation at all. Default = 'fade'.
getEffect
in interface IMenuBar
public void setEffectDuration(int effectDuration)
Set the value of the effectDuration
property.
Contents: Sets the effect duration in milliseconds.
setEffectDuration
in interface IMenuBar
public int getEffectDuration()
Return the value of the effectDuration
property.
Contents: Sets the effect duration in milliseconds. Default = '400'.
getEffectDuration
in interface IMenuBar
public void setModel(MenuModel model)
Set the value of the model
property.
Contents: MenuModel instance to create menus programmatically. For the menuitem and submenu components, use explicit ids, and avoid long processing in the getter method for this property, as it will be called multiple times, in every lifecycle. If using MyFaces, see wiki page for some known issues.
setModel
in interface IMenuBar
public MenuModel getModel()
Return the value of the model
property.
Contents: MenuModel instance to create menus programmatically. For the menuitem and submenu components, use explicit ids, and avoid long processing in the getter method for this property, as it will be called multiple times, in every lifecycle. If using MyFaces, see wiki page for some known issues.
getModel
in interface IMenuBar
getModel
in class AbstractMenu
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Style of the main container element.
setStyle
in interface IMenuBar
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Style of the main container element.
getStyle
in interface IMenuBar
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Style class of the main container element.
setStyleClass
in interface IMenuBar
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class of the main container element.
getStyleClass
in interface IMenuBar
public void setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar
property.
Contents: Javascript variable name of the wrapped widget.
setWidgetVar
in interface IMenuBar
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: Javascript variable name of the wrapped widget.
getWidgetVar
in interface IMenuBar
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |