org.richfaces.component.html
Class ContextMenu

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.richfaces.component.UIContextMenu
              extended by org.richfaces.component.html.ContextMenu
All Implemented Interfaces:
javax.faces.component.StateHolder, MenuComponent

public class ContextMenu
extends UIContextMenu

Component-Type org.richfaces.ContextMenu Component-Family org.richfaces.ContextMenu Renderer-Type org.richfaces.DropDownMenuRenderer


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from interface org.richfaces.component.MenuComponent
MODE_AJAX, MODE_NONE, MODE_SERVER
 
Constructor Summary
ContextMenu()
          Constructor to init default renderers
 
Method Summary
 java.lang.String getDisabledItemClass()
          Space-separated list of CSS style class(es) that are be applied to disabled item of this component Getter for disabledItemClass
 java.lang.String getDisabledItemStyle()
          CSS style(s) is/are to be applied to disabled item when this component is rendered.
 java.lang.String getEvent()
          Defines an event on the parent element that triggers the menu's appearance Getter for event
 java.lang.String getFamily()
           
 java.lang.Integer getHideDelay()
          Delay between losing focus and menu closing.
 java.lang.String getItemClass()
          Space-separated list of CSS style class(es) that are be applied to item of this component Getter for itemClass
 java.lang.String getItemStyle()
          CSS style(s) is/are to be applied to item when this component is rendered.
 java.lang.String getOncollapse()
          Event must occurs on menu closure Getter for oncollapse
 java.lang.String getOnexpand()
          Event must occurs on menu opening Getter for onexpand
 java.lang.String getOngroupactivate()
          HTML: script expression; some group was activated Getter for ongroupactivate
 java.lang.String getOnitemselect()
          HTML: script expression; some item was selected Getter for onitemselect
 java.lang.String getOnmousemove()
          HTML: script expression; a pointer was moved within Getter for onmousemove
 java.lang.String getOnmouseout()
          HTML: script expression; a pointer was moved away Getter for onmouseout
 java.lang.String getOnmouseover()
          HTML: script expression; a pointer was moved onto Getter for onmouseover
 java.lang.String getPopupWidth()
          Set minimal width for the all of the lists that will appear Getter for popupWidth
 java.lang.String getSelectItemClass()
          Space-separated list of CSS style class(es) that are be applied to selected item of this component.
 java.lang.String getSelectItemStyle()
          CSS style(s) is/are to be applied to selected item when this component is rendered.
 java.lang.Integer getShowDelay()
          Delay between event and menu showing.
 java.lang.String getStyle()
          CSS style(s) is/are to be applied when this component is rendered Getter for style
 java.lang.String getStyleClass()
          Corresponds to the HTML class attribute Getter for styleClass
 java.lang.String getSubmitMode()
          Set the submission mode for all menu items of the menu except ones where this attribute redefined (ajax, server(Default), none) Getter for submitMode
 boolean isAttached()
          If the value of the "attached" attribute is true, component is attached to parent component Getter for attached
 boolean isDisableDefaultMenu()
          Forbids default handling for adjusted event Getter for disableDefaultMenu
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setAttached(boolean __attached)
          If the value of the "attached" attribute is true, component is attached to parent component Setter for attached
 void setDisableDefaultMenu(boolean __disableDefaultMenu)
          Forbids default handling for adjusted event Setter for disableDefaultMenu
 void setDisabledItemClass(java.lang.String __disabledItemClass)
          Space-separated list of CSS style class(es) that are be applied to disabled item of this component Setter for disabledItemClass
 void setDisabledItemStyle(java.lang.String __disabledItemStyle)
          CSS style(s) is/are to be applied to disabled item when this component is rendered.
 void setEvent(java.lang.String __event)
          Defines an event on the parent element that triggers the menu's appearance Setter for event
 void setHideDelay(java.lang.Integer __hideDelay)
          Delay between losing focus and menu closing.
 void setItemClass(java.lang.String __itemClass)
          Space-separated list of CSS style class(es) that are be applied to item of this component Setter for itemClass
 void setItemStyle(java.lang.String __itemStyle)
          CSS style(s) is/are to be applied to item when this component is rendered.
 void setOncollapse(java.lang.String __oncollapse)
          Event must occurs on menu closure Setter for oncollapse
 void setOnexpand(java.lang.String __onexpand)
          Event must occurs on menu opening Setter for onexpand
 void setOngroupactivate(java.lang.String __ongroupactivate)
          HTML: script expression; some group was activated Setter for ongroupactivate
 void setOnitemselect(java.lang.String __onitemselect)
          HTML: script expression; some item was selected Setter for onitemselect
 void setOnmousemove(java.lang.String __onmousemove)
          HTML: script expression; a pointer was moved within Setter for onmousemove
 void setOnmouseout(java.lang.String __onmouseout)
          HTML: script expression; a pointer was moved away Setter for onmouseout
 void setOnmouseover(java.lang.String __onmouseover)
          HTML: script expression; a pointer was moved onto Setter for onmouseover
 void setPopupWidth(java.lang.String __popupWidth)
          Set minimal width for the all of the lists that will appear Setter for popupWidth
 void setSelectItemClass(java.lang.String __selectItemClass)
          Space-separated list of CSS style class(es) that are be applied to selected item of this component.
 void setSelectItemStyle(java.lang.String __selectItemStyle)
          CSS style(s) is/are to be applied to selected item when this component is rendered.
 void setShowDelay(java.lang.Integer __showDelay)
          Delay between event and menu showing.
 void setStyle(java.lang.String __style)
          CSS style(s) is/are to be applied when this component is rendered Setter for style
 void setStyleClass(java.lang.String __styleClass)
          Corresponds to the HTML class attribute Setter for styleClass
 void setSubmitMode(java.lang.String __submitMode)
          Set the submission mode for all menu items of the menu except ones where this attribute redefined (ajax, server(Default), none) Setter for submitMode
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

