org.apache.myfaces.component.html.ext
Class HtmlSelectManyMenu

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by javax.faces.component.UISelectMany
                      extended by javax.faces.component.html.HtmlSelectManyMenu
                          extended by org.apache.myfaces.component.html.ext.AbstractHtmlSelectManyMenu
                              extended by org.apache.myfaces.component.html.ext.HtmlSelectManyMenu
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, DataProperties, DisplayValueOnlyAware, EscapeAware, ForceIdAware, UserRoleAware, DisplayValueOnlyCapable, EscapeCapable

public class HtmlSelectManyMenu
extends AbstractHtmlSelectManyMenu


Nested Class Summary
protected static class HtmlSelectManyMenu.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UISelectMany
INVALID_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable
DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR
 
Constructor Summary
HtmlSelectManyMenu()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAccesskey()
           
 String getDatafld()
          Reserved for future use.
 String getDataformatas()
          Reserved for future use.
 String getDatasrc()
          Reserved for future use.
 String getDir()
           
 Boolean getDisplayValueOnly()
          If true, renders only the value of the component, but no input widget.
 String getDisplayValueOnlyStyle()
          Style used when displayValueOnly is true.
 String getDisplayValueOnlyStyleClass()
          Style class used when displayValueOnly is true.
 String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 String getFamily()
           
 String getLabel()
           
 String getLang()
           
 String getOnblur()
           
 String getOnchange()
           
 String getOnclick()
           
 String getOndblclick()
           
 String getOnfocus()
           
 String getOnkeydown()
           
 String getOnkeypress()
           
 String getOnkeyup()
           
 String getOnmousedown()
           
 String getOnmousemove()
           
 String getOnmouseout()
           
 String getOnmouseover()
           
 String getOnmouseup()
           
 String getOnselect()
           
 String getStyle()
           
 String getStyleClass()
           
 String getTabindex()
           
 String getTitle()
           
 String getValueType()
          Specifies the value type of the selectable items.
 String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 boolean isDisabled()
           
 boolean isEscape()
          Indicates whether rendered markup should be escaped.
 boolean isForceId()
          If true, this component will force the use of the specified id when rendering.
 boolean isForceIdIndex()
          If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
 boolean isReadonly()
           
 void setAccesskey(String accesskey)
           
 void setDatafld(String datafld)
           
 void setDataformatas(String dataformatas)
           
 void setDatasrc(String datasrc)
           
 void setDir(String dir)
           
 void setDisabled(boolean disabled)
           
 void setDisplayValueOnly(Boolean displayValueOnly)
           
 void setDisplayValueOnlyStyle(String displayValueOnlyStyle)
           
 void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setEscape(boolean escape)
           
 void setForceId(boolean forceId)
           
 void setForceIdIndex(boolean forceIdIndex)
           
 void setLabel(String label)
           
 void setLang(String lang)
           
 void setOnblur(String onblur)
           
 void setOnchange(String onchange)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOnfocus(String onfocus)
           
 void setOnkeydown(String onkeydown)
           
 void setOnkeypress(String onkeypress)
           
 void setOnkeyup(String onkeyup)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setOnselect(String onselect)
           
 void setReadonly(boolean readonly)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTabindex(String tabindex)
           
 void setTitle(String title)
           
 void setValueBinding(String name, javax.faces.el.ValueBinding binding)
           
 void setValueExpression(String name, javax.el.ValueExpression expression)
           
 void setValueType(String valueType)
           
 void setVisibleOnUserRole(String visibleOnUserRole)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlSelectManyMenu
getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly
 
Methods inherited from class javax.faces.component.html.HtmlSelectManyMenu
getDefaultEventName, getDisabledClass, getEnabledClass, getEventNames, setDisabledClass, setEnabledClass
 
Methods inherited from class javax.faces.component.UISelectMany
compareValues, getConvertedValue, getSelectedValues, getValueBinding, getValueExpression, setSelectedValues, validate, validateValue
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, clearInitialState, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, initialStateMarked, invokeOnComponent, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
 

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlSelectManyMenu

public HtmlSelectManyMenu()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.html.HtmlSelectManyMenu

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class javax.faces.component.html.HtmlSelectManyMenu

getValueType

public String getValueType()
Description copied from class: AbstractHtmlSelectManyMenu
Specifies the value type of the selectable items. This attribute is similar to the collectionType attribute introduced in JSF 2.0. It can be used to declare the type of the selectable items when using a Collection to store the values in the managed bean, because it is not possible in Java to get the value type of a type-safe Collection (in contrast to arrays where this is possible).

Specified by:
getValueType in class AbstractHtmlSelectManyMenu

setValueType

public void setValueType(String valueType)

getDisplayValueOnly

public Boolean getDisplayValueOnly()
Description copied from interface: DisplayValueOnlyAware
If true, renders only the value of the component, but no input widget. Default is false.


setDisplayValueOnly

public void setDisplayValueOnly(Boolean displayValueOnly)

getDisplayValueOnlyStyle

public String getDisplayValueOnlyStyle()
Description copied from interface: DisplayValueOnlyAware
Style used when displayValueOnly is true.


setDisplayValueOnlyStyle

public void setDisplayValueOnlyStyle(String displayValueOnlyStyle)

getDisplayValueOnlyStyleClass

public String getDisplayValueOnlyStyleClass()
Description copied from interface: DisplayValueOnlyAware
Style class used when displayValueOnly is true.


setDisplayValueOnlyStyleClass

public void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)

getEnabledOnUserRole

public String getEnabledOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

isForceId

