Choose (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.ui.Choose

```
public class Choose
extends java.lang.Object
```
Supports CHOOSE statement options.
It defines:
- ROW, HELP or set of FIELD, HELP
- AUTO-RETURN option
- GO-ON list
- KEYS string
- NO-ERROR string
- PAUSE value
Methods are defined to set and get all available options.
Author:

NVS

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`autoReturn` AUTO-RETURN option.
`private ColorSpec`	`color` Custom color.
`private boolean`	`defined` At least one CHOOSE item has been defined.
`private java.util.LinkedList<java.lang.String>`	`fieldHelps` Holds the HELP text for the FIELD items.
`private boolean`	`fieldMode` `true` if in FIELD mode, `false` for ROW mode.
`private java.util.LinkedList<GenericWidget>`	`fields` Holds the field widgets in the FIELD mode.
`private java.util.List<java.lang.String>`	`goOn` Holds the GO-ON keys.
`private Accessor`	`keysVar` Highlight and navigation variable.
`private boolean`	`noError` NO-ERROR option.
`private double`	`pause` CHOOSE timeout.
`private GenericWidget`	`row` Holds the field widget in the ROW mode.
`private java.lang.String`	`rowHelp` Holds the HELP text for the ROW item.

Constructor Summary

Constructors
Constructor and Description

Choose()
Default constructor.

Constructors
Constructor and Description
`Choose()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addField(GenericWidget field)` Adds a field to the CHOOSE instance.
`void`	`addField(GenericWidget[] fields)` Adds array of fields to the CHOOSE instance.
`void`	`addField(GenericWidget field, java.lang.String help)` Adds a field with its help text to the CHOOSE instance.
`void`	`addGoOn(java.lang.String key)` Adds a key to the list of GO-ON keys.
`void`	`addGoOn(java.lang.String[] key)` Adds a key to the list of GO-ON keys.
`void`	`addHelp(java.lang.String help, int num)` Add help string to last N items.
`void`	`addRow(GenericWidget row)` Sets the ROW mode and stores the row widget in the CHOOSE instance.
`void`	`addRow(GenericWidget row, java.lang.String help)` Sets the ROW mode and stores the row ID along with its help text in the CHOOSE instance.
`boolean`	`getAutoReturn()` Checks whether the AUTO-RETURN option was specified.
`ColorSpec`	`getColor()` Gets the custom color specification.
`ChooseData`	`getData()` Get `ChooseData` instance usable at client side.
`java.lang.String`	`getFieldHelp(int index)` Gets the custom help text for the indexed field.
`GenericWidget[]`	`getFields()` Gets the array of field widgets for the CHOOSE .
`int`	`getFieldsCount()` Gets the count of fields for the FIELD mode CHOOSE .
`java.lang.String[]`	`getFieldsHelp()` Gets the help texts for all fields.
`java.lang.String[]`	`getGoOn()` Gets all the GO-ON keys.
`java.lang.String`	`getGoOn(int index)` Gets the indexed GO-ON key as a key label or function.
`int`	`getGoOnCount()` Gets the count of GO-ON keys defined.
`java.lang.String`	`getKeys()` Gets the initial keystrokes if any are defined..
`Accessor`	`getKeysVar()` Get keys variable.
`boolean`	`getNoError()` Checks whether the NO-ERROR option was specified.
`double`	`getPause()` Gets the timeout value.
`GenericWidget`	`getRow()` Gets the row widget if the CHOOSE is for rows.
`java.lang.String`	`getRowHelp()` Gets the custom help text for the row.
`boolean`	`isFieldHelp(int index)` Checks whether the indexed field was specified with a custom help text.
`boolean`	`isRow()` Queries the ROW mode of CHOOSE .
`boolean`	`isRowHelp()` Checks whether the row was specified with a custom help text.
`void`	`setAutoReturn()` Turns on the AUTO-RETURN option.
`void`	`setColor(ColorSpec c)` Specifies a color for this CHOOSE instance.
`void`	`setKeys(BaseDataType keysVar)` Highlights the matching item in the CHOOSE and saves the user entered keystrokes.
`void`	`setNoError()` Turns on the NO-ERROR option.
`void`	`setPause(double seconds)` Specifies the CHOOSE timeout in seconds.
`void`	`setPause(NumberType seconds)` Specifies the CHOOSE timeout in seconds.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - defined
```
private boolean defined
```
    At least one CHOOSE item has been defined.
  - fieldMode
```
private boolean fieldMode
```
    true if in FIELD mode, false for ROW mode.
  - row
```
private GenericWidget row
```
    Holds the field widget in the ROW mode.
  - rowHelp
```
private java.lang.String rowHelp
```
    Holds the HELP text for the ROW item.
  - fields
```
private java.util.LinkedList<GenericWidget> fields
```
    Holds the field widgets in the FIELD mode.
  - fieldHelps
```
private java.util.LinkedList<java.lang.String> fieldHelps
```
    Holds the HELP text for the FIELD items.
  - autoReturn
```
private boolean autoReturn
```
    AUTO-RETURN option.
  - color
```
private ColorSpec color
```
    Custom color.
  - goOn
```
private java.util.List<java.lang.String> goOn
```
    Holds the GO-ON keys.
  - keysVar
```
private Accessor keysVar
```
    Highlight and navigation variable.
  - noError
```
private boolean noError
```
    NO-ERROR option.
  - pause
```
private double pause
```
    CHOOSE timeout.
- Constructor Detail
  - Choose
```
public Choose()
```
    Default constructor.
- Method Detail
  - addRow
```
public void addRow(GenericWidget row)
```
    Sets the ROW mode and stores the row widget in the CHOOSE instance.
    
    Parameters:
    
    row - row widget to use in choose
  - addRow
```
public void addRow(GenericWidget row,
                   java.lang.String help)
```
    Sets the ROW mode and stores the row ID along with its help text in the CHOOSE instance.
    
    Parameters:
    
    row - row widget to use in choose
    
    help - associated help text
  - addField
```
public void addField(GenericWidget field)
```
    Adds a field to the CHOOSE instance.
    
    Parameters:
    
    field - widget within the frame
  - addField
```
public void addField(GenericWidget[] fields)
```
    Adds array of fields to the CHOOSE instance.
    
    Parameters:
    
    fields - Array of widgets within the frame
  - addField
```
public void addField(GenericWidget field,
                     java.lang.String help)
```
    Adds a field with its help text to the CHOOSE instance.
    
    Parameters:
    
    field - widget within the frame
    
    help - associated help text
  - addHelp
```
public void addHelp(java.lang.String help,
                    int num)
```
    Add help string to last N items.
    
    Parameters:
    
    help - Help string.
    
    num - Number of widgets.
  - setAutoReturn
```
public void setAutoReturn()
```
    Turns on the AUTO-RETURN option.
  - setColor
```
public void setColor(ColorSpec c)
```
    Specifies a color for this CHOOSE instance.
    
    Parameters:
    
    c - color specification instance
  - addGoOn
```
public void addGoOn(java.lang.String[] key)
```
    Adds a key to the list of GO-ON keys.
    
    Parameters:
    
    key - array of key labels
  - addGoOn
```
public void addGoOn(java.lang.String key)
```
    Adds a key to the list of GO-ON keys.
    
    Parameters:
    
    key - key label
  - setKeys
```
public void setKeys(BaseDataType keysVar)
```
    Highlights the matching item in the CHOOSE and saves the user entered keystrokes.
    
    Parameters:
    
    keysVar - Accessor for variable that contains keystrokes for an item and receives keystrokes (up to 40) while the user navigates
  - setNoError
```
public void setNoError()
```
    Turns on the NO-ERROR option.
  - setPause
```
public void setPause(NumberType seconds)
```
    Specifies the CHOOSE timeout in seconds.
    
    Parameters:
    
    seconds - maximum time between keystrokes
  - setPause
```
public void setPause(double seconds)
```
    Specifies the CHOOSE timeout in seconds.
    
    Parameters:
    
    seconds - maximum time between keystrokes
  - isRow
```
public boolean isRow()
```
    Queries the ROW mode of CHOOSE .
    
    Returns:
    
    true if the CHOOSE specifies rows, otherwise false
  - getRow
```
public GenericWidget getRow()
```
    Gets the row widget if the CHOOSE is for rows.
    
    Returns:
    
    row widget or null if this CHOOSE is for fields.
  - isRowHelp
```
public boolean isRowHelp()
```
    Checks whether the row was specified with a custom help text.
    
    Returns:
    
    true if there was a custom help text specified
  - getRowHelp
```
public java.lang.String getRowHelp()
```
    Gets the custom help text for the row.
    
    Returns:
    
    custom help text or null
  - getFieldsCount
```
public int getFieldsCount()
```
    Gets the count of fields for the FIELD mode CHOOSE .
    
    Returns:
    
    number of fields defined or 0
  - getFields
```
public GenericWidget[] getFields()
```
    Gets the array of field widgets for the CHOOSE .
    
    Returns:
    
    array of field widgets
  - isFieldHelp
```
public boolean isFieldHelp(int index)
```
    Checks whether the indexed field was specified with a custom help text.
    
    Parameters:
    
    index - index of the field being checked
    
    Returns:
    
    true if there was a custom help text specified
  - getFieldHelp
```
public java.lang.String getFieldHelp(int index)
```
    Gets the custom help text for the indexed field.
    
    Parameters:
    
    index - index of the field being queried
    
    Returns:
    
    custom help text or null
  - getFieldsHelp
```
public java.lang.String[] getFieldsHelp()
```
    Gets the help texts for all fields.
    
    Returns:
    
    array of custom help texts or null if in ROW mode.
  - getAutoReturn
```
public boolean getAutoReturn()
```
    Checks whether the AUTO-RETURN option was specified.
    
    Returns:
    
    true if AUTO-RETURN option was set
  - getColor
```
public ColorSpec getColor()
```
    Gets the custom color specification.
    
    Returns:
    
    ColorSpec for the custom color definition or null if it wasn't specified.
  - getGoOnCount
```
public int getGoOnCount()
```
    Gets the count of GO-ON keys defined.
    
    Returns:
    
    number of GO-ON keys or 0
  - getGoOn
```
public java.lang.String getGoOn(int index)
```
    Gets the indexed GO-ON key as a key label or function.
    
    Parameters:
    
    index - index of the field being queried
    
    Returns:
    
    a string which may be key label or key function, or null if the index is out of range.
  - getGoOn
```
public java.lang.String[] getGoOn()
```
    Gets all the GO-ON keys.
    
    Returns:
    
    array of strings which are key label or key function, possibly empty.
  - getKeys
```
public java.lang.String getKeys()
```
    Gets the initial keystrokes if any are defined..
    
    Returns:
    
    a string of keystrokes or null
  - getKeysVar
```
public Accessor getKeysVar()
```
    Get keys variable.
    
    Returns:
    
    keys variable.
  - getNoError
```
public boolean getNoError()
```
    Checks whether the NO-ERROR option was specified.
    
    Returns:
    
    true if NO-ERROR option was set
  - getPause
```
public double getPause()
```
    Gets the timeout value.
    
    Returns:
    
    timeout value in seconds or -1 if not set.
  - getData
```
public ChooseData getData()
```
    Get ChooseData instance usable at client side.
    
    Returns:
    
    instance of ChooseData

Class Choose

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defined

fieldMode

row

rowHelp

fields

fieldHelps

autoReturn

color

goOn

keysVar

noError

pause

Constructor Detail

Choose

Method Detail

addRow

addRow

addField

addField

addField

addHelp

setAutoReturn

setColor

addGoOn

addGoOn

setKeys

setNoError

setPause

setPause

isRow

getRow

isRowHelp

getRowHelp

getFieldsCount

getFields

isFieldHelp

getFieldHelp

getFieldsHelp

getAutoReturn

getColor

getGoOnCount

getGoOn

getGoOn

getKeys

getKeysVar

getNoError

getPause

getData