de.innovationgate.wgpublisher.webtml.utils

Class TMLPageImpl

java.lang.Object

de.innovationgate.wgpublisher.webtml.utils.TMLPageImpl

All Implemented Interfaces:

TMLPage

public class TMLPageImpl
extends java.lang.Object
implements TMLPage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TMLPageImpl.OuterLayoutWriter

Constructor Summary

Constructors

Constructor and Description
TMLPageImpl(WGA wga)

Method Summary

Methods

Modifier and Type	Method and Description
PageConnection	getOrCreatePageConnection()
PageConnection	getPageConnection(boolean create)
java.lang.Object	getVar(java.lang.String name) Returns the value of a WebTML page variable
TMLPageWebSocket	getWebSocket()
boolean	hasVar(java.lang.String name) Determines if a WebTML page variable of the given name is available
boolean	isAvailable() Returns whether the WebTML page is actually available
boolean	prepareWebSocket()
void	processControllerResultObject(Design design, Context cx, Include.Status includeTag, TMLOptionPreserver preserver, TMLScript tmlscript, java.lang.Object result)
java.lang.Object	removeVar(java.lang.String name) Removes a WebTML page variable
void	render() Renders with all values default == renderDefault()
void	render(Design design) Renders the given WebTML module design und the current context and the current media key
void	render(Design design, Context cx) Renders the given WebTML module design und the given context and the current media key
void	render(Design design, java.lang.String mediaKey) Renders the given WebTML module design und the current context and the given media key
void	render(Design design, java.lang.String mediaKey, Context cx) Renders the given WebTML module design und the given context and the given media key
void	render(Design design, java.lang.String mediaKey, Context cx, java.util.Map<java.lang.Object,java.lang.Object> options) Renders the given WebTML module design und the given context and the given media key
void	render(java.util.HashMap<java.lang.String,java.lang.Object> map) Renders with parameters specified as map
void	renderDefault() Renders the default WebTML module for the current renderer under current context and media key
void	renderDefault(java.util.Map<java.lang.Object,java.lang.Object> options) Renders the default WebTML module for the current renderer under current context and media key
void	restorePageConnectionForAJAX(java.lang.String pageId)
void	setVar(java.lang.String name, java.lang.Object value) Writes a WebTML page variable, that will be available to the rest of the call
void	write(byte out) Writes the given byte to the output When this is the first output then the WebTML page output mode will be set to binary.
void	write(byte[] out) Writes the given bytes to the output When this is the first output then the WebTML page output mode will be set to binary.
void	write(java.io.InputStream in) Writes all data from the given input stream to the output When this is the first output then the WebTML page output mode will be set to binary.
void	write(java.io.Reader in) Writes all text from the given reader to the output
void	write(java.lang.String out) Writes the given string to the output

Methods inherited from class java.lang.Object

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

Constructor Detail

TMLPageImpl

public TMLPageImpl(WGA wga)

Method Detail

isAvailable

public boolean isAvailable()

Description copied from interface: TMLPage

Returns whether the WebTML page is actually available

Specified by:

isAvailable in interface TMLPage

prepareWebSocket

public boolean prepareWebSocket()
                         throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getOrCreatePageConnection

public PageConnection getOrCreatePageConnection()
                                         throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getPageConnection

public PageConnection getPageConnection(boolean create)
                                 throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

restorePageConnectionForAJAX

public void restorePageConnectionForAJAX(java.lang.String pageId)
                                  throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

render

public void render(Design design)
            throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Renders the given WebTML module design und the current context and the current media key

Specified by:

render in interface TMLPage

Parameters:

design - The design object pointing to the WebTML module to render

Throws:

de.innovationgate.webgate.api.WGException

render

public void render(Design design,
          Context cx)
            throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Renders the given WebTML module design und the given context and the current media key

Specified by:

render in interface TMLPage

Parameters:

design - The design object pointing to the WebTML module to render

cx - The WebTML context under which to render the WebTML module

Throws:

de.innovationgate.webgate.api.WGException

render

public void render(Design design,
          java.lang.String mediaKey)
            throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Renders the given WebTML module design und the current context and the given media key

Specified by:

render in interface TMLPage

Parameters:

design - The design object pointing to the WebTML module to render

mediaKey - The media key of the WebTML module to render

Throws:

de.innovationgate.webgate.api.WGException

renderDefault

public void renderDefault()
                   throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Renders the default WebTML module for the current renderer under current context and media key

Specified by:

renderDefault in interface TMLPage

Throws:

de.innovationgate.webgate.api.WGException

renderDefault

public void renderDefault(java.util.Map<java.lang.Object,java.lang.Object> options)
                   throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Renders the default WebTML module for the current renderer under current context and media key

