|
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.menu.MenuBase
public class MenuBase
Menu is a navigation component with various customized modes like multi tiers, overlay and nested menus.
For more information, see the Menu Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
MenuBase.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 | |
---|---|
MenuBase()
|
Method Summary | |
---|---|
java.lang.String |
getAt()
Return the value of the at property. |
java.lang.String |
getBackLabel()
Return the value of the backLabel 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()
|
int |
getMaxHeight()
Return the value of the maxHeight property. |
MenuModel |
getModel()
Return the value of the model property. |
java.lang.String |
getMy()
Return the value of the my property. |
java.lang.String |
getPosition()
Return the value of the position 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 |
getTrigger()
Return the value of the trigger property. |
java.lang.String |
getTriggerEvent()
Return the value of the triggerEvent property. |
java.lang.String |
getType()
Return the value of the type property. |
java.lang.String |
getWidgetVar()
Return the value of the widgetVar property. |
int |
getZindex()
Return the value of the zindex property. |
boolean |
isTiered()
Return the value of the tiered property. |
void |
setAt(java.lang.String at)
Set the value of the at property. |
void |
setBackLabel(java.lang.String backLabel)
Set the value of the backLabel 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 |
setMaxHeight(int maxHeight)
Set the value of the maxHeight property. |
void |
setModel(MenuModel model)
Set the value of the model property. |
void |
setMy(java.lang.String my)
Set the value of the my property. |
void |
setPosition(java.lang.String position)
Set the value of the position 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 |
setTiered(boolean tiered)
Set the value of the tiered property. |
void |
setTrigger(java.lang.String trigger)
Set the value of the trigger property. |
void |
setTriggerEvent(java.lang.String triggerEvent)
Set the value of the triggerEvent property. |
void |
setType(java.lang.String type)
Set the value of the type property. |
void |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
void |
setZindex(int zindex)
Set the value of the zindex 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 MenuBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void setAt(java.lang.String at)
Set the value of the at
property.
Contents: When position is dynamic, this attribute specifies the corner of trigger element to align with the menu. The format is "<left|right> <top|bottom>" (examples: "left top", "right bottom").
setAt
in interface IMenu
public java.lang.String getAt()
Return the value of the at
property.
Contents: When position is dynamic, this attribute specifies the corner of trigger element to align with the menu. The format is "<left|right> <top|bottom>" (examples: "left top", "right bottom"). Default = 'left bottom'.
getAt
in interface IMenu
public void setBackLabel(java.lang.String backLabel)
Set the value of the backLabel
property.
Contents: Label for the 'back' link (only applies to sliding menus).
setBackLabel
in interface IMenu
public java.lang.String getBackLabel()
Return the value of the backLabel
property.
Contents: Label for the 'back' link (only applies to sliding menus). Default = 'Back'.
getBackLabel
in interface IMenu
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 IMenu
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 IMenu
public void setEffectDuration(int effectDuration)
Set the value of the effectDuration
property.
Contents: Sets the effect duration in milliseconds.
setEffectDuration
in interface IMenu
public int getEffectDuration()
Return the value of the effectDuration
property.
Contents: Sets the effect duration in milliseconds. Default = '400'.
getEffectDuration
in interface IMenu
public void setMaxHeight(int maxHeight)
Set the value of the maxHeight
property.
Contents: Maximum height (in pixels) for the menu (only applies to sliding menus).
setMaxHeight
in interface IMenu
public int getMaxHeight()
Return the value of the maxHeight
property.
Contents: Maximum height (in pixels) for the menu (only applies to sliding menus). Default = '200'.
getMaxHeight
in interface IMenu
public void setModel(MenuModel model)
Set the value of the model
property.
Contents: org.icefaces.ace.model.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 IMenu
public MenuModel getModel()
Return the value of the model
property.
Contents: org.icefaces.ace.model.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 IMenu
getModel
in class AbstractMenu
public void setMy(java.lang.String my)
Set the value of the my
property.
Contents: When position is dynamic, this attribute specifies the corner of the menu to align with the trigger element. The format is "<left|right> <top|bottom>" (examples: "left top", "right bottom").
setMy
in interface IMenu
public java.lang.String getMy()
Return the value of the my
property.
Contents: When position is dynamic, this attribute specifies the corner of the menu to align with the trigger element. The format is "<left|right> <top|bottom>" (examples: "left top", "right bottom"). Default = 'left top'.
getMy
in interface IMenu
public void setPosition(java.lang.String position)
Set the value of the position
property.
Contents: Sets the way the menu is placed on the page. When "static", the menu is displayed in the normal flow. When set to "dynamic", the menu is only displayed near the trigger component when the triggerEvent occurs. For the latter case, it is required to specify a trigger component.
setPosition
in interface IMenu
public java.lang.String getPosition()
Return the value of the position
property.
Contents: Sets the way the menu is placed on the page. When "static", the menu is displayed in the normal flow. When set to "dynamic", the menu is only displayed near the trigger component when the triggerEvent occurs. For the latter case, it is required to specify a trigger component. Default = 'static'.
getPosition
in interface IMenu
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Style of the main container element.
setStyle
in interface IMenu
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Style of the main container element.
getStyle
in interface IMenu
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 IMenu
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class of the main container element.
getStyleClass
in interface IMenu
public void setTiered(boolean tiered)
Set the value of the tiered
property.
Contents: Sets the tiered mode, when set to true menu will be rendered in different tiers.
setTiered
in interface IMenu
public boolean isTiered()
Return the value of the tiered
property.
Contents: Sets the tiered mode, when set to true menu will be rendered in different tiers.
isTiered
in interface IMenu
public void setTrigger(java.lang.String trigger)
Set the value of the trigger
property.
Contents: Server-side id of the component that will trigger the dynamic menu when the triggerEvent occurs. Used when position is dynamic. It is also possible to specify a client-side id of a plain HTML element on the page.
setTrigger
in interface IMenu
public java.lang.String getTrigger()
Return the value of the trigger
property.
Contents: Server-side id of the component that will trigger the dynamic menu when the triggerEvent occurs. Used when position is dynamic. It is also possible to specify a client-side id of a plain HTML element on the page.
getTrigger
in interface IMenu
public void setTriggerEvent(java.lang.String triggerEvent)
Set the value of the triggerEvent
property.
Contents: Event that will trigger the menu to show, when position is dynamic. The possible values are "click", "mouseenter", "dblclick", and "rtclick".
setTriggerEvent
in interface IMenu
public java.lang.String getTriggerEvent()
Return the value of the triggerEvent
property.
Contents: Event that will trigger the menu to show, when position is dynamic. The possible values are "click", "mouseenter", "dblclick", and "rtclick". Default = 'click'.
getTriggerEvent
in interface IMenu
public void setType(java.lang.String type)
Set the value of the type
property.
Contents: Type of menu, valid values are "plain", "tiered" and "sliding".
setType
in interface IMenu
public java.lang.String getType()
Return the value of the type
property.
Contents: Type of menu, valid values are "plain", "tiered" and "sliding". Default = 'plain'.
getType
in interface IMenu
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 IMenu
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: Javascript variable name of the wrapped widget.
getWidgetVar
in interface IMenu
public void setZindex(int zindex)
Set the value of the zindex
property.
Contents: zindex property to control overlapping with other elements.
setZindex
in interface IMenu
public int getZindex()
Return the value of the zindex
property.
Contents: zindex property to control overlapping with other elements. Default = '1'.
getZindex
in interface IMenu
|
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 |