|
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
com.icesoft.faces.component.menupopup.MenuPopup
public class MenuPopup
MenuPopup is a JSF component class representing the ICEfaces context menu popup.
The menuPopup component extends the menuBar, to provide a menu that is displayed when the user right-mouse clicks, or context-clicks, on another component, which knows to invoke the menuPopup because has specified to do so via its menuPopup attribute, which references the menuPopup's id.
The menuPopup behaves, as is defined, the same as menuBar, except for some minor differences:
1. menuPopup does not have a visible attribute, because that would interfere with the mechanism for dynamically displaying the popup menu 2. menuPopup does not have an orientation attribute, because it is always shown vertically 3. menuPopup's default style class is iceMnuPop, instead of menuBar's iceMnuBar
Field Summary |
---|
Fields inherited from class com.icesoft.faces.component.menubar.MenuBar |
---|
DEFAULT_ORIENTATION, ID_PREFIX, ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL |
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 | |
---|---|
MenuPopup()
default no args constructor |
Method Summary | |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event)
|
java.lang.String |
getComponentRootStyle()
|
java.lang.String |
getComponentType()
|
javax.faces.el.MethodBinding |
getDisplayListener()
Return the value of the displayListener property. |
java.lang.String |
getFamily()
Return the value of the COMPONENT_FAMILY of this
component. |
java.lang.String |
getHideOn()
Return the value of the hideOn property. |
java.lang.String |
getOrientation()
Orientation is fixed to vertical |
java.lang.String |
getRendererType()
|
java.lang.String |
getTopSubMenuStyleClass()
|
boolean |
isBlockMenuOnInput()
|
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 |
setBlockMenuOnInput(boolean blockMenuOnInput)
|
void |
setDisplayListener(javax.faces.el.MethodBinding displayListener)
Set the value of the displayListener property. |
void |
setHideOn(java.lang.String hideOn)
Set the value of the hideOn property. |
void |
setOrientation(java.lang.String orient)
Orientation is fixed to vertical |
Methods inherited from class com.icesoft.faces.component.menubar.MenuBar |
---|
encodeBegin, getImageDir, getItemImageStyleClass, getItemLabelStyleClass, getItemStyleClass, getJsCall, getNoIcons, getRenderedOnUserRole, getStyle, getStyleClass, getSubMenuIndicatorStyleClass, getSubMenuStyleClass, invokeOnComponent, isDisplayOnClick, isKeyboardNavigationEnabled, isRendered, isScrollableDivMode, processDecodes, setDisplayOnClick, setImageDir, setKeyboardNavigationEnabled, setNoIcons, setRenderedOnUserRole, setScrollableDivMode, setStyle, setStyleClass |
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 |
Constructor Detail |
---|
public MenuPopup()
Method Detail |
---|
public java.lang.String getFamily()
Return the value of the COMPONENT_FAMILY
of this
component.
getFamily
in class MenuBar
public java.lang.String getComponentType()
getComponentType
in class MenuBar
public java.lang.String getRendererType()
getRendererType
in class MenuBar
public java.lang.String getOrientation()
Orientation is fixed to vertical
getOrientation
in class MenuBar
public void setOrientation(java.lang.String orient)
Orientation is fixed to vertical
setOrientation
in class MenuBar
orient
- public java.lang.String getTopSubMenuStyleClass()
public java.lang.String getComponentRootStyle()
getComponentRootStyle
in class MenuBar
public void queueEvent(javax.faces.event.FacesEvent e)
queueEvent
in class MenuBar
public void setHideOn(java.lang.String hideOn)
Set the value of the hideOn
property.
hideOn
- public java.lang.String getHideOn()
Return the value of the hideOn
property.
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class MenuBar
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class MenuBar
public javax.faces.el.MethodBinding getDisplayListener()
Return the value of the displayListener
property.
public void setDisplayListener(javax.faces.el.MethodBinding displayListener)
Set the value of the displayListener
property.
public boolean isBlockMenuOnInput()
public void setBlockMenuOnInput(boolean blockMenuOnInput)
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class MenuBar
javax.faces.event.AbortProcessingException
|
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 |