org.rcfaces.core.component
Class ViewErrorListenerComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.rcfaces.core.internal.component.CameliaBaseComponent
              extended by org.rcfaces.core.component.ViewErrorListenerComponent
All Implemented Interfaces:
StateHolder, IClientDataCapability, IErrorEventCapability, IPropertyChangeEventCapability, IServerDataCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class ViewErrorListenerComponent
extends org.rcfaces.core.internal.component.CameliaBaseComponent
implements IClientDataCapability, IServerDataCapability, IPropertyChangeEventCapability, IErrorEventCapability


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaBaseComponent
engine
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
ViewErrorListenerComponent()
           
ViewErrorListenerComponent(String componentId)
           
 
Method Summary
 void addErrorListener(IErrorListener listener)
          Adds a listener to the component for the error event
 void addPropertyChangeListener(IPropertyChangeListener listener)
          Adds a listener to the component for the propertyChange event
protected  Set getCameliaFields()
           
 String getClientData(String name)
          Retrieves the data associated to a variable
 String getClientData(String name, FacesContext facesContext)
           
 int getClientDataCount()
          Returns the number of variable associated to the component.
 Map getClientDataMap()
          Returns a map containing the couples variable-data
 Map getClientDataMap(FacesContext facesContext)
           
 Object getServerData(String name)
          Retrieves an object data associated to a key
 Object getServerData(String name, FacesContext facesContext)
           
 int getServerDataCount()
          Returns the number of keys associated to the component.
 Map getServerDataMap()
          Returns a Map object containing keys and associated data objects
 Map getServerDataMap(FacesContext facesContext)
           
 String[] listClientDataKeys()
          Returns the list of variable associated to the component.
 String[] listClientDataKeys(FacesContext facesContext)
           
 FacesListener[] listErrorListeners()
          Returns a list of Error listener for the component
 FacesListener[] listPropertyChangeListeners()
          Returns a list of propertyChange listener for the component
 String[] listServerDataKeys()
          Returns a list of the keys defined for the component
 String[] listServerDataKeys(FacesContext facesContext)
           
 String removeClientData(String name)
          Removes the variable name and the data associated to it
 void removeErrorListener(IErrorListener listener)
          Removes a listener from the component for the error event
 void removePropertyChangeListener(IPropertyChangeListener listener)
          Removes a listener from the component for the propertyChange event
 Object removeServerData(String name)
          Removes a key and the data object associated to it
 String setClientData(String name, String value)
          Associates data to variable name.
 Object setServerData(String name, Object value)
          Associates and object to a key for the component on the server side
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaBaseComponent
clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager
getChildCount
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES
Constructor Detail

ViewErrorListenerComponent

public ViewErrorListenerComponent()

ViewErrorListenerComponent

public ViewErrorListenerComponent(String componentId)
Method Detail

getClientData

public String getClientData(String name,
                            FacesContext facesContext)

getServerData

public Object getServerData(String name,
                            FacesContext facesContext)

getClientDataMap

public Map getClientDataMap(FacesContext facesContext)

getServerDataMap

public Map getServerDataMap(FacesContext facesContext)

listClientDataKeys

public String[] listClientDataKeys(FacesContext facesContext)

listServerDataKeys

public String[] listServerDataKeys(FacesContext facesContext)

getClientDataCount

public int getClientDataCount()
Description copied from interface: IClientDataCapability
Returns the number of variable associated to the component.

Specified by:
getClientDataCount in interface IClientDataCapability
Returns:
number of variable

listClientDataKeys

public String[] listClientDataKeys()
Description copied from interface: IClientDataCapability
Returns the list of variable associated to the component.

Specified by:
listClientDataKeys in interface IClientDataCapability
Returns:
a list of variables

removeClientData

public String removeClientData(String name)
Description copied from interface: IClientDataCapability
Removes the variable name and the data associated to it

Specified by:
removeClientData in interface IClientDataCapability
Parameters:
name - the variable to associate data to
Returns:
the data that was associated to the variable

setClientData

public String setClientData(String name,
                            String value)
