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:
java.util.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 HtmlSelectManyPicklist
extends AbstractHtmlSelectManyPicklist


Nested Class Summary
protected static class HtmlSelectManyPicklist.PropertyKeys
           
 
Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.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
HtmlSelectManyPicklist()
           
 
Method Summary
 java.lang.String getAddAllButtonStyle()
          CSS style to be applied to the add all button
 java.lang.String getAddAllButtonStyleClass()
          CSS styleClass to be applied to the add all button
 java.lang.String getAddAllButtonText()
          Define the text that goes inside the add all button
 java.lang.String getAddButtonStyle()
          CSS style to be applied to the add button
 java.lang.String getAddButtonStyleClass()
          CSS styleClass to be applied to the add button
 java.lang.String getAddButtonText()
          Define the text that goes inside the add button
 java.lang.String getFamily()
           
 java.lang.String getRemoveAllButtonStyle()
          CSS style to be applied to the remove all button
 java.lang.String getRemoveAllButtonStyleClass()
          CSS styleClass to be applied to the remove all button
 java.lang.String getRemoveAllButtonText()
          Define the text that goes inside the remove all button
 java.lang.String getRemoveButtonStyle()
          CSS style to be applied to the remove button
 java.lang.String getRemoveButtonStyleClass()
          CSS styleClass to be applied to the remove button
 java.lang.String getRemoveButtonText()
          Define the text that goes inside the remove button
 java.lang.String getValueType()
          Specifies the value type of the selectable items.
 void setAddAllButtonStyle(java.lang.String addAllButtonStyle)
           
 void setAddAllButtonStyleClass(java.lang.String addAllButtonStyleClass)
           
 void setAddAllButtonText(java.lang.String addAllButtonText)
           
 void setAddButtonStyle(java.lang.String addButtonStyle)
           
 void setAddButtonStyleClass(java.lang.String addButtonStyleClass)
           
 void setAddButtonText(java.lang.String addButtonText)
           
 void setRemoveAllButtonStyle(java.lang.String removeAllButtonStyle)
           
 void setRemoveAllButtonStyleClass(java.lang.String removeAllButtonStyleClass)
           
 void setRemoveAllButtonText(java.lang.String removeAllButtonText)
           
 void setRemoveButtonStyle(java.lang.String removeButtonStyle)
           
 void setRemoveButtonStyleClass(java.lang.String removeButtonStyleClass)
           
 void setRemoveButtonText(java.lang.String removeButtonText)
           
 void setValueType(java.lang.String valueType)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlSelectManyListbox
getDatafld, getDataformatas, getDatasrc, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getVisibleOnUserRole, isEscape, isForceId, isForceIdIndex, setDatafld, setDataformatas, setDatasrc, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setEscape, 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
getAccesskey, getDefaultEventName, getDir, getDisabledClass, getEnabledClass, getEventNames, getLabel, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setDir, setDisabled, setDisabledClass, setEnabledClass, setLabel, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setStyle, setStyleClass, setTabindex, setTitle
 
Methods inherited from class javax.faces.component.UISelectMany
compareValues, getConvertedValue, getSelectedValues, getValueBinding, getValueExpression, setSelectedValues, setValueBinding, setValueExpression, 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
addClientBehavior, addFacesListener, 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
encodeAll, 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
addClientBehavior, getClientBehaviors
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
 

Field Detail

COMPONENT_FAMILY

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

COMPONENT_TYPE

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

DEFAULT_RENDERER_TYPE

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

HtmlSelectManyPicklist

public HtmlSelectManyPicklist()
Method Detail

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class HtmlSelectManyListbox

getAddButtonText

public java.lang.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(java.lang.String addButtonText)

getAddAllButtonText

public java.lang.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(java.lang.String addAllButtonText)

getRemoveButtonText

public java.lang.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(java.lang.String removeButtonText)

getRemoveAllButtonText

public java.lang.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(java.lang.String removeAllButtonText)

getAddButtonStyle

public java.lang.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(java.lang.String addButtonStyle)

getAddAllButtonStyle

public java.lang.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(java.lang.String addAllButtonStyle)

getRemoveButtonStyle

public java.lang.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(java.lang.String removeButtonStyle)

getRemoveAllButtonStyle

public java.lang.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(java.lang.String removeAllButtonStyle)

getAddButtonStyleClass

public java.lang.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(java.lang.String addButtonStyleClass)

getAddAllButtonStyleClass

public java.lang.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(java.lang.String addAllButtonStyleClass)

getRemoveButtonStyleClass

public java.lang.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(java.lang.String removeButtonStyleClass)

getRemoveAllButtonStyleClass

public java.lang.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(java.lang.String removeAllButtonStyleClass)

getValueType

public java.lang.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(java.lang.String valueType)
Overrides:
setValueType in class HtmlSelectManyListbox


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