org.sandev.ui.structs
Class ScreenStruct

java.lang.Object
  org.sandev.ui.structs.ScreenStruct

Direct Known Subclasses:

Screen

public class ScreenStruct
extends java.lang.Object

A screen is a single logical application display. This could be a GUI screen, a web page, a text screen display etc.

SandUI
Screen
Link
Action

A screen consists of a zero or more links (these are forms, hyperlinks etc) together with security and rendering template overrides. The default security and templates are inherited from the SandUI.

summary fields: name template security
This message has the following verb forms: update query collection

Field Summary

protected LinkStruct[]	links The links to display on this screen.
protected java.lang.String	name A unique name identifying this screen.
protected int	primaryFormIndex The index of the link which functions as the primary form for the screen.
protected int	security The display transmission security for this screen.
protected java.lang.String	template The name of the rendering template.

Constructor Summary

ScreenStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

A unique name identifying this screen.

the values for this field are unique.
declared invalid value: ""

template

protected java.lang.String template

The name of the rendering template. If specified, this overrides the SandUIStruct.defaultTemplate value. See the SandTransformer interface for more information on templates.

If security is set to REDIRECT, then this field holds the redirect location. The redirectvalue is application dependent.

declared invalid value: "INVALID_TEMPLATE_NAME"
Length in characters, normal: 20 max: 127

security

protected int security

The display transmission security for this screen. See SandUIStruct.defaultSecurity for details.

If set to REDIRECT, then the template field holds the redirect location.

declared default value: DEFAULT

enumerated constant values:

• DEFAULT("default") = 0
  
• SECURE("secure") = 1
  
• REDIRECT("redirect") = 2
  

declared invalid value: -1

links

protected LinkStruct[] links

The links to display on this screen. Links to things other than screens are handled in template transformation.

primaryFormIndex

protected int primaryFormIndex

The index of the link which functions as the primary form for the screen. When a specific instance is requested via the class/id parameters, the form at this index is used for display. If the value is negative, then specific instance requests are ignored. If the value is zero, and the first link is not a form, then the first form link is used for display.

declared default value: 0

Constructor Detail

ScreenStruct

public ScreenStruct()