jeters.core
Enum UIRequest_String.LayoutFlag

java.lang.Object
  extended by java.lang.Enum<UIRequest_String.LayoutFlag>
      extended by jeters.core.UIRequest_String.LayoutFlag
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<UIRequest_String.LayoutFlag>
Enclosing class:
UIRequest_String

public static enum UIRequest_String.LayoutFlag
extends java.lang.Enum<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! They are recommendations only.


Enum Constant Summary
hideInput
          tells the user interface to hide the input (e.g. for passwords).
lineWrap
          allows to begin a new line if the text is too long to fit in the textbox.
multipleLines
          tells the user interface that the result is expected to be a string with newlines in it rather than a single line only.
readPath
          tells the user interface that the String should be a file path for reading.
writePath
          tells the user interface that the String should be a file path for writing.
 
Method Summary
static UIRequest_String.LayoutFlag valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static UIRequest_String.LayoutFlag[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

hideInput

public static final UIRequest_String.LayoutFlag hideInput
tells the user interface to hide the input (e.g. for passwords).


multipleLines

public static final UIRequest_String.LayoutFlag multipleLines
tells the user interface that the result is expected to be a string with newlines in it rather than a single line only.


lineWrap

public static final UIRequest_String.LayoutFlag lineWrap
allows to begin a new line if the text is too long to fit in the textbox. Only makes sense together with multipleLines.


readPath

public static final UIRequest_String.LayoutFlag readPath
tells the user interface that the String should be a file path for reading. If set, the UI might present a special dialog to the user.


writePath

public static final UIRequest_String.LayoutFlag writePath
tells the user interface that the String should be a file path for writing. If set, the UI might present a special dialog to the user.

Method Detail

values

public static UIRequest_String.LayoutFlag[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (UIRequest_String.LayoutFlag c : UIRequest_String.LayoutFlag.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static UIRequest_String.LayoutFlag valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null