org.sandev.ui.structs
Class LinkStruct

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

Direct Known Subclasses:

Link

public class LinkStruct

extends java.lang.Object

A link to a ScreenStruct reached either directly as a hyperlink or at the conclusion of processing a form.

SandUI
Screen
Link
Action

Links can be forms, hyperlinks, or empty placeholders for actions. Form links have state initialization associated with them. Unless overridden, links inherit their display templates from the screen they are part of.

summary fields: name linkType target

Field Summary

protected ActionStruct[]	actions Additional actions associated with this link.
protected org.sandev.basics.structs.UIFormInitializerStruct	formState Initial form state for this link.
protected int	linkType How this link should be displayed.
protected int	mode For prototyping purposes, a link can be optionally deactivated and rendered using placeholder text.
protected java.lang.String	name The name used to identify this link.
protected ActionStruct[]	tabs Tabs are custom actions that set the form contents.
protected java.lang.String	target The name of the screen to go to.
protected java.lang.String	template Specific template transformation for this link.
protected java.lang.String	title For form links, this is the title to be used in place of the name for display purposes.
protected java.lang.String	wireframeText Text to be displayed in place of the SANDForm rendering when this link is in wireframe mode.

Constructor Summary

LinkStruct()

Methods inherited from class java.lang.Object

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

Field Detail

linkType

protected int linkType

How this link should be displayed. With a text link, a single click takes you to the linked page. With a form link, you have the opportunity to work with data in a form first. An empty link is not displayed at all, and is typically used for global actions.

declared default value: TEXT

enumerated constant values:

• _TEXT = 1
  
• _FORM = 2
  
• _EMPTY = 3
  

declared invalid value: 0

name

protected java.lang.String name

The name used to identify this link. This is the name of the form link, or the label of the text link.

declared invalid value: ""

title

protected java.lang.String title

For form links, this is the title to be used in place of the name for display purposes. The variables $CLASS and $POSITION can be embedded in this text for substitution at runtime.

target

protected java.lang.String target

The name of the screen to go to. For a form, transition occurs at the successful conclusion of ACTION_SAVE. If unspecified, the target is understood to be the current screen.

reference to class: org.sandev.ui.structs.ScreenStruct.name

template

protected java.lang.String template

Specific template transformation for this link. Overrides the screen template specified.

formState

protected org.sandev.basics.structs.UIFormInitializerStruct formState

Initial form state for this link. See the UIFormInitializerStruct for details.

If this link is displayed as text, then form information is not required and will not be displayed.

tabs

protected ActionStruct[] tabs

Tabs are custom actions that set the form contents. They are typically used to shift the form into different modes and are usually displayed separately from the other custom actions to manage display complexity.

actions

protected ActionStruct[] actions

Additional actions associated with this link.

mode

protected int mode

For prototyping purposes, a link can be optionally deactivated and rendered using placeholder text. This is useful for initial specification purposes where a UI is run in a "canned demo" or "wireframe" mode. When in wireframe mode, the rendering uses the wireframeText contents rather than an actual SANDForm link.

Exactly how the wireframeText is rendered depends on the UIFormAdaptor implementation. See the wireframeText field comments for details.

declared default value: PRODUCTION

enumerated constant values:

• _PRODUCTION = 0
  
• _WIREFRAME = 1
  

declared invalid value: -1

wireframeText

protected java.lang.String wireframeText

Text to be displayed in place of the SANDForm rendering when this link is in wireframe mode. How this text is rendered depends on the UIFormAdaptor implementation. Plain ascii text will always be rendered regardless of technology, and line breaks will be preserved. Any other text formatting depends on the specific UIFormAdaptor in use.

declared invalid value: "INVALID_WIREFRAMETEXT"
Length in characters, normal: 512 max: 16384

Constructor Detail

LinkStruct

public LinkStruct()