org.apache.myfaces.custom.statechangednotifier
Class AbstractStateChangedNotifier

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.HtmlInputHidden
                      extended by org.apache.myfaces.custom.statechangednotifier.AbstractStateChangedNotifier
All Implemented Interfaces:
javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

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.html.HtmlInputHidden
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
 
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.html.HtmlInputHidden
getFamily
 
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, restoreState, saveState, 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, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, 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 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



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