org.apache.myfaces.custom.inputAjax
Class AbstractHtmlInputTextAjax

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.html.HtmlInputText
                      extended by org.apache.myfaces.component.html.ext.AbstractHtmlInputText
                          extended by org.apache.myfaces.component.html.ext.HtmlInputText
                              extended by org.apache.myfaces.custom.inputAjax.AbstractHtmlInputTextAjax
All Implemented Interfaces:
javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, org.apache.myfaces.component.AlignProperty, org.apache.myfaces.component.DataProperties, org.apache.myfaces.component.DisplayValueOnlyAware, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.UserRoleAware, AjaxCallbacks, AjaxComponent, DeprecatedAjaxComponent, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

public abstract class AbstractHtmlInputTextAjax
extends org.apache.myfaces.component.html.ext.HtmlInputText
implements DeprecatedAjaxComponent, AjaxCallbacks

Extends standard inputText allowing for dynamic ajax submitting.


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.HtmlInputText
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
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
AbstractHtmlInputTextAjax()
           
 
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 getCancelText()
          Text for cancel
abstract  java.lang.String getErrorStyle()
          Style for the input field where the error occures.
abstract  java.lang.String getErrorStyleClass()
          StyleClass for the input field where the error occures.
abstract  java.lang.String getOkText()
          Test for button
abstract  java.lang.String getOnFailure()
          Javascript method to call on failed ajax update
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
abstract  java.lang.Boolean getShowCancelButton()
          Whether to show cancel button
abstract  java.lang.Boolean getShowOkButton()
          Whether to show an ok button before sending update.
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlInputText
getAlign, getAutocomplete, getDatafld, getDataformatas, getDatasrc, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getFamily, getVisibleOnUserRole, isDisabledOnClientSide, isForceId, isForceIdIndex, restoreState, saveState, setAlign, setAutocomplete, setDatafld, setDataformatas, setDatasrc, setDisabledOnClientSide, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setVisibleOnUserRole
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlInputText
getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly
 
Methods inherited from class javax.faces.component.html.HtmlInputText
getAccesskey, getAlt, getDir, getLabel, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setDir, setDisabled, setLabel, setLang, setMaxlength, 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.UIInput
addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, 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, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
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

AbstractHtmlInputTextAjax

public AbstractHtmlInputTextAjax()
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

getShowOkButton

public abstract java.lang.Boolean getShowOkButton()
Whether to show an ok button before sending update.


getOkText

public abstract java.lang.String getOkText()
Test for button


getShowCancelButton

public abstract java.lang.Boolean getShowCancelButton()
Whether to show cancel button


getCancelText

public abstract java.lang.String getCancelText()
Text for cancel


getErrorStyleClass

public abstract java.lang.String getErrorStyleClass()
StyleClass for the input field where the error occures. Useful if there is only one messages area for a few inputTextAjax fields


getErrorStyle

public abstract java.lang.String getErrorStyle()
Style for the input field where the error occures. Useful if there is only one messages area for a few inputTextAjax fields



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