org.apache.myfaces.custom.inputAjax
Class HtmlSelectManyCheckboxAjax

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.HtmlSelectManyCheckbox
                          org.apache.myfaces.component.html.ext.HtmlSelectManyCheckbox
                              org.apache.myfaces.custom.inputAjax.HtmlSelectManyCheckboxAjax

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, UserRoleAware, AjaxCallbacks, AjaxComponent, DeprecatedAjaxComponent, ExtendedComponentBase, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable, org.apache.myfaces.shared_tomahawk.component.EscapeCapable

public class HtmlSelectManyCheckboxAjax
extends HtmlSelectManyCheckbox
implements DeprecatedAjaxComponent, AjaxCallbacks

Current limitations - Bound value must be a Collection of Strings!

Version:

$Revision: 290397 $ $Date: 2005-09-20 10:35:09 +0200 (Di, 20 Sep 2005) $

Author:

Travis Reeder (latest modification by $Author: mmarinschek $)

Field Summary

static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from class javax.faces.component.UISelectMany

COMPONENT_FAMILY, INVALID_MESSAGE_ID

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

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

HtmlSelectManyCheckboxAjax()

Method Summary

void	decodeAjax(javax.faces.context.FacesContext context) Decode ajax request and apply value changes
void	encodeAjax(javax.faces.context.FacesContext context)
java.lang.String	getOnFailure()
java.lang.String	getOnStart()
java.lang.String	getOnSuccess()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setOnFailure(java.lang.String onFailure)
void	setOnStart(java.lang.String onStart)
void	setOnSuccess(java.lang.String onSuccess)
void	updateChosenValue(java.util.Collection c, java.lang.String elname, java.lang.String elvalue, boolean checked) Will find the chosen value in the chosenValues list and update set or unset accordingly.

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

getClientId, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getLayoutWidth, getVisibleOnUserRole, isDisplayValueOnly, isEscape, isForceId, isRendered, isSetDisplayValueOnly, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setEscape, setForceId, setLayoutWidth, setVisibleOnUserRole

Methods inherited from class javax.faces.component.html.HtmlSelectManyCheckbox

getAccesskey, getBorder, getDir, getDisabledClass, getEnabledClass, getLang, getLayout, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setBorder, setDir, setDisabled, setDisabledClass, setEnabledClass, setLang, setLayout, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setTabindex, setTitle

Methods inherited from class javax.faces.component.UISelectMany

compareValues, getConvertedValue, getFamily, getSelectedValues, getValueBinding, setSelectedValues, setValueBinding, validate, validateValue

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, decode, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

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

getConverter, getLocalValue, getValue, setConverter

Field Detail

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

HtmlSelectManyCheckboxAjax

public HtmlSelectManyCheckboxAjax()

Method Detail

decodeAjax

public void decodeAjax(javax.faces.context.FacesContext context)

Decode ajax request and apply value changes

Specified by:

decodeAjax in interface AjaxComponent

Parameters:

context -

updateChosenValue

public void updateChosenValue(java.util.Collection c,
                              java.lang.String elname,
                              java.lang.String elvalue,
                              boolean checked)

Will find the chosen value in the chosenValues list and update set or unset accordingly.

Parameters:

c -

elname -

elvalue -

checked -

encodeAjax

public void encodeAjax(javax.faces.context.FacesContext context)
                throws java.io.IOException

Specified by:

encodeAjax in interface AjaxComponent

Throws:

java.io.IOException

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class HtmlSelectManyCheckbox

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 HtmlSelectManyCheckbox

getOnSuccess

public java.lang.String getOnSuccess()

Specified by:

getOnSuccess in interface AjaxCallbacks

setOnSuccess

public void setOnSuccess(java.lang.String onSuccess)

Specified by:

setOnSuccess in interface AjaxCallbacks

getOnFailure

public java.lang.String getOnFailure()

Specified by:

getOnFailure in interface AjaxCallbacks

setOnFailure

public void setOnFailure(java.lang.String onFailure)

Specified by:

setOnFailure in interface AjaxCallbacks

getOnStart

public java.lang.String getOnStart()

Specified by:

getOnStart in interface AjaxCallbacks

setOnStart

public void setOnStart(java.lang.String onStart)

Specified by:

setOnStart in interface AjaxCallbacks