org.apache.myfaces.custom.submitOnEvent
Class SubmitOnEvent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.custom.submitOnEvent.AbstractSubmitOnEvent
              org.apache.myfaces.custom.submitOnEvent.SubmitOnEvent

All Implemented Interfaces:

javax.faces.component.StateHolder

public class SubmitOnEvent
extends AbstractSubmitOnEvent

Field Summary

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

Constructor Summary

SubmitOnEvent()

Method Summary

java.lang.String	getCallback() User defined javascript callback function.
java.lang.String	getEvent() The event: keypress|keydown|keyup|change|focus|blur|click|mousedown|mouseup|mousemove|mouseover|mouseout|select (Default: keypress)
java.lang.String	getFamily()
java.lang.String	getFor() The component (commandLink or commandButton) to "click" on
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setCallback(java.lang.String callback)
void	setEvent(java.lang.String event)
void	setFor(java.lang.String forParam)

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

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

SubmitOnEvent

public SubmitOnEvent()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getFor

public java.lang.String getFor()

Description copied from class: AbstractSubmitOnEvent

The component (commandLink or commandButton) to "click" on

Specified by:

getFor in class AbstractSubmitOnEvent

setFor

public void setFor(java.lang.String forParam)

getEvent

public java.lang.String getEvent()

Description copied from class: AbstractSubmitOnEvent

The event: keypress|keydown|keyup|change|focus|blur|click|mousedown|mouseup|mousemove|mouseover|mouseout|select (Default: keypress)

Specified by:

getEvent in class AbstractSubmitOnEvent

setEvent

public void setEvent(java.lang.String event)

getCallback

public java.lang.String getCallback()

Description copied from class: AbstractSubmitOnEvent

User defined javascript callback function. This function will be called to decide if the event should trigger the submit. (Default: fire on "Enter")

Specified by:

getCallback in class AbstractSubmitOnEvent

setCallback

public void setCallback(java.lang.String callback)

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase