|
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.menubutton.MenuButtonBase
public class MenuButtonBase
MenuButton displays different commands in a popup menu.
For more information, see the MenuButton Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
MenuButtonBase.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 | |
---|---|
MenuButtonBase()
|
Method Summary | |
---|---|
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 |
getValue()
Return the value of the value property. |
java.lang.String |
getWidgetVar()
Return the value of the widgetVar property. |
int |
getZindex()
Return the value of the zindex property. |
boolean |
isDisabled()
Return the value of the disabled property. |
void |
setDisabled(boolean disabled)
Set the value of the disabled 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 |
setValue(java.lang.String value)
Set the value of the value 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 MenuButtonBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void setDisabled(boolean disabled)
Set the value of the disabled
property.
Contents: Disables or enables the button.
setDisabled
in interface IMenuButton
public boolean isDisabled()
Return the value of the disabled
property.
Contents: Disables or enables the button.
isDisabled
in interface IMenuButton
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 IMenuButton
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 IMenuButton
public void setEffectDuration(int effectDuration)
Set the value of the effectDuration
property.
Contents: Sets the effect duration in milliseconds.
setEffectDuration
in interface IMenuButton
public int getEffectDuration()
Return the value of the effectDuration
property.
Contents: Sets the effect duration in milliseconds. Default = '400'.
getEffectDuration
in interface IMenuButton
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 IMenuButton
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 IMenuButton
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 IMenuButton
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Style of the main container element.
getStyle
in interface IMenuButton
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 IMenuButton
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class of the main container element.
getStyleClass
in interface IMenuButton
public void setValue(java.lang.String value)
Set the value of the value
property.
Contents: Label of the button.
setValue
in interface IMenuButton
public java.lang.String getValue()
Return the value of the value
property.
Contents: Label of the button.
getValue
in interface IMenuButton
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 IMenuButton
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: Javascript variable name of the wrapped widget.
getWidgetVar
in interface IMenuButton
public void setZindex(int zindex)
Set the value of the zindex
property.
Contents: zindex property to control overlapping with other elements.
setZindex
in interface IMenuButton
public int getZindex()
Return the value of the zindex
property.
Contents: zindex property to control overlapping with other elements. Default = '1'.
getZindex
in interface IMenuButton
|
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 |