org.apache.myfaces.custom.inputAjax
Class AbstractHtmlCommandButtonAjax

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by javax.faces.component.html.HtmlCommandButton
                  extended by org.apache.myfaces.component.html.ext.AbstractHtmlCommandButton
                      extended by org.apache.myfaces.component.html.ext.HtmlCommandButton
                          extended by org.apache.myfaces.custom.inputAjax.AbstractHtmlCommandButtonAjax
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.UserRoleAware, AjaxCallbacks, AjaxComponent, DeprecatedAjaxComponent

public abstract class AbstractHtmlCommandButtonAjax
extends org.apache.myfaces.component.html.ext.HtmlCommandButton
implements DeprecatedAjaxComponent, AjaxCallbacks

Extends standard commandButton allowing for dynamic ajax submitting of the form.


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.HtmlCommandButton
COMPONENT_FAMILY
 
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
 
Constructor Summary
AbstractHtmlCommandButtonAjax()
           
 
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 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
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlCommandButton
getActionFor, getEnabledOnUserRole, getFamily, getVisibleOnUserRole, isForceId, isForceIdIndex, restoreState, saveState, setActionFor, setEnabledOnUserRole, setForceId, setForceIdIndex, setVisibleOnUserRole
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlCommandButton
getClientId, isRendered
 
Methods inherited from class javax.faces.component.html.HtmlCommandButton
getAccesskey, getAlt, getDir, getImage, getLabel, getLang, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getStyle, getStyleClass, getTabindex, getTitle, getType, isDisabled, isReadonly, setAccesskey, setAlt, setDir, setDisabled, setImage, setLabel, setLang, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setTabindex, setTitle, setType
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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
 

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

AbstractHtmlCommandButtonAjax

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


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