ContextMenu

public ContextMenu()
Constructor to init default renderers

Method Detail

setAttached

public void setAttached(boolean __attached)
If the value of the "attached" attribute is true, component is attached to parent component Setter for attached

Specified by:
setAttached in class UIContextMenu
Parameters:
attached - - new value

isAttached

public boolean isAttached()
If the value of the "attached" attribute is true, component is attached to parent component Getter for attached

Specified by:
isAttached in class UIContextMenu
Returns:
attached value from local variable or value bindings

setDisableDefaultMenu

public void setDisableDefaultMenu(boolean __disableDefaultMenu)
Forbids default handling for adjusted event Setter for disableDefaultMenu

Specified by:
setDisableDefaultMenu in class UIContextMenu
Parameters:
disableDefaultMenu - - new value

isDisableDefaultMenu

public boolean isDisableDefaultMenu()
Forbids default handling for adjusted event Getter for disableDefaultMenu

Specified by:
isDisableDefaultMenu in class UIContextMenu
Returns:
disableDefaultMenu value from local variable or value bindings

setDisabledItemClass

public void setDisabledItemClass(java.lang.String __disabledItemClass)
Space-separated list of CSS style class(es) that are be applied to disabled item of this component Setter for disabledItemClass

Parameters:
disabledItemClass - - new value

getDisabledItemClass

public java.lang.String getDisabledItemClass()
Space-separated list of CSS style class(es) that are be applied to disabled item of this component Getter for disabledItemClass

Returns:
disabledItemClass value from local variable or value bindings

setDisabledItemStyle

public void setDisabledItemStyle(java.lang.String __disabledItemStyle)
CSS style(s) is/are to be applied to disabled item when this component is rendered. Setter for disabledItemStyle

Parameters:
disabledItemStyle - - new value

getDisabledItemStyle

public java.lang.String getDisabledItemStyle()
CSS style(s) is/are to be applied to disabled item when this component is rendered. Getter for disabledItemStyle

Returns:
disabledItemStyle value from local variable or value bindings

setEvent

public void setEvent(java.lang.String __event)
Defines an event on the parent element that triggers the menu's appearance Setter for event

Specified by:
setEvent in class UIContextMenu
Parameters:
event - - new value

getEvent

public java.lang.String getEvent()
Defines an event on the parent element that triggers the menu's appearance Getter for event

Specified by:
getEvent in class UIContextMenu
Returns:
event value from local variable or value bindings

setHideDelay

public void setHideDelay(java.lang.Integer __hideDelay)
Delay between losing focus and menu closing. Setter for hideDelay

Parameters:
hideDelay - - new value

getHideDelay

public java.lang.Integer getHideDelay()
Delay between losing focus and menu closing. Getter for hideDelay

Returns:
hideDelay value from local variable or value bindings

setItemClass

public void setItemClass(java.lang.String __itemClass)
Space-separated list of CSS style class(es) that are be applied to item of this component Setter for itemClass

Parameters:
itemClass - - new value

getItemClass

public java.lang.String getItemClass()
Space-separated list of CSS style class(es) that are be applied to item of this component Getter for itemClass

Returns:
itemClass value from local variable or value bindings

setItemStyle

public void setItemStyle(java.lang.String __itemStyle)
CSS style(s) is/are to be applied to item when this component is rendered. Setter for itemStyle

Parameters:
itemStyle - - new value

getItemStyle

public java.lang.String getItemStyle()
CSS style(s) is/are to be applied to item when this component is rendered. Getter for itemStyle

Returns:
itemStyle value from local variable or value bindings

setOncollapse

public void setOncollapse(java.lang.String __oncollapse)
Event must occurs on menu closure Setter for oncollapse

Parameters:
oncollapse - - new value

getOncollapse

public java.lang.String getOncollapse()
Event must occurs on menu closure Getter for oncollapse

Returns:
oncollapse value from local variable or value bindings

setOnexpand

public void setOnexpand(java.lang.String __onexpand)
Event must occurs on menu opening Setter for onexpand

Parameters:
onexpand - - new value

getOnexpand

public java.lang.String getOnexpand()
Event must occurs on menu opening Getter for onexpand

Returns:
onexpand value from local variable or value bindings

setOngroupactivate

public void setOngroupactivate(java.lang.String __ongroupactivate)
HTML: script expression; some group was activated Setter for ongroupactivate

Parameters:
ongroupactivate - - new value

getOngroupactivate

public java.lang.String getOngroupactivate()
HTML: script expression; some group was activated Getter for ongroupactivate

Returns:
ongroupactivate value from local variable or value bindings

setOnitemselect

public void setOnitemselect(java.lang.String __onitemselect)
HTML: script expression; some item was selected Setter for onitemselect

Parameters:
onitemselect - - new value

getOnitemselect

public java.lang.String getOnitemselect()
HTML: script expression; some item was selected Getter for onitemselect

Returns:
onitemselect value from local variable or value bindings

setOnmousemove

public void setOnmousemove(java.lang.String __onmousemove)
HTML: script expression; a pointer was moved within Setter for onmousemove

Parameters:
onmousemove - - new value

getOnmousemove

public java.lang.String getOnmousemove()
HTML: script expression; a pointer was moved within Getter for onmousemove

Returns:
onmousemove value from local variable or value bindings

setOnmouseout

public void setOnmouseout(java.lang.String __onmouseout)
HTML: script expression; a pointer was moved away Setter for onmouseout

Parameters:
onmouseout - - new value

getOnmouseout

public java.lang.String getOnmouseout()
HTML: script expression; a pointer was moved away Getter for onmouseout

Returns:
onmouseout value from local variable or value bindings

setOnmouseover

public void setOnmouseover(java.lang.String __onmouseover)
HTML: script expression; a pointer was moved onto Setter for onmouseover

Parameters:
onmouseover - - new value

getOnmouseover

public java.lang.String getOnmouseover()
HTML: script expression; a pointer was moved onto Getter for onmouseover

Returns:
onmouseover value from local variable or value bindings

setPopupWidth

public void setPopupWidth(java.lang.String __popupWidth)
Set minimal width for the all of the lists that will appear Setter for popupWidth

Parameters:
popupWidth - - new value

getPopupWidth

public java.lang.String getPopupWidth()
Set minimal width for the all of the lists that will appear Getter for popupWidth

Returns:
popupWidth value from local variable or value bindings

setSelectItemClass

public void setSelectItemClass(java.lang.String __selectItemClass)
Space-separated list of CSS style class(es) that are be applied to selected item of this component. Setter for selectItemClass

Parameters:
selectItemClass - - new value

getSelectItemClass

public java.lang.String getSelectItemClass()
Space-separated list of CSS style class(es) that are be applied to selected item of this component. Getter for selectItemClass

Returns:
selectItemClass value from local variable or value bindings

setSelectItemStyle

public void setSelectItemStyle(java.lang.String __selectItemStyle)
CSS style(s) is/are to be applied to selected item when this component is rendered. Setter for selectItemStyle

Parameters:
selectItemStyle - - new value

getSelectItemStyle

public java.lang.String getSelectItemStyle()
CSS style(s) is/are to be applied to selected item when this component is rendered. Getter for selectItemStyle

Returns:
selectItemStyle value from local variable or value bindings

setShowDelay

public void setShowDelay(java.lang.Integer __showDelay)
Delay between event and menu showing. Setter for showDelay

Specified by:
setShowDelay in class UIContextMenu
Parameters:
showDelay - - new value

getShowDelay

public java.lang.Integer getShowDelay()
Delay between event and menu showing. Getter for showDelay

Specified by:
getShowDelay in class UIContextMenu
Returns:
showDelay value from local variable or value bindings

setStyle

public void setStyle(java.lang.String __style)
CSS style(s) is/are to be applied when this component is rendered Setter for style

Parameters:
style - - new value

getStyle

public java.lang.String getStyle()
CSS style(s) is/are to be applied when this component is rendered Getter for style

Returns:
style value from local variable or value bindings

setStyleClass

public void setStyleClass(java.lang.String __styleClass)
Corresponds to the HTML class attribute Setter for styleClass

Parameters:
styleClass - - new value

getStyleClass

public java.lang.String getStyleClass()
Corresponds to the HTML class attribute Getter for styleClass

Returns:
styleClass value from local variable or value bindings

setSubmitMode

public void setSubmitMode(java.lang.String __submitMode)
Set the submission mode for all menu items of the menu except ones where this attribute redefined (ajax, server(Default), none) Setter for submitMode

Parameters:
submitMode - - new value

getSubmitMode

public java.lang.String getSubmitMode()
Set the submission mode for all menu items of the menu except ones where this attribute redefined (ajax, server(Default), none) Getter for submitMode

Returns:
submitMode value from local variable or value bindings

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase


Copyright © 2008. All Rights Reserved.