org.apache.myfaces.custom.statechangednotifier
Class AbstractStateChangedNotifier

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.html.HtmlInputHidden
                      org.apache.myfaces.custom.statechangednotifier.AbstractStateChangedNotifier

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

StateChangedNotifier

public abstract class AbstractStateChangedNotifier
extends javax.faces.component.html.HtmlInputHidden

A component that listens to changes in the components Shows a confirmation window if some of the input fields of the form have changed its value

Version:

$Revision: 663481 $ $Date: 2008-06-05 02:00:34 -0500 (Thu, 05 Jun 2008) $

Author:

Bruno Aranda (latest modification by $Author: lu4242 $)

Field Summary

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

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

AbstractStateChangedNotifier()

Method Summary

void	enableStateChanged() enable the state changed notification for this cycle
abstract java.lang.String	getConfirmationMessage() Confirmation message to show if something in the form has changed
abstract java.lang.Boolean	getDisabled() If disabled, the confirmation window will not be shown
abstract java.lang.String	getExcludedIds() Comma-separated list of cliend id of the commands which will be excluded from the confirmation message
void	reset() a helper reset to reset the notifier to a non state changed state

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getFamily, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, restoreState, saveState, 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, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, 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

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

AbstractStateChangedNotifier

public AbstractStateChangedNotifier()

Method Detail

enableStateChanged

public void enableStateChanged()

enable the state changed notification for this cycle

getConfirmationMessage

public abstract java.lang.String getConfirmationMessage()

Confirmation message to show if something in the form has changed

getDisabled

public abstract java.lang.Boolean getDisabled()

If disabled, the confirmation window will not be shown

getExcludedIds

public abstract java.lang.String getExcludedIds()

Comma-separated list of cliend id of the commands which will be excluded from the confirmation message

reset

public void reset()

a helper reset to reset the notifier to a non state changed state