org.sandev.ui.util
Interface UIScreenAdaptor

All Superinterfaces:

org.sandev.basics.util.UIFormAdaptor

public interface UIScreenAdaptor

extends org.sandev.basics.util.UIFormAdaptor

Renders/reconstructs a Screen to/from a user interface. This is an extension of a UIFormAdaptor that adds methods for Screen messages.

Usage notes:

1. The IDLookup and NameLookup, are both part of the UIFormOwner interface (along with AuthUserLookup).
2. The caller is expected to access the AuthUser via ID after initial lookup, to allow for fast cache retrieval.
3. The AuthFilter can be retrieved from the UIFormOwner, which is also responsible for caching.

Implementation notes:

1. Although the UIScreenAdaptor interface extends the UIFormAdaptor interface, a UIScreenAdaptor implementor may choose to aggregate a UIFormAdaptor implementation rather than extend. Although the UIScreenAdaptor and UIFormAdaptor are closely associated, an aggregated implementation may provide more change flexibility. Either approach is equally valid.
2. It is typical for an implementation to set the formState in a FORM Link to be a UIFormContext object for ease of processing.

Field Summary

Fields inherited from interface org.sandev.basics.util.UIFormAdaptor

SANDUILINK_REGEXP

Method Summary

void	dumpScreen(org.sandev.basics.util.UIRenderOutput uiro, Screen screen, SandUI ui, org.sandev.basics.util.UIFormOwner owner, org.sandev.basics.util.AuthUser user, org.sandev.basics.util.AuthFilter filter, org.sandev.basics.util.UserWorkLog uwl, java.util.Locale locale) Given a output rendering context, render the given Screen for display.
Screen	getScreen(org.sandev.basics.util.UIRenderInput uiri, SandUI ui, org.sandev.basics.util.UIFormOwner owner, org.sandev.basics.util.AuthUser user, org.sandev.basics.util.UserWorkLog uwl, java.util.Locale locale) Given a map of our current parameter names and values, reconstruct the Screen object and return it.

Methods inherited from interface org.sandev.basics.util.UIFormAdaptor

allowEditReadOnly, dumpFormOutput, dumpPageFooter, dumpPageHeader, getActionSupportMap, getActionTextMap, getDefaultActionSupportMap, getDefaultActionTextMap, getFormContext, getHiddenFieldValue, getInstanceClassEnumerator, getUIRenderInput, getUIRenderOutputDirect, getUIRenderOutputStream, getUIRenderOutputString, newInstanceMessage, setActionSupportMap, setActionTextMap, setAllowEditReadOnly, setHiddenFieldValue

Method Detail

getScreen

public Screen getScreen(org.sandev.basics.util.UIRenderInput uiri,
                        SandUI ui,
                        org.sandev.basics.util.UIFormOwner owner,
                        org.sandev.basics.util.AuthUser user,
                        org.sandev.basics.util.UserWorkLog uwl,
                        java.util.Locale locale)
                 throws UIScreenAdaptorException

Given a map of our current parameter names and values, reconstruct the Screen object and return it. Note that by convention the formState within a FORM Link is typically maintained as a UIFormContext instance at runtime.

The UIFormOwner and AuthUser are required for handling user requests and setup actions.

Throws:

UIScreenAdaptorException

dumpScreen

public void dumpScreen(org.sandev.basics.util.UIRenderOutput uiro,
                       Screen screen,
                       SandUI ui,
                       org.sandev.basics.util.UIFormOwner owner,
                       org.sandev.basics.util.AuthUser user,
                       org.sandev.basics.util.AuthFilter filter,
                       org.sandev.basics.util.UserWorkLog uwl,
                       java.util.Locale locale)
                throws UIScreenAdaptorException

Given a output rendering context, render the given Screen for display.

Throws:

UIScreenAdaptorException