org.apache.myfaces.custom.picklist
Class AbstractHtmlSelectManyPicklist

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.UISelectMany
                      javax.faces.component.html.HtmlSelectManyListbox
                          org.apache.myfaces.component.html.ext.AbstractHtmlSelectManyListbox
                              org.apache.myfaces.component.html.ext.HtmlSelectManyListbox
                                  org.apache.myfaces.custom.picklist.AbstractHtmlSelectManyPicklist

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, org.apache.myfaces.component.DataProperties, org.apache.myfaces.component.DisplayValueOnlyAware, org.apache.myfaces.component.EscapeAware, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.UserRoleAware, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable, org.apache.myfaces.shared_tomahawk.component.EscapeCapable

@JSFComponent(name="t:selectManyPicklist",
              clazz="org.apache.myfaces.custom.picklist.HtmlSelectManyPicklist",
              tagClass="org.apache.myfaces.custom.picklist.HtmlSelectManyPicklistTag")
public abstract class AbstractHtmlSelectManyPicklist
extends org.apache.myfaces.component.html.ext.HtmlSelectManyListbox

A picklist component that allows to select items from one list to another

In other words, is a selection component where a set of items can be selected from a list that contains all the available items to a list that contains the selected items.

The component is based on the t:selectManyListbox component, so it contains the same attributes. Soon, more specific attributes will be added.

Since:

1.1.7

Version:

$Revision: 955214 $ $Date: 2010-06-16 07:16:02 -0500 (Wed, 16 Jun 2010) $

Author:

Bruno Aranda (latest modification by $Author: jakobk $)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.component.html.ext.HtmlSelectManyListbox

org.apache.myfaces.component.html.ext.HtmlSelectManyListbox.PropertyKeys

Field Summary

static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER_TYPE

Fields inherited from class org.apache.myfaces.component.html.ext.HtmlSelectManyListbox

COMPONENT_FAMILY

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

AbstractHtmlSelectManyPicklist()

Method Summary

abstract String	getAddAllButtonStyle() CSS style to be applied to the add all button
abstract String	getAddAllButtonStyleClass() CSS styleClass to be applied to the add all button
abstract String	getAddAllButtonText() Define the text that goes inside the add all button
abstract String	getAddButtonStyle() CSS style to be applied to the add button
abstract String	getAddButtonStyleClass() CSS styleClass to be applied to the add button
abstract String	getAddButtonText() Define the text that goes inside the add button
abstract String	getRemoveAllButtonStyle() CSS style to be applied to the remove all button
abstract String	getRemoveAllButtonStyleClass() CSS styleClass to be applied to the remove all button
abstract String	getRemoveAllButtonText() Define the text that goes inside the remove all button
abstract String	getRemoveButtonStyle() CSS style to be applied to the remove button
abstract String	getRemoveButtonStyleClass() CSS styleClass to be applied to the remove button
abstract String	getRemoveButtonText() Define the text that goes inside the remove button
abstract String	getValueType() Specifies the value type of the selectable items.

Methods inherited from class org.apache.myfaces.component.html.ext.HtmlSelectManyListbox

addClientBehavior, getAccesskey, getDatafld, getDataformatas, getDatasrc, getDir, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getFamily, getLabel, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, getVisibleOnUserRole, isDisabled, isEscape, isForceId, isForceIdIndex, isReadonly, setAccesskey, setDatafld, setDataformatas, setDatasrc, setDir, setDisabled, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setEscape, setForceId, setForceIdIndex, setLabel, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setStyle, setStyleClass, setTabindex, setTitle, setValueBinding, setValueExpression, setValueType, 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, 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_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

AbstractHtmlSelectManyPicklist

public AbstractHtmlSelectManyPicklist()

Method Detail

getAddButtonText

public abstract String getAddButtonText()

Define the text that goes inside the add button

getAddAllButtonText

public abstract String getAddAllButtonText()

Define the text that goes inside the add all button

getRemoveButtonText

public abstract String getRemoveButtonText()

Define the text that goes inside the remove button

getRemoveAllButtonText

public abstract String getRemoveAllButtonText()

Define the text that goes inside the remove all button

getAddButtonStyle

public abstract String getAddButtonStyle()

CSS style to be applied to the add button

getAddAllButtonStyle

public abstract String getAddAllButtonStyle()

CSS style to be applied to the add all button

getRemoveButtonStyle

public abstract String getRemoveButtonStyle()

CSS style to be applied to the remove button

getRemoveAllButtonStyle

public abstract String getRemoveAllButtonStyle()

CSS style to be applied to the remove all button

getAddButtonStyleClass

public abstract String getAddButtonStyleClass()

CSS styleClass to be applied to the add button

getAddAllButtonStyleClass

public abstract String getAddAllButtonStyleClass()

CSS styleClass to be applied to the add all button

getRemoveButtonStyleClass

public abstract String getRemoveButtonStyleClass()

CSS styleClass to be applied to the remove button

getRemoveAllButtonStyleClass

public abstract String getRemoveAllButtonStyleClass()

CSS styleClass to be applied to the remove all button

getValueType

@JSFProperty
public abstract String getValueType()

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).

Overrides:

getValueType in class org.apache.myfaces.component.html.ext.HtmlSelectManyListbox

Since:

2.0