Method Detail

• public ScreenRender baseLinkUrl(java.lang.String baseLinkUrl)

  If specified will be used as the base URL for links. If not specified the base URL will come from configuration on the webapp-list.webapp element and the servletContextPath.

  Returns:

  Reference to this ScreenRender for convenience

• public ScreenRender encoding(java.lang.String characterEncoding)

  The MIME character encoding for the text produced. Defaults to UTF-8. Must be a valid charset in the java.nio.charset.Charset class.

  Returns:

  Reference to this ScreenRender for convenience

• public ScreenRender lastStandalone(java.lang.String ls)

  Alternative to lastStandalone parameter and accepts same values (true, false, positive numbers to render that many from end of path (true = 1), negative to render not render that many from start of path

• public ScreenRender macroTemplate(java.lang.String macroTemplateLocation)

  Location of an FTL file with macros used to generate output. If not specified macro file from the screen configuration will be used depending on the outputType.

  Returns:

  Reference to this ScreenRender for convenience

• public void render(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

  Render a screen to a response using the current context. The screen will run in a sub-context so the original context will not be changed. The request will be used to check web settings such as secure connection, etc.

• public void render(java.io.Writer writer)

  Render a screen to a writer using the current context. The screen will run in a sub-context so the original context will not be changed.

• public void render(java.io.OutputStream os)

• public java.lang.String render()

  Render a screen and return the output as a String. Context semantics are the same as other render methods.

• public ScreenRender renderMode(java.lang.String outputType)

  The mode to render for (type of output). Used to select sub-elements of the render-mode element and the default macro template (if one is not specified for this render). If macroTemplateLocation is not specified is also used to determine the default macro template based on configuration.

  Parameters:

  outputType - Can be anything. Default supported values include: text, html, xsl-fo, xml, and csv.

  Returns:

  Reference to this ScreenRender for convenience

• public ScreenRender rootScreen(java.lang.String screenLocation)

  Location of the root XML Screen file to render.

  Returns:

  Reference to this ScreenRender for convenience

• public ScreenRender rootScreenFromHost(java.lang.String host)

  Determine location of the root XML Screen file to render based on a host name.

  Parameters:

  host - The host name, usually from ServletRequest.getServerName()

  Returns:

  Reference to this ScreenRender for convenience

• public ScreenRender saveHistory(boolean sh)

  By default history is not saved, set to true to save this screen render in the web session history

• public ScreenRender screenPath(java.util.List<java.lang.String> screenNameList)

  A list of screen names used to determine which screens to use when rendering subscreens.

  Returns:

  Reference to this ScreenRender for convenience

• public ScreenRender screenPath(java.lang.String path)

• public ScreenRender servletContextPath(java.lang.String scp)

  If baseLinkUrl is not specified then this is used along with the webapp-list.webapp configuration to create a base URL. If this is not specified and the active ExecutionContext has a WebFacade active then it will get it from that (meaning with a WebFacade this is not necessary to get a correct result).

  Parameters:

  scp - The servletContext.contextPath

  Returns:

  Reference to this ScreenRender for convenience

• public ScreenRender webappName(java.lang.String wan)

  The webapp name to use to look up webapp (webapp-list.webapp.@name) settings for URL building, request actions running, etc.

  Parameters:

  wan - The webapp name

  Returns:

  Reference to this ScreenRender for convenience