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

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

public class GetComponentPropertyEvent
extends java.util.EventObject

Used to notify components that the cca server wants the GUI to display the value of a component property. A view might respond by writing the value to stdout.

This event can also be used to inform components that an entity wants the value of a property. A view entity might respond by sending a "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
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
GetComponentPropertyEvent(java.lang.Object source, java.lang.String componentInstanceName, java.lang.String propertyName)
          Create a GetPropertyEvent.
 
Method Summary
 java.lang.String getComponentInstanceName()
          Get 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.
 java.lang.String getPropertyName()
          Get the name 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
Constructor Detail

GetComponentPropertyEvent

public GetComponentPropertyEvent(java.lang.Object source,
                                 java.lang.String componentInstanceName,
                                 java.lang.String propertyName)
Create a GetPropertyEvent. The event can be used to inform the GUI to display the value of component property.

This event can also be used to inform components that an entity wants the cca server to send the value of a property. A view entity might respond by sending a "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.
Method Detail

getComponentInstanceName

public java.lang.String getComponentInstanceName()
Get 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"

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.