org.apache.myfaces.custom.picklist
Class HtmlSelectManyPicklist

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.HtmlSelectManyListbox
                          extended by org.apache.myfaces.component.html.ext.AbstractHtmlSelectManyListbox
                              extended by org.apache.myfaces.component.html.ext.HtmlSelectManyListbox
                                  extended by org.apache.myfaces.custom.picklist.AbstractHtmlSelectManyPicklist
                                      extended by org.apache.myfaces.custom.picklist.HtmlSelectManyPicklist
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, 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 HtmlSelectManyPicklist
extends AbstractHtmlSelectManyPicklist


Nested Class Summary
protected static class HtmlSelectManyPicklist.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
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 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
HtmlSelectManyPicklist()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getAccesskey()
           
 String getAddAllButtonStyle()
          CSS style to be applied to the add all button
 String getAddAllButtonStyleClass()
          CSS styleClass to be applied to the add all button
 String getAddAllButtonText()
          Define the text that goes inside the add all button
 String getAddButtonStyle()
          CSS style to be applied to the add button
 String getAddButtonStyleClass()
          CSS styleClass to be applied to the add button
 String getAddButtonText()
          Define the text that goes inside the add button
 String getDir()
           
 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 getRemoveAllButtonStyle()
          CSS style to be applied to the remove all button
 String getRemoveAllButtonStyleClass()
          CSS styleClass to be applied to the remove all button
 String getRemoveAllButtonText()
          Define the text that goes inside the remove all button
 String getRemoveButtonStyle()
          CSS style to be applied to the remove button
 String getRemoveButtonStyleClass()
          CSS styleClass to be applied to the remove button
 String getRemoveButtonText()
          Define the text that goes inside the remove button
 int getSize()
           
 String getStyle()
           
 String getStyleClass()
           
 String getTabindex()
           
 String getTitle()
           
 String getValueType()
          Specifies the value type of the selectable items.
 boolean isDisabled()
           
 boolean isEscape()
          Indicates whether rendered markup should be escaped.
 boolean isReadonly()
           
 void setAccesskey(String accesskey)
           
 void setAddAllButtonStyle(String addAllButtonStyle)
           
 void setAddAllButtonStyleClass(String addAllButtonStyleClass)
           
 void setAddAllButtonText(String addAllButtonText)
           
 void setAddButtonStyle(String addButtonStyle)
           
 void setAddButtonStyleClass(String addButtonStyleClass)
           
 void setAddButtonText(String addButtonText)
           
 void setDir(String dir)
           
 void setDisabled(boolean disabled)
           
 void setEscape(boolean escape)
           
 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 setRemoveAllButtonStyle(String removeAllButtonStyle)
           
 void setRemoveAllButtonStyleClass(String removeAllButtonStyleClass)
           
 void setRemoveAllButtonText(String removeAllButtonText)
           
 void setRemoveButtonStyle(String removeButtonStyle)
           
 void setRemoveButtonStyleClass(String removeButtonStyleClass)
           
 void setRemoveButtonText(String removeButtonText)
           
 void setSize(int size)
           
 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)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlSelectManyListbox
getDatafld, getDataformatas, getDatasrc, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getVisibleOnUserRole, isForceId, isForceIdIndex, setDatafld, setDataformatas, setDatasrc, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setVisibleOnUserRole
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlSelectManyListbox
getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly
 
Methods inherited from class javax.faces.component.html.HtmlSelectManyListbox
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, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, 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

HtmlSelectManyPicklist

public HtmlSelectManyPicklist()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class HtmlSelectManyListbox

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 HtmlSelectManyListbox

getAddButtonText

public String getAddButtonText()
Description copied from class: AbstractHtmlSelectManyPicklist
Define the text that goes inside the add button

Specified by:
getAddButtonText in class AbstractHtmlSelectManyPicklist

setAddButtonText

public void setAddButtonText(String addButtonText)

getAddAllButtonText

public String getAddAllButtonText()
Description copied from class: AbstractHtmlSelectManyPicklist
Define the text that goes inside the add all button

Specified by:
getAddAllButtonText in class AbstractHtmlSelectManyPicklist

