org.apache.myfaces.custom.inputAjax
Class AbstractHtmlSelectBooleanCheckboxAjax

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.UISelectBoolean
                      javax.faces.component.html.HtmlSelectBooleanCheckbox
                          org.apache.myfaces.component.html.ext.AbstractHtmlSelectBooleanCheckbox
                              org.apache.myfaces.component.html.ext.HtmlSelectBooleanCheckbox
                                  org.apache.myfaces.custom.inputAjax.AbstractHtmlSelectBooleanCheckboxAjax

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, org.apache.myfaces.component.AltProperty, 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, AjaxCallbacks, AjaxComponent, DeprecatedAjaxComponent, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable, org.apache.myfaces.shared_tomahawk.component.EscapeCapable

Direct Known Subclasses:

HtmlSelectBooleanCheckboxAjax

public abstract class AbstractHtmlSelectBooleanCheckboxAjax
extends org.apache.myfaces.component.html.ext.HtmlSelectBooleanCheckbox
implements DeprecatedAjaxComponent, AjaxCallbacks

Extends standard selectBooleanCheckbox by user role support.

Field Summary

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

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

COMPONENT_FAMILY

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

AbstractHtmlSelectBooleanCheckboxAjax()

Method Summary

void	decodeAjax(javax.faces.context.FacesContext context) Decode ajax request and apply value changes
void	encodeAjax(javax.faces.context.FacesContext context)
abstract java.lang.String	getOffImage() Image to show instead of checkox when boolean value is false
abstract java.lang.String	getOnFailure() Javascript method to call on failed ajax update
abstract java.lang.String	getOnImage() Image to show instead of checkox when boolean value is true
abstract java.lang.String	getOnStart() Javascript method to call on start of ajax update
abstract java.lang.String	getOnSuccess() Javascript method to call on successful ajax update

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

getAlt, getDatafld, getDataformatas, getDatasrc, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getFamily, getVisibleOnUserRole, isEscape, isForceId, isForceIdIndex, restoreState, saveState, setAlt, setDatafld, setDataformatas, setDatasrc, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setEscape, setForceId, setForceIdIndex, setVisibleOnUserRole

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

getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly

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

getAccesskey, getDir, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setDir, setDisabled, setLang, 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.UISelectBoolean

getValueBinding, isSelected, setSelected, setValueBinding

Methods inherited from class javax.faces.component.UIInput

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

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, 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 org.apache.myfaces.custom.ajax.AjaxCallbacks

setOnFailure, setOnStart, setOnSuccess

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, 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

AbstractHtmlSelectBooleanCheckboxAjax

public AbstractHtmlSelectBooleanCheckboxAjax()

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 -

encodeAjax

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

Specified by:

encodeAjax in interface AjaxComponent

Throws:

java.io.IOException

getOnSuccess

public abstract java.lang.String getOnSuccess()

Javascript method to call on successful ajax update

Specified by:

getOnSuccess in interface AjaxCallbacks

getOnFailure

public abstract java.lang.String getOnFailure()

Javascript method to call on failed ajax update

Specified by:

getOnFailure in interface AjaxCallbacks

getOnStart

public abstract java.lang.String getOnStart()

Javascript method to call on start of ajax update

Specified by:

getOnStart in interface AjaxCallbacks

getOnImage

public abstract java.lang.String getOnImage()

Image to show instead of checkox when boolean value is true

getOffImage

public abstract java.lang.String getOffImage()

Image to show instead of checkox when boolean value is false