Description copied from interface: IClientDataCapability
Associates data to variable name.

Specified by:
setClientData in interface IClientDataCapability
Parameters:
name - the variable to associate data to
value - the data to associate to the variable
Returns:
the data previously associated with the variable (empty if none)

getClientData

public String getClientData(String name)
Description copied from interface: IClientDataCapability
Retrieves the data associated to a variable

Specified by:
getClientData in interface IClientDataCapability
Parameters:
name - the variable to associate data to
Returns:
the data associated to the variable

getClientDataMap

public Map getClientDataMap()
Description copied from interface: IClientDataCapability
Returns a map containing the couples variable-data

Specified by:
getClientDataMap in interface IClientDataCapability
Returns:
a map

listServerDataKeys

public String[] listServerDataKeys()
Description copied from interface: IServerDataCapability
Returns a list of the keys defined for the component

Specified by:
listServerDataKeys in interface IServerDataCapability
Returns:
list of keys

setServerData

public Object setServerData(String name,
                            Object value)
Description copied from interface: IServerDataCapability
Associates and object to a key for the component on the server side

Specified by:
setServerData in interface IServerDataCapability
Parameters:
name - key used to retrieve the object associated
value - object to associate
Returns:
the object previously associated to teh key (null if none)

getServerDataMap

public Map getServerDataMap()
Description copied from interface: IServerDataCapability
Returns a Map object containing keys and associated data objects

Specified by:
getServerDataMap in interface IServerDataCapability
Returns:
a map

getServerDataCount

public int getServerDataCount()
Description copied from interface: IServerDataCapability
Returns the number of keys associated to the component.

Specified by:
getServerDataCount in interface IServerDataCapability
Returns:
number of keys

getServerData

public Object getServerData(String name)
Description copied from interface: IServerDataCapability
Retrieves an object data associated to a key

Specified by:
getServerData in interface IServerDataCapability
Parameters:
name - the key to retrieve
Returns:
the data object associated to the key

removeServerData

public Object removeServerData(String name)
Description copied from interface: IServerDataCapability
Removes a key and the data object associated to it

Specified by:
removeServerData in interface IServerDataCapability
Parameters:
name - the key to remove
Returns:
the data object that was associated to the key (null if none)

addPropertyChangeListener

public final void addPropertyChangeListener(IPropertyChangeListener listener)
Description copied from interface: IPropertyChangeEventCapability
Adds a listener to the component for the propertyChange event

Specified by:
addPropertyChangeListener in interface IPropertyChangeEventCapability
Parameters:
listener - the propertyChange listener to add

removePropertyChangeListener

public final void removePropertyChangeListener(IPropertyChangeListener listener)
Description copied from interface: IPropertyChangeEventCapability
Removes a listener from the component for the propertyChange event

Specified by:
removePropertyChangeListener in interface IPropertyChangeEventCapability
Parameters:
listener - the propertyChange listener to remove

listPropertyChangeListeners

public final FacesListener[] listPropertyChangeListeners()
Description copied from interface: IPropertyChangeEventCapability
Returns a list of propertyChange listener for the component

Specified by:
listPropertyChangeListeners in interface IPropertyChangeEventCapability
Returns:
propertyChange listeners' list

addErrorListener

public final void addErrorListener(IErrorListener listener)
Description copied from interface: IErrorEventCapability
Adds a listener to the component for the error event

Specified by:
addErrorListener in interface IErrorEventCapability
Parameters:
listener - the load listener to add

removeErrorListener

public final void removeErrorListener(IErrorListener listener)
Description copied from interface: IErrorEventCapability
Removes a listener from the component for the error event

Specified by:
removeErrorListener in interface IErrorEventCapability
Parameters:
listener - the load listener to remove

listErrorListeners

public final FacesListener[] listErrorListeners()
Description copied from interface: IErrorEventCapability
Returns a list of Error listener for the component

Specified by:
listErrorListeners in interface IErrorEventCapability
Returns:
load listeners' list

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class org.rcfaces.core.internal.component.CameliaBaseComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.