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

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

public class GoEvent
extends java.util.EventObject

Can be used to notify components that an entity wants to launch the application. A view entity might respond by launching the application

Possible Scenario
The end-user presses the RUN button
The client responds by launching the applicaction

See Also:
Serialized Form

Field Summary
protected  java.lang.String componentInstanceName
           
protected  int numberOfArguments
           
protected  java.lang.String portInstanceName
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
GoEvent(java.lang.Object source)
          Create a GoEvent.
GoEvent(java.lang.Object source, int numberOfArguments)
          Create a GoEvent.
GoEvent(java.lang.Object source, int numberOfArguments, java.lang.String componentInstanceName)
          Create a GoEvent.
GoEvent(java.lang.Object source, int numberOfArguments, java.lang.String componentInstanceName, java.lang.String portInstanceName)
          Create a GoEvent.
GoEvent(java.lang.Object source, java.lang.String componentInstanceName)
          Create a GoEvent.
GoEvent(java.lang.Object source, java.lang.String componentInstanceName, java.lang.String portInstanceName)
          Create a GoEvent.
 
Method Summary
 java.lang.String getComponentInstanceName()
           
 int getNumberOfArguments()
           
 java.lang.String getPortInstanceName()
           
 
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

numberOfArguments

protected int numberOfArguments

componentInstanceName

protected java.lang.String componentInstanceName

portInstanceName

protected java.lang.String portInstanceName
Constructor Detail

GoEvent

public GoEvent(java.lang.Object source)
Create a GoEvent.

This event can be used to notify components that an entity wants to launch the application. A view entity might respond by launching the application

Parameters:
source - The entity that created this event.

GoEvent

public GoEvent(java.lang.Object source,
               int numberOfArguments)
Create a GoEvent.

This event can be used to notify components that an entity wants to launch the application. A view entity might respond by launching the application

Parameters:
source - The entity that created this event.
numberOfArguments - the number of arguments in the "go" command.

GoEvent

public GoEvent(java.lang.Object source,
               java.lang.String componentInstanceName)
Create a GoEvent.

This event can be used to notify components that an entity wants to launch the application. A view entity might respond by launching the application

Parameters:
source - The entity that created this event.
componentInstanceName - To call "go" on a specific component, pass in the name of the component. The instance name is usually the name of the component's java class (without the package name) concatenated with an index number. EXAMPLE: "StarterComponent0". Can be null.

GoEvent

public GoEvent(java.lang.Object source,
               int numberOfArguments,
               java.lang.String componentInstanceName)
Create a GoEvent.

This event can be used to notify components that an entity wants to launch the application. A view entity might respond by launching the application

Parameters:
source - The entity that created this event.
numberOfArguments - the number of arguments in the "go" command.
componentInstanceName - To call "go" on a specific component, pass in the name of the component. The instance name is usually the name of the component's java class (without the package name) concatenated with an index number. EXAMPLE: "StarterComponent0". Can be null.

GoEvent

public GoEvent(java.lang.Object source,
               java.lang.String componentInstanceName,
               java.lang.String portInstanceName)
Create a GoEvent.

This event can be used to notify components that an entity wants to launch the application. A view entity might respond by launching the application

Parameters:
source - The entity that created this event.
componentInstanceName - To call "go" on a specific component, pass in the name of the component. The instance name is usually the name of the component's java class (without the package name) concatenated with an index number. EXAMPLE: "StarterComponent0". Can be null.
portInstanceName - To call "go" on a specific "go" port on a specific component, pass in the name of the "go" port. Can be null.

GoEvent

public GoEvent(java.lang.Object source,
               int numberOfArguments,
               java.lang.String componentInstanceName,
               java.lang.String portInstanceName)
Create a GoEvent.

This event can be used to notify components that an entity wants to launch the application. A view entity might respond by launching the application

Parameters:
source - The entity that created this event.
numberOfArguments - the number of arguments in the "go" command.
componentInstanceName - To call "go" on a specific component, pass in the name of the component. The instance name is usually the name of the component's java class (without the package name) concatenated with an index number. EXAMPLE: "StarterComponent0". Can be null.
portInstanceName - To call "go" on a specific "go" port on a specific component, pass in the name of the "go" port. Can be null.
Method Detail

getNumberOfArguments

public int getNumberOfArguments()

getComponentInstanceName

public java.lang.String getComponentInstanceName()

getPortInstanceName

public java.lang.String getPortInstanceName()