setAddAllButtonText

public void setAddAllButtonText(String addAllButtonText)

getRemoveButtonText

public String getRemoveButtonText()
Description copied from class: AbstractHtmlSelectManyPicklist
Define the text that goes inside the remove button

Specified by:
getRemoveButtonText in class AbstractHtmlSelectManyPicklist

setRemoveButtonText

public void setRemoveButtonText(String removeButtonText)

getRemoveAllButtonText

public String getRemoveAllButtonText()
Description copied from class: AbstractHtmlSelectManyPicklist
Define the text that goes inside the remove all button

Specified by:
getRemoveAllButtonText in class AbstractHtmlSelectManyPicklist

setRemoveAllButtonText

public void setRemoveAllButtonText(String removeAllButtonText)

getAddButtonStyle

public String getAddButtonStyle()
Description copied from class: AbstractHtmlSelectManyPicklist
CSS style to be applied to the add button

Specified by:
getAddButtonStyle in class AbstractHtmlSelectManyPicklist

setAddButtonStyle

public void setAddButtonStyle(String addButtonStyle)

getAddAllButtonStyle

public String getAddAllButtonStyle()
Description copied from class: AbstractHtmlSelectManyPicklist
CSS style to be applied to the add all button

Specified by:
getAddAllButtonStyle in class AbstractHtmlSelectManyPicklist

setAddAllButtonStyle

public void setAddAllButtonStyle(String addAllButtonStyle)

getRemoveButtonStyle

public String getRemoveButtonStyle()
Description copied from class: AbstractHtmlSelectManyPicklist
CSS style to be applied to the remove button

Specified by:
getRemoveButtonStyle in class AbstractHtmlSelectManyPicklist

setRemoveButtonStyle

public void setRemoveButtonStyle(String removeButtonStyle)

getRemoveAllButtonStyle

public String getRemoveAllButtonStyle()
Description copied from class: AbstractHtmlSelectManyPicklist
CSS style to be applied to the remove all button

Specified by:
getRemoveAllButtonStyle in class AbstractHtmlSelectManyPicklist

setRemoveAllButtonStyle

public void setRemoveAllButtonStyle(String removeAllButtonStyle)

getAddButtonStyleClass

public String getAddButtonStyleClass()
Description copied from class: AbstractHtmlSelectManyPicklist
CSS styleClass to be applied to the add button

Specified by:
getAddButtonStyleClass in class AbstractHtmlSelectManyPicklist

setAddButtonStyleClass

public void setAddButtonStyleClass(String addButtonStyleClass)

getAddAllButtonStyleClass

public String getAddAllButtonStyleClass()
Description copied from class: AbstractHtmlSelectManyPicklist
CSS styleClass to be applied to the add all button

Specified by:
getAddAllButtonStyleClass in class AbstractHtmlSelectManyPicklist

setAddAllButtonStyleClass

public void setAddAllButtonStyleClass(String addAllButtonStyleClass)

getRemoveButtonStyleClass

public String getRemoveButtonStyleClass()
Description copied from class: AbstractHtmlSelectManyPicklist
CSS styleClass to be applied to the remove button

Specified by:
getRemoveButtonStyleClass in class AbstractHtmlSelectManyPicklist

setRemoveButtonStyleClass

public void setRemoveButtonStyleClass(String removeButtonStyleClass)

getRemoveAllButtonStyleClass

public String getRemoveAllButtonStyleClass()
Description copied from class: AbstractHtmlSelectManyPicklist
CSS styleClass to be applied to the remove all button

Specified by:
getRemoveAllButtonStyleClass in class AbstractHtmlSelectManyPicklist

setRemoveAllButtonStyleClass

public void setRemoveAllButtonStyleClass(String removeAllButtonStyleClass)

getValueType

public String getValueType()
Description copied from class: AbstractHtmlSelectManyPicklist
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 AbstractHtmlSelectManyPicklist

setValueType

public void setValueType(String valueType)
Overrides:
setValueType in class HtmlSelectManyListbox

isEscape

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

Specified by:
isEscape in interface EscapeAware
Specified by:
isEscape in interface EscapeCapable
Overrides:
isEscape in class HtmlSelectManyListbox

