de.innovationgate.wga.server.api.tml

Interface TMLPage

All Known Implementing Classes:

TMLPageImpl

public interface TMLPage

Represents the WebTML page being currently rendered

Method Summary

Methods

Modifier and Type	Method and Description
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
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	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

Method Detail

isAvailable

boolean isAvailable()

Returns whether the WebTML page is actually available

render

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

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

Parameters:

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

Throws:

de.innovationgate.webgate.api.WGException

render

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

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

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

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

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

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

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

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

Parameters:

options - WebTML options to set for the module to render

Throws:

de.innovationgate.webgate.api.WGException

renderDefault

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

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

Throws:

de.innovationgate.webgate.api.WGException

render

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

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

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

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

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

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

render

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

Renders with parameters specified as map

Parameters:

map -

Throws:

de.innovationgate.webgate.api.WGException

render

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

Renders with all values default == renderDefault()

Throws:

de.innovationgate.webgate.api.WGException

write

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

Writes the given string to the output

Parameters:

out - The string to write

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

write

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

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.

Parameters:

out - The bytes to write

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

write

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

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.

Parameters:

in - InputStream

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

write

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

Writes all text from the given reader to the output

Parameters:

in - Reader

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

write

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

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.

Parameters:

out - The bytes to write

Throws:

de.innovationgate.webgate.api.WGException

java.io.IOException

setVar

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

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

Parameters:

name - Name of the variable

value - Value of the variable

Throws:

de.innovationgate.webgate.api.WGException

hasVar

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

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

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGException

getVar

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

Returns the value of a WebTML page variable

Parameters:

name - Name of the variable

Throws:

de.innovationgate.webgate.api.WGException

removeVar

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

Removes a WebTML page variable

Parameters:

name - Name of the variable

Returns:

The value stored in the removed variable

Throws:

de.innovationgate.webgate.api.WGException

getWebSocket

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

Throws:

de.innovationgate.webgate.api.WGException