gov.sandia.ccaffeine.dc.user_iface.MVC.event
Class SetComponentPropertyEvent

java.lang.Object
  extended by java.util.EventObject
      extended by gov.sandia.ccaffeine.dc.user_iface.MVC.event.SetComponentPropertyEvent
All Implemented Interfaces:
java.io.Serializable

public class SetComponentPropertyEvent
extends java.util.EventObject

Used to notify components that the cca server has set the value of a property that is inside a cca component. A view entity might respond by saving the new value of the property.

Can also be used to notify components that an entity wants to set the value of a property that is inside a cca component. A view entity might respond by sending a "property" or a "set property" message to the cca server.

See Also:
Serialized Form

Field Summary
protected  java.lang.String componentInstanceName
          The name of the component that contains the property The name is usually the java class name of the component (without the package name) concatenated with an index number.
protected  java.lang.String propertyName
           
protected  java.lang.String propertyValue
          The value of the property.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
SetComponentPropertyEvent(java.lang.Object source, java.lang.String componentInstanceName, java.lang.String propertyName, java.lang.String propertyValue)
          Create a SetPropertyEvent.
 
Method Summary
 java.lang.String getComponentInstanceName()
          Get the name of the cca component that contains the property.
 java.lang.String getPropertyName()
          Get the name of the property.
 java.lang.String getPropertyValue()
          Get the value of the property.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

componentInstanceName

protected java.lang.String componentInstanceName
The name of the component that contains the property The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"


propertyName

protected java.lang.String propertyName

propertyValue

protected java.lang.String propertyValue
The value of the property.

Constructor Detail

SetComponentPropertyEvent

public SetComponentPropertyEvent(java.lang.Object source,
                                 java.lang.String componentInstanceName,
                                 java.lang.String propertyName,
                                 java.lang.String propertyValue)
Create a SetPropertyEvent. The event can be used to notify components that the cca server has set the value of a property that is inside a cca component. A view entity might respond by saving the new value of the property.

Can also be used to notify components that an entity wants to set the value of a property that is inside a cca component. A view entity might respond by sending a "property" or a "set property" message to the cca server.

Parameters:
source - The entity that created this event.
componentInstanceName - The name of the component that contains the property The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "StartComponent0"
propertyName - The name of the property.
propertyValue - The value of the property.
Method Detail

getComponentInstanceName

public java.lang.String getComponentInstanceName()
Get the name of the cca component that contains the property.

Returns:
the name of the compoonent that contains the property.

getPropertyName

public java.lang.String getPropertyName()
Get the name of the property.

Returns:
The name of the property.

getPropertyValue

public java.lang.String getPropertyValue()
Get the value of the property.

Returns:
The value of the property.