setEscape

public void setEscape(boolean escape)
Specified by:
setEscape in interface EscapeCapable
Overrides:
setEscape in class HtmlSelectManyListbox

getSize

public int getSize()
Overrides:
getSize in class HtmlSelectManyListbox

setSize

public void setSize(int size)
Overrides:
setSize in class HtmlSelectManyListbox

getLabel

public String getLabel()
Overrides:
getLabel in class HtmlSelectManyListbox

setLabel

public void setLabel(String label)
Overrides:
setLabel in class HtmlSelectManyListbox

getStyle

public String getStyle()
Overrides:
getStyle in class HtmlSelectManyListbox

setStyle

public void setStyle(String style)
Overrides:
setStyle in class HtmlSelectManyListbox

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class HtmlSelectManyListbox

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class HtmlSelectManyListbox

getTabindex

public String getTabindex()
Overrides:
getTabindex in class HtmlSelectManyListbox

setTabindex

public void setTabindex(String tabindex)
Overrides:
setTabindex in class HtmlSelectManyListbox

getOnblur

public String getOnblur()
Overrides:
getOnblur in class HtmlSelectManyListbox

setOnblur

public void setOnblur(String onblur)
Overrides:
setOnblur in class HtmlSelectManyListbox

getOnfocus

public String getOnfocus()
Overrides:
getOnfocus in class HtmlSelectManyListbox

setOnfocus

public void setOnfocus(String onfocus)
Overrides:
setOnfocus in class HtmlSelectManyListbox

getAccesskey

public String getAccesskey()
Overrides:
getAccesskey in class HtmlSelectManyListbox

setAccesskey

public void setAccesskey(String accesskey)
Overrides:
setAccesskey in class HtmlSelectManyListbox

getOnclick

public String getOnclick()
Overrides:
getOnclick in class HtmlSelectManyListbox

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class HtmlSelectManyListbox

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class HtmlSelectManyListbox

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class HtmlSelectManyListbox

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class HtmlSelectManyListbox

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class HtmlSelectManyListbox

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class HtmlSelectManyListbox

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class HtmlSelectManyListbox

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class HtmlSelectManyListbox

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class HtmlSelectManyListbox

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class HtmlSelectManyListbox

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class HtmlSelectManyListbox

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class HtmlSelectManyListbox

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class HtmlSelectManyListbox

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class HtmlSelectManyListbox

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class HtmlSelectManyListbox

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class HtmlSelectManyListbox

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class HtmlSelectManyListbox

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class HtmlSelectManyListbox

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class HtmlSelectManyListbox

getOnchange

public String getOnchange()
Overrides:
getOnchange in class HtmlSelectManyListbox

setOnchange

public void setOnchange(String onchange)
Overrides:
setOnchange in class HtmlSelectManyListbox

getOnselect

public String getOnselect()
Overrides:
getOnselect in class HtmlSelectManyListbox

setOnselect

public void setOnselect(String onselect)
Overrides:
setOnselect in class HtmlSelectManyListbox

getDir

public String getDir()
Overrides:
getDir in class HtmlSelectManyListbox

setDir

public void setDir(String dir)
Overrides:
setDir in class HtmlSelectManyListbox

getLang

public String getLang()
Overrides:
getLang in class HtmlSelectManyListbox

setLang

public void setLang(String lang)
Overrides:
setLang in class HtmlSelectManyListbox

getTitle

public String getTitle()
Overrides:
getTitle in class HtmlSelectManyListbox

setTitle

public void setTitle(String title)
Overrides:
setTitle in class HtmlSelectManyListbox

isDisabled

public boolean isDisabled()
Overrides:
isDisabled in class HtmlSelectManyListbox

setDisabled

public void setDisabled(boolean disabled)
Overrides:
setDisabled in class HtmlSelectManyListbox

isReadonly

public boolean isReadonly()
Overrides:
isReadonly in class HtmlSelectManyListbox

setReadonly

public void setReadonly(boolean readonly)
Overrides:
setReadonly in class HtmlSelectManyListbox

setValueBinding

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

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class HtmlSelectManyListbox


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