Class ModelScreen

  • All Implemented Interfaces:
    java.io.Serializable

    public class ModelScreen
    extends ModelWidget
    Widget Library - Screen model class
    See Also:
    Serialized Form
    • Field Detail

      • module

        public static final java.lang.String module
    • Constructor Detail

      • ModelScreen

        public ModelScreen​(org.w3c.dom.Element screenElement,
                           java.util.Map<java.lang.String,​ModelScreen> modelScreenMap,
                           java.lang.String sourceLocation)
        XML Constructor
    • Method Detail

      • getTransactionTimeout

        public java.lang.String getTransactionTimeout()
      • getModelScreenMap

        public java.util.Map<java.lang.String,​ModelScreen> getModelScreenMap()
      • getUseTransaction

        public boolean getUseTransaction()
      • getUseCache

        public boolean getUseCache()
      • getSourceLocation

        public java.lang.String getSourceLocation()
      • 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 Delegator getDelegator​(java.util.Map<java.lang.String,​java.lang.Object> context)