jeters.core
Class UIRequest

java.lang.Object
  extended by jeters.core.UIRequest
Direct Known Subclasses:
UIRequest_Boolean, UIRequest_Float, UIRequest_Integer, UIRequest_Output, UIRequest_Selection, UIRequest_String

public abstract class UIRequest
extends java.lang.Object

a class for passing requests to the user interface, so the user can make decisions, change settings etc. It is abstract, the subclasses will be used for the requests.


Nested Class Summary
static class UIRequest.Type
          enumeration of possible request types.
 
Field Summary
 java.lang.String help
          text meant to explain the user in detail what effects his choice will have.
 java.lang.String label
          text meant to be shown to the user, indicating the meaning of the request.
 java.lang.String name
          a name identifying the request, will be the string id in the resulting NamedDataSet; if null, this UIRequest is output-only.
 
Method Summary
abstract  UIRequest.Type getType()
          returns the type of the request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

public java.lang.String name
a name identifying the request, will be the string id in the resulting NamedDataSet; if null, this UIRequest is output-only.


label

public java.lang.String label
text meant to be shown to the user, indicating the meaning of the request. Example: "Enter your name:"


help

public java.lang.String help
text meant to explain the user in detail what effects his choice will have. In a GUI, this might be shown as a tooltip.

Method Detail

getType

public abstract UIRequest.Type getType()
returns the type of the request.