|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
gov.sandia.ccaffeine.dc.user_iface.MVC.event.ParamNumberRangeEvent
public class ParamNumberRangeEvent
Cca components contain ports. Some of the ports contain data fields. Some of the data fields restrict the range that a value can have. This event can be used to notify components that the cca server is sending the lowest value and the highest value that a data field value can have. A client entity might respond by verifying the end-user's input is within the allowed range.
Possible Scenario:
An end-user clicks on a blue port inside of a component
client sends "parameters" to server
serer- sends "ParamDialog" to client
client responds by creating an empty dialog box
server sends "ParamTab" to client
client responds by inserting a new tab in the dialog box
server sends "ParamField" to client
client responds by inserting a blank data line into the dialog box
server sends "ParamCurrent" to client
client responds by inserting the data's value into the dialog box
server sends "ParamHelp" to client
client responds by setting the text that is displayed if the help button is clicked
server sends "ParamPrompt" to client
client responds by displaying a prompt to the left of the data's value
server sends "ParamDefault" to client
client responds by setting the data's default value
server sends "ParamStringChoice" to client
client responds by setting an item in the value's choice box
server sends "ParamNumberRange" to client
client responds by setting the data value's range of allowed values
server sends "ParamEndDialog" to client
client responds by displaying the dialog box on the screen
Field Summary | |
---|---|
protected java.lang.String |
componentInstanceName
|
protected java.lang.String |
dataFieldMaxValue
|
protected java.lang.String |
dataFieldMinValue
|
protected java.lang.String |
dataFieldName
|
protected java.lang.String |
portInstanceName
|
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
ParamNumberRangeEvent(java.lang.Object source,
java.lang.String componentInstanceName,
java.lang.String portInstanceName,
java.lang.String dataFieldName,
java.lang.String dataFieldMinValue,
java.lang.String dataFieldMaxValue)
Create a ParamNumberRangeEvent. |
Method Summary | |
---|---|
java.lang.String |
getComponentInstanceName()
Get the name of the cca component that contains the port which contains the data field. |
java.lang.String |
getDataFieldMaxValue()
Get the largest value that can be inserted into the data field. |
java.lang.String |
getDataFieldMinValue()
Get the smallest value that can be inserted into the data field. |
java.lang.String |
getDataFieldName()
Get the name of a data field. |
java.lang.String |
GetPortInstanceName()
Get the name of the port that contains the data field. |
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 |
---|
protected java.lang.String componentInstanceName
protected java.lang.String portInstanceName
protected java.lang.String dataFieldName
protected java.lang.String dataFieldMinValue
protected java.lang.String dataFieldMaxValue
Constructor Detail |
---|
public ParamNumberRangeEvent(java.lang.Object source, java.lang.String componentInstanceName, java.lang.String portInstanceName, java.lang.String dataFieldName, java.lang.String dataFieldMinValue, java.lang.String dataFieldMaxValue)
Cca components contain ports. Some of the ports contain data fields. Some of the data fields restrict the range that a value can have. This event can be used to notify components that the cca server is sending the lowest value and the highest value that a data field value can have. A client entity might respond by verifying the end-user's input is within the allowed range.
source
- The entity that created this event.componentInstanceName
- The name of the cca component that contains
the port which contains the data field.
The name is usually the java class name of the component
(without the package name) concatenated with an index number.
Example: "TimeStamper0"portInstanceName
- The name of a port that contains the data field.
Example: "configure_port"dataFieldName
- The name of the data field.dataFieldMinValue
- The smallest value that can be inserted
into the data field.datafieldMaxValue
- The largest value that can be inserted
into the data field.Method Detail |
---|
public java.lang.String getComponentInstanceName()
The name is usually the java class name of the component (without the package name) concatenated with an index number. Example: "TimeStamper0"
public java.lang.String GetPortInstanceName()
public java.lang.String getDataFieldName()
public java.lang.String getDataFieldMinValue()
public java.lang.String getDataFieldMaxValue()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |