org.ofbiz.widget.screen
Class ModelScreen

java.lang.Object
  org.ofbiz.widget.ModelWidget
      org.ofbiz.widget.screen.ModelScreen

All Implemented Interfaces:

java.io.Serializable

public class ModelScreen
extends ModelWidget
implements java.io.Serializable

Widget Library - Screen model class

See Also:

Serialized Form

Field Summary

protected java.util.Map<java.lang.String,ModelScreen>	modelScreenMap
static java.lang.String	module
protected ModelScreenWidget.Section	section
protected java.lang.String	sourceLocation
protected FlexibleStringExpander	transactionTimeoutExdr
protected boolean	useCache

Fields inherited from class org.ofbiz.widget.ModelWidget

enableBoundaryCommentsParam, enableWidgetBoundaryComments, name

Constructor Summary

protected	ModelScreen() Default Constructor
	ModelScreen(org.w3c.dom.Element screenElement, java.util.Map<java.lang.String,ModelScreen> modelScreenMap, java.lang.String sourceLocation) XML Constructor

Method Summary

protected static void	findEntityNamesUsedInWidget(ModelScreenWidget currentWidget, java.util.Set<java.lang.String> allEntityNamesUsed)
protected static void	findFormNamesIncludedInWidget(ModelScreenWidget currentWidget, java.util.Set<java.lang.String> allFormNamesIncluded)
protected static void	findRequestNamesLinkedtoInWidget(ModelScreenWidget currentWidget, java.util.Set<java.lang.String> allRequestNamesIncluded)
protected static void	findServiceNamesUsedInWidget(ModelScreenWidget currentWidget, java.util.Set<java.lang.String> allServiceNamesUsed)
java.util.Set<java.lang.String>	getAllEntityNamesUsed()
java.util.Set<java.lang.String>	getAllFormNamesIncluded()
java.util.Set<java.lang.String>	getAllRequestsLocationAndUri()
java.util.Set<java.lang.String>	getAllServiceNamesUsed()
GenericDelegator	getDelegator(java.util.Map<java.lang.String,java.lang.Object> context)
LocalDispatcher	getDispatcher(java.util.Map<java.lang.String,java.lang.Object> context)
java.lang.String	getSourceLocation()
void	renderScreenString(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, ScreenStringRenderer screenStringRenderer) Renders this screen to a String, i.e.
void	writeError(java.lang.Appendable writer, java.lang.Exception e)

Methods inherited from class org.ofbiz.widget.ModelWidget

boundaryCommentsEnabled, getBoundaryCommentName, getName, getPaginatorNumber, incrementPaginatorNumber, setWidgetBoundaryComments, widgetBoundaryCommentsEnabled

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final java.lang.String module

sourceLocation

protected java.lang.String sourceLocation

transactionTimeoutExdr

protected FlexibleStringExpander transactionTimeoutExdr

modelScreenMap

protected java.util.Map<java.lang.String,ModelScreen> modelScreenMap

useCache

protected boolean useCache

section

protected ModelScreenWidget.Section section

Constructor Detail

ModelScreen

protected ModelScreen()

Default Constructor

ModelScreen

public ModelScreen(org.w3c.dom.Element screenElement,
                   java.util.Map<java.lang.String,ModelScreen> modelScreenMap,
                   java.lang.String sourceLocation)

XML Constructor

Method Detail

getSourceLocation

public java.lang.String getSourceLocation()

getAllServiceNamesUsed

public java.util.Set<java.lang.String> getAllServiceNamesUsed()

findServiceNamesUsedInWidget

protected static void findServiceNamesUsedInWidget(ModelScreenWidget currentWidget,
                                                   java.util.Set<java.lang.String> allServiceNamesUsed)

getAllEntityNamesUsed

public java.util.Set<java.lang.String> getAllEntityNamesUsed()

findEntityNamesUsedInWidget

protected static void findEntityNamesUsedInWidget(ModelScreenWidget currentWidget,
                                                  java.util.Set<java.lang.String> allEntityNamesUsed)

getAllFormNamesIncluded

public java.util.Set<java.lang.String> getAllFormNamesIncluded()

findFormNamesIncludedInWidget

protected static void findFormNamesIncludedInWidget(ModelScreenWidget currentWidget,
                                                    java.util.Set<java.lang.String> allFormNamesIncluded)

getAllRequestsLocationAndUri

public java.util.Set<java.lang.String> getAllRequestsLocationAndUri()
                                                             throws GeneralException

Throws:

GeneralException

findRequestNamesLinkedtoInWidget

protected static void findRequestNamesLinkedtoInWidget(ModelScreenWidget currentWidget,
                                                       java.util.Set<java.lang.String> allRequestNamesIncluded)
                                                throws GeneralException

Throws:

GeneralException

renderScreenString

public void renderScreenString(java.lang.Appendable writer,
                               java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.Object> context)

getDelegator

public GenericDelegator getDelegator(java.util.Map<java.lang.String,java.lang.Object> context)

writeError

public void writeError(java.lang.Appendable writer,
                       java.lang.Exception e)
                throws ScreenRenderException

Throws:

ScreenRenderException