org.sandev.basics.structs
Class UIFormQueryStruct

java.lang.Object
  org.sandev.basics.structs.UIFormQueryStruct

Direct Known Subclasses:

UIFormQuery

public class UIFormQueryStruct
extends java.lang.Object

A query from the system to the user, used when a choice or acknowledgement is necessary. This is a query from system to user, in contrast to a query message, which is from user to system.

It is up to the display how the choices will be represented. If a UIQuery has two or fewer choices, the interface display may choose to present each option as a button. For example a "yes/no" question might result in "yes", "no" and "cancel" buttons for brevity. If there are several choices, then a more extensive selection approach, such as a drop-down box would be used.

The displayText may also be modified at runtime. So for example a value of "**LICENSE AGREEMENT**" might be replaced with significant verbiage at runtime. A known value may also be replaced with localized text.

Field Summary

protected java.lang.String	displayText The text that will be displayed to describe what is going on.
protected int	selectionIndex The default choice to initially display, and the selected option on return.
protected java.lang.String[]	selectionOptions The choices to select from.

Constructor Summary

UIFormQueryStruct()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

displayText

protected java.lang.String displayText

The text that will be displayed to describe what is going on.

declared default value: "please choose a value"
Length in characters, normal: 80 max: 4096

selectionOptions

protected java.lang.String[] selectionOptions

The choices to select from.

a dynamic selection display may be generated for this field.

selectionIndex

protected int selectionIndex

The default choice to initially display, and the selected option on return. This value is set to -1 if the user cancels the query.

declared default value: -1

Constructor Detail

UIFormQueryStruct

public UIFormQueryStruct()