jeters.core
Class UIRequest_String

java.lang.Object
  extended by jeters.core.UIRequest
      extended by jeters.core.UIRequest_String

public class UIRequest_String
extends UIRequest

this subclass of UIRequest is used when a String is desired as the request's result.


Nested Class Summary
static class UIRequest_String.LayoutFlag
          enumeration of "layout flags", i.e. boolean pieces of information for the user interface which help to present the request in a nice way - but be careful: None of these is guaranteed to work with every UI class!
 
Nested classes/interfaces inherited from class jeters.core.UIRequest
UIRequest.Type
 
Field Summary
 java.util.EnumSet<UIRequest_String.LayoutFlag> layoutFlags
          an EnumSet containing all "layout flags" that will be applied for this request.
 java.lang.String startingValue
          the value that will initially be set and will be the result of the request unless the user changes it; can be null (no specified starting value).
 
Fields inherited from class jeters.core.UIRequest
help, label, name
 
Constructor Summary
UIRequest_String(java.lang.String name, java.lang.String label, java.lang.String help)
          constructor setting layoutFlags to null, startingValue remains null.
UIRequest_String(java.lang.String name, java.lang.String label, java.lang.String help, java.util.EnumSet<UIRequest_String.LayoutFlag> layoutFlags)
          simple "this.xyz = xyz"-constructor, layoutFlags is cloned, startingValue remains null.
UIRequest_String(java.lang.String name, java.lang.String label, java.lang.String help, java.lang.String startingValue)
          constructor setting layoutFlags to null.
UIRequest_String(java.lang.String name, java.lang.String label, java.lang.String help, java.lang.String startingValue, java.util.EnumSet<UIRequest_String.LayoutFlag> layoutFlags)
          simple "this.xyz = xyz"-constructor, layoutFlags is cloned.
UIRequest_String(java.lang.String name, java.lang.String label, java.lang.String help, java.lang.String startingValue, UIRequest_String.LayoutFlag firstLayoutFlag, UIRequest_String.LayoutFlag... moreLayoutFlags)
          constructor that takes any number of layout flags directly as parameters (using varargs).
UIRequest_String(java.lang.String name, java.lang.String label, java.lang.String help, UIRequest_String.LayoutFlag firstLayoutFlag, UIRequest_String.LayoutFlag... moreLayoutFlags)
          constructor that takes any number of layout flags directly as parameters (using varargs), startingValue remains null.
 
Method Summary
 UIRequest.Type getType()
          returns the type of the request: Request_String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

layoutFlags

public java.util.EnumSet<UIRequest_String.LayoutFlag> layoutFlags
an EnumSet containing all "layout flags" that will be applied for this request. Can be null, in which case no layout flags will be applied.


startingValue

public java.lang.String startingValue
the value that will initially be set and will be the result of the request unless the user changes it; can be null (no specified starting value).

Constructor Detail

UIRequest_String

public UIRequest_String(java.lang.String name,
                        java.lang.String label,
                        java.lang.String help,
                        java.lang.String startingValue,
                        java.util.EnumSet<UIRequest_String.LayoutFlag> layoutFlags)
simple "this.xyz = xyz"-constructor, layoutFlags is cloned. Using the varargs-constructor is generally more convenient.


UIRequest_String

public UIRequest_String(java.lang.String name,
                        java.lang.String label,
                        java.lang.String help,
                        java.util.EnumSet<UIRequest_String.LayoutFlag> layoutFlags)
simple "this.xyz = xyz"-constructor, layoutFlags is cloned, startingValue remains null. Using the varargs-constructor is generally more convenient.


UIRequest_String

public UIRequest_String(java.lang.String name,
                        java.lang.String label,
                        java.lang.String help,
                        java.lang.String startingValue,
                        UIRequest_String.LayoutFlag firstLayoutFlag,
                        UIRequest_String.LayoutFlag... moreLayoutFlags)
constructor that takes any number of layout flags directly as parameters (using varargs).


UIRequest_String

public UIRequest_String(java.lang.String name,
                        java.lang.String label,
                        java.lang.String help,
                        UIRequest_String.LayoutFlag firstLayoutFlag,
                        UIRequest_String.LayoutFlag... moreLayoutFlags)
constructor that takes any number of layout flags directly as parameters (using varargs), startingValue remains null.


UIRequest_String

public UIRequest_String(java.lang.String name,
                        java.lang.String label,
                        java.lang.String help,
                        java.lang.String startingValue)
constructor setting layoutFlags to null.


UIRequest_String

public UIRequest_String(java.lang.String name,
                        java.lang.String label,
                        java.lang.String help)
constructor setting layoutFlags to null, startingValue remains null.

Method Detail

getType

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

Specified by:
getType in class UIRequest