Specified by:

renderDefault in interface TMLPage

Parameters:

options - WebTML options to set for the module to render

Throws:

de.innovationgate.webgate.api.WGException

render

public void render(Design design,
          java.lang.String mediaKey,
          Context cx)
            throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Renders the given WebTML module design und the given context and the given media key

Specified by:

render in interface TMLPage

Parameters:

design - The design object pointing to the WebTML module to render

mediaKey - The media key of the WebTML module to render

cx - The WebTML context under which to render the WebTML module

Throws:

de.innovationgate.webgate.api.WGException

render

public void render(Design design,
          java.lang.String mediaKey,
          Context cx,
          java.util.Map<java.lang.Object,java.lang.Object> options)
            throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Renders the given WebTML module design und the given context and the given media key

Specified by:

render in interface TMLPage

Parameters:

design - The design object pointing to the WebTML module to render

mediaKey - The media key of the WebTML module to render

cx - The WebTML context under which to render the WebTML module

options - WebTML options to set for the module to render

Throws:

de.innovationgate.webgate.api.WGException

processControllerResultObject

public void processControllerResultObject(Design design,
                                 Context cx,
                                 Include.Status includeTag,
                                 TMLOptionPreserver preserver,
                                 TMLScript tmlscript,
                                 java.lang.Object result)
                                   throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

write

public void write(java.lang.String out)
           throws de.innovationgate.webgate.api.WGException,
                  java.io.IOException

Description copied from interface: TMLPage

Writes the given string to the output

Specified by:

write in interface TMLPage

Parameters:

out - The string to write

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

write

public void write(byte[] out)
           throws de.innovationgate.webgate.api.WGException,
                  java.io.IOException

Description copied from interface: TMLPage

Writes the given bytes to the output When this is the first output then the WebTML page output mode will be set to binary. Following textual outputs will be ignored. This method is ineffective if the page already had textual output.

Specified by:

write in interface TMLPage

Parameters:

out - The bytes to write

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

write

public void write(byte out)
           throws de.innovationgate.webgate.api.WGException,
                  java.io.IOException

Description copied from interface: TMLPage

Writes the given byte to the output When this is the first output then the WebTML page output mode will be set to binary. Following textual outputs will be ignored. This method is ineffective if the page already had textual output.

Specified by:

write in interface TMLPage

Parameters:

out - The bytes to write

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

write

public void write(java.io.InputStream in)
           throws de.innovationgate.webgate.api.WGException,
                  java.io.IOException

Description copied from interface: TMLPage

Writes all data from the given input stream to the output When this is the first output then the WebTML page output mode will be set to binary. Following textual outputs will be ignored. This method is ineffective if the page already had textual output.

Specified by:

write in interface TMLPage

Parameters:

in - InputStream

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

write

public void write(java.io.Reader in)
           throws de.innovationgate.webgate.api.WGException,
                  java.io.IOException

Description copied from interface: TMLPage

Writes all text from the given reader to the output

Specified by:

write in interface TMLPage

Parameters:

in - Reader

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

setVar

public void setVar(java.lang.String name,
          java.lang.Object value)
            throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Writes a WebTML page variable, that will be available to the rest of the call

Specified by:

setVar in interface TMLPage

Parameters:

name - Name of the variable

value - Value of the variable

Throws:

de.innovationgate.webgate.api.WGException

hasVar

public boolean hasVar(java.lang.String name)
               throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Determines if a WebTML page variable of the given name is available

Specified by:

hasVar in interface TMLPage

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGException

getVar

public java.lang.Object getVar(java.lang.String name)
                        throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Returns the value of a WebTML page variable

Specified by:

getVar in interface TMLPage

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGException

removeVar

public java.lang.Object removeVar(java.lang.String name)
                           throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Removes a WebTML page variable

Specified by:

removeVar in interface TMLPage

Parameters:

name - Name of the variable

Returns:

The value stored in the removed variable

Throws:

de.innovationgate.webgate.api.WGException

render

public void render(java.util.HashMap<java.lang.String,java.lang.Object> map)
            throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Renders with parameters specified as map

Specified by:

render in interface TMLPage

Throws:

de.innovationgate.webgate.api.WGException

render

public void render()
            throws de.innovationgate.webgate.api.WGException

Description copied from interface: TMLPage

Renders with all values default == renderDefault()

Specified by:

render in interface TMLPage

Throws:

de.innovationgate.webgate.api.WGException

getWebSocket

public TMLPageWebSocket getWebSocket()
                              throws de.innovationgate.webgate.api.WGException

Specified by:

getWebSocket in interface TMLPage

Throws:

de.innovationgate.webgate.api.WGException