Package org.apache.ofbiz.widget.model

Class ModelScreen

java.lang.Object

org.apache.ofbiz.widget.model.ModelWidget

org.apache.ofbiz.widget.model.ModelScreen

All Implemented Interfaces:

Serializable

public class ModelScreen
extends ModelWidget

Widget Library - Screen model class

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ofbiz.widget.model.ModelWidget

ModelWidget.NamedBorderType

Field Summary

Fields inherited from class org.apache.ofbiz.widget.model.ModelWidget

ENABLE_BOUNDARY_COMMENTS_PARAM

Constructor Summary

Constructors

Constructor	Description
ModelScreen(Element screenElement, Map<String,ModelScreen> modelScreenMap, String sourceLocation)	XML Constructor

Method Summary

Modifier and Type	Method	Description
void	accept(ModelWidgetVisitor visitor)
Delegator	getDelegator(Map<String,Object> context)	Gets delegator.
LocalDispatcher	getDispatcher(Map<String,Object> context)	Gets dispatcher.
Map<String,ModelScreen>	getModelScreenMap()	Gets model screen map.
ModelScreenWidget.Section	getSection()	Gets section.
String	getSourceLocation()	Gets source location.
String	getTransactionTimeout()	Gets transaction timeout.
boolean	getUseCache()	Gets use cache.
boolean	getUseTransaction()	Gets use transaction.
void	renderScreenString(Appendable writer, Map<String,Object> context, ScreenStringRenderer screenStringRenderer)	Renders this screen to a String, i.e.

Methods inherited from class org.apache.ofbiz.widget.model.ModelWidget

getBoundaryCommentName, getName, getStartColumn, getStartLine, getSystemId, toString, widgetBoundaryCommentsEnabled, widgetNamedBorderType

Methods inherited from class java.lang.Object

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

Constructor Details

ModelScreen

public ModelScreen(Element screenElement,
 Map<String,ModelScreen> modelScreenMap,
 String sourceLocation)

XML Constructor

Method Details

accept

public void accept(ModelWidgetVisitor visitor)
            throws Exception

Specified by:

accept in class ModelWidget

Throws:

Exception

getTransactionTimeout

public String getTransactionTimeout()

Gets transaction timeout.

Returns:

the transaction timeout

getModelScreenMap

public Map<String,ModelScreen> getModelScreenMap()

Gets model screen map.

Returns:

the model screen map

getUseTransaction

public boolean getUseTransaction()

Gets use transaction.

Returns:

the use transaction

getUseCache

public boolean getUseCache()

Gets use cache.

Returns:

the use cache

getSection

public ModelScreenWidget.Section getSection()

Gets section.

Returns:

the section

getSourceLocation

public String getSourceLocation()

Gets source location.

Returns:

the source location

renderScreenString

public void renderScreenString(Appendable writer,
 Map<String,Object> context,
 ScreenStringRenderer screenStringRenderer)
                        throws ScreenRenderException

Renders this screen to a String, i.e. in a text format, as defined with the ScreenStringRenderer implementation.

Parameters:

writer - The Writer that the screen text will be written to

context - Map containing the screen context; the following are reserved words in this context: - parameters (contains any special initial parameters coming in) - userLogin (if a user is logged in) - autoUserLogin (if a user is automatically logged in, ie no password has been entered) - formStringRenderer - request, response, session, application (special case, only in HTML contexts, etc) - delegator, dispatcher, security - null (represents a null field value for entity operations) - sections (used for decorators to reference the sections to be decorated and render them)

screenStringRenderer - An implementation of the ScreenStringRenderer interface that is responsible for the actual text generation for different screen elements; implementing your own makes it possible to use the same screen definitions for many types of screen UIs

Throws:

ScreenRenderException

getDispatcher

public LocalDispatcher getDispatcher(Map<String,Object> context)

Gets dispatcher.

Parameters:

context - the context

Returns:

the dispatcher

getDelegator

public Delegator getDelegator(Map<String,Object> context)

Gets delegator.

Parameters:

context - the context

Returns:

the delegator