org.sandev.basics.structs
Class UIFormInitializerStruct

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

Direct Known Subclasses:

UIFormInitializer

public class UIFormInitializerStruct

extends java.lang.Object

Describes the initial state of a form when presented in a user interface.

Field Summary

protected int	action The action taken by the user.
protected java.lang.String	currClass Provides a workspace for storing the current class name, so that the appropriate interface form can be instantiated.
protected SandInstanceMessage	currInst Holds the current instance information for the class being edited.
protected SandCollectionMessage	findCollection The results of the current find action.
protected int	findCollIndex The index of the first element we are currently displaying.
protected int	findCollMaxDisplay Holds the number of collection items to display.
protected java.lang.String[]	findKeys Holds the unique keys from previous dataset pages to support backward traversal.
protected SandQueryMessage	findQuery Holds the query that generated the collection we are working with.
protected int[]	modeStack The mode changes this form has gone through.
protected java.lang.String	outputText Text output to be displayed to the user.
protected java.lang.String[]	position The address of where we are in the overall message being edited.
protected SandInstanceMessage	rootMsg The root message we are working with.
protected UIFormQueryStruct	userQuery If specified, this query is displayed and processed while the form context information remains available.

Constructor Summary

UIFormInitializerStruct()

Methods inherited from class java.lang.Object

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

Field Detail

modeStack

protected int[] modeStack

The mode changes this form has gone through. There will always be at least one entry (the current mode) in this array, and there may be several levels depending on user actions.

enumerated constant values:

• _UNDEFINED = 0
  
• _LISTING = 1
  
• _UPDATING = 2
  
• _ADDING = 3
  
• _FINDING = 4
  

stack accessor methods are generated for this field.

position

protected java.lang.String[] position

The address of where we are in the overall message being edited. A single message may actually be represented over several forms as the user traverses over contained elements. The position keeps track of the traversal path.

In print form, the position is represented as dot access notation from the root message, using array access indicators for access into array element references. So for example:

Configuration.initialData[0]

would indicate that we are currently viewing the first initialData element of the Configuration instance.

stack accessor methods are generated for this field.

currClass

protected java.lang.String currClass

Provides a workspace for storing the current class name, so that the appropriate interface form can be instantiated.

currInst

protected SandInstanceMessage currInst

Holds the current instance information for the class being edited. Having the new information here, and the original information in the msg variable, allows for appropriate implementation of cancel/add/edit behavior.

rootMsg

protected SandInstanceMessage rootMsg

The root message we are working with. Typically this is a collection resulting from a query, or a struct message we are editing directly. The rootMsg and the currInst are typically the same when the form is first displayed to the user.

findCollection

protected SandCollectionMessage findCollection

The results of the current find action.

findCollIndex

protected int findCollIndex

The index of the first element we are currently displaying. This is initially zero, and increases by the number of items to display per page. Used only for display of collection objects.

declared default value: 0

findCollMaxDisplay

protected int findCollMaxDisplay

Holds the number of collection items to display. The user pages forward or backward through the collection viewing (at most) findCollMaxDisplay object instances each time.

declared default value: 20
range match expression: > 1

findQuery

protected SandQueryMessage findQuery

Holds the query that generated the collection we are working with.

findKeys

protected java.lang.String[] findKeys

Holds the unique keys from previous dataset pages to support backward traversal.

stack accessor methods are generated for this field.

action

protected int action

The action taken by the user. If defined when the form is created, the associated action is set as the default (if possible).

declared default value: UNDEFINED

enumerated constant values:

• _UNDEFINED = 0
  
• _INIT = 1
  
• _CUSTOM = 2
  
• _DRILLDOWN = 3
  
• _PARENT = 4
  
• _DEREF = 5
  
• _SELECT = 6
  
• _EDIT = 7
  
• _ADD = 8
  
• _FIND = 9
  
• _CANCEL = 10
  
• _SAVE = 11
  
• _PREVIOUS = 12
  
• _NEXT = 13
  
• _DELETE = 14
  
• _REMOVE = 15
  
• _NEW = 16
  
• _MOVEUP = 17
  
• _MOVEDOWN = 18
  
• _OK = 19
  
• _HELP = 20
  

userQuery

protected UIFormQueryStruct userQuery

If specified, this query is displayed and processed while the form context information remains available. This field should only be set when clarification or other user interaction is necessary. Use the outputText mechanism for informational statements, warnings, or errors in form processing.

outputText

protected java.lang.String outputText

Text output to be displayed to the user. This typically consists of warnings or errors that occur during normal form processing, such as violations of business logic enforced by back-end nodes.

declared default value: ""
declared invalid value: "UIFORM_INVALID_OUTPUTTEXT"
Length in characters, normal: 128 max: 1024

Constructor Detail

UIFormInitializerStruct

public UIFormInitializerStruct()