public boolean isForceId()
Description copied from interface: ForceIdAware
If true, this component will force the use of the specified id when rendering.

Returns:

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()
Description copied from interface: ForceIdAware
If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

isEscape

public boolean isEscape()
Description copied from interface: EscapeAware
Indicates whether rendered markup should be escaped. Default: true


setEscape

public void setEscape(boolean escape)

getDatafld

public String getDatafld()
Description copied from interface: DataProperties
Reserved for future use.


setDatafld

public void setDatafld(String datafld)

getDatasrc

public String getDatasrc()
Description copied from interface: DataProperties
Reserved for future use.


setDatasrc

public void setDatasrc(String datasrc)

getDataformatas

public String getDataformatas()
Description copied from interface: DataProperties
Reserved for future use.


setDataformatas

public void setDataformatas(String dataformatas)

getLabel

public String getLabel()
Overrides:
getLabel in class javax.faces.component.html.HtmlSelectManyMenu

setLabel

public void setLabel(String label)
Overrides:
setLabel in class javax.faces.component.html.HtmlSelectManyMenu

getStyle

public String getStyle()
Overrides:
getStyle in class javax.faces.component.html.HtmlSelectManyMenu

setStyle

public void setStyle(String style)
Overrides:
setStyle in class javax.faces.component.html.HtmlSelectManyMenu

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class javax.faces.component.html.HtmlSelectManyMenu

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class javax.faces.component.html.HtmlSelectManyMenu

getTabindex

public String getTabindex()
Overrides:
getTabindex in class javax.faces.component.html.HtmlSelectManyMenu

setTabindex

public void setTabindex(String tabindex)
Overrides:
setTabindex in class javax.faces.component.html.HtmlSelectManyMenu

getOnblur

public String getOnblur()
Overrides:
getOnblur in class javax.faces.component.html.HtmlSelectManyMenu

setOnblur

public void setOnblur(String onblur)
Overrides:
setOnblur in class javax.faces.component.html.HtmlSelectManyMenu

getOnfocus

public String getOnfocus()
Overrides:
getOnfocus in class javax.faces.component.html.HtmlSelectManyMenu

setOnfocus

public void setOnfocus(String onfocus)
Overrides:
setOnfocus in class javax.faces.component.html.HtmlSelectManyMenu

getAccesskey

public String getAccesskey()
Overrides:
getAccesskey in class javax.faces.component.html.HtmlSelectManyMenu

setAccesskey

public void setAccesskey(String accesskey)
Overrides:
setAccesskey in class javax.faces.component.html.HtmlSelectManyMenu

getOnclick

public String getOnclick()
Overrides:
getOnclick in class javax.faces.component.html.HtmlSelectManyMenu

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class javax.faces.component.html.HtmlSelectManyMenu

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class javax.faces.component.html.HtmlSelectManyMenu

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class javax.faces.component.html.HtmlSelectManyMenu

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class javax.faces.component.html.HtmlSelectManyMenu

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class javax.faces.component.html.HtmlSelectManyMenu

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class javax.faces.component.html.HtmlSelectManyMenu

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class javax.faces.component.html.HtmlSelectManyMenu

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class javax.faces.component.html.HtmlSelectManyMenu

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class javax.faces.component.html.HtmlSelectManyMenu

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class javax.faces.component.html.HtmlSelectManyMenu

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class javax.faces.component.html.HtmlSelectManyMenu

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class javax.faces.component.html.HtmlSelectManyMenu

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class javax.faces.component.html.HtmlSelectManyMenu

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class javax.faces.component.html.HtmlSelectManyMenu

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class javax.faces.component.html.HtmlSelectManyMenu

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class javax.faces.component.html.HtmlSelectManyMenu

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class javax.faces.component.html.HtmlSelectManyMenu

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class javax.faces.component.html.HtmlSelectManyMenu

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class javax.faces.component.html.HtmlSelectManyMenu

getOnchange

public String getOnchange()
Overrides:
getOnchange in class javax.faces.component.html.HtmlSelectManyMenu

setOnchange

public void setOnchange(String onchange)
Overrides:
setOnchange in class javax.faces.component.html.HtmlSelectManyMenu

getOnselect

public String getOnselect()
Overrides:
getOnselect in class javax.faces.component.html.HtmlSelectManyMenu

setOnselect

public void setOnselect(String onselect)
Overrides:
setOnselect in class javax.faces.component.html.HtmlSelectManyMenu

getDir

public String getDir()
Overrides:
getDir in class javax.faces.component.html.HtmlSelectManyMenu

setDir

public void setDir(String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlSelectManyMenu

getLang

public String getLang()
Overrides:
getLang in class javax.faces.component.html.HtmlSelectManyMenu

setLang

public void setLang(String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlSelectManyMenu

getTitle

public String getTitle()
Overrides:
getTitle in class javax.faces.component.html.HtmlSelectManyMenu

setTitle

public void setTitle(String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlSelectManyMenu

isDisabled

public boolean isDisabled()
Overrides:
isDisabled in class javax.faces.component.html.HtmlSelectManyMenu

setDisabled

public void setDisabled(boolean disabled)
Overrides:
setDisabled in class javax.faces.component.html.HtmlSelectManyMenu

isReadonly

public boolean isReadonly()
Overrides:
isReadonly in class javax.faces.component.html.HtmlSelectManyMenu

setReadonly

public void setReadonly(boolean readonly)
Overrides:
setReadonly in class javax.faces.component.html.HtmlSelectManyMenu

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class javax.faces.component.html.HtmlSelectManyMenu

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class javax.faces.component.html.HtmlSelectManyMenu


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.