public interface TMLPage
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
|
boolean isAvailable()
void render(Design design) throws de.innovationgate.webgate.api.WGException
design
- The design object pointing to the WebTML module to renderde.innovationgate.webgate.api.WGException
void render(Design design, Context cx) throws de.innovationgate.webgate.api.WGException
design
- The design object pointing to the WebTML module to rendercx
- The WebTML context under which to render the WebTML modulede.innovationgate.webgate.api.WGException
void render(Design design, java.lang.String mediaKey) throws de.innovationgate.webgate.api.WGException
design
- The design object pointing to the WebTML module to rendermediaKey
- The media key of the WebTML module to renderde.innovationgate.webgate.api.WGException
void renderDefault(java.util.Map<java.lang.Object,java.lang.Object> options) throws de.innovationgate.webgate.api.WGException
options
- WebTML options to set for the module to renderde.innovationgate.webgate.api.WGException
void renderDefault() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
void render(Design design, java.lang.String mediaKey, Context cx) throws de.innovationgate.webgate.api.WGException
design
- The design object pointing to the WebTML module to rendermediaKey
- The media key of the WebTML module to rendercx
- The WebTML context under which to render the WebTML modulede.innovationgate.webgate.api.WGException
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
design
- The design object pointing to the WebTML module to rendermediaKey
- The media key of the WebTML module to rendercx
- The WebTML context under which to render the WebTML moduleoptions
- WebTML options to set for the module to renderde.innovationgate.webgate.api.WGException
void render(java.util.HashMap<java.lang.String,java.lang.Object> map) throws de.innovationgate.webgate.api.WGException
map
- de.innovationgate.webgate.api.WGException
void render() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException
void write(java.lang.String out) throws de.innovationgate.webgate.api.WGException, java.io.IOException
out
- The string to writede.innovationgate.webgate.api.WGException
java.io.IOException
void write(byte[] out) throws de.innovationgate.webgate.api.WGException, java.io.IOException
out
- The bytes to writede.innovationgate.webgate.api.WGException
java.io.IOException
void write(java.io.InputStream in) throws de.innovationgate.webgate.api.WGException, java.io.IOException
in
- InputStreamde.innovationgate.webgate.api.WGException
java.io.IOException
void write(java.io.Reader in) throws de.innovationgate.webgate.api.WGException, java.io.IOException
in
- Readerde.innovationgate.webgate.api.WGException
java.io.IOException
void write(byte out) throws de.innovationgate.webgate.api.WGException, java.io.IOException
out
- The bytes to writede.innovationgate.webgate.api.WGException
java.io.IOException
void setVar(java.lang.String name, java.lang.Object value) throws de.innovationgate.webgate.api.WGException
name
- Name of the variablevalue
- Value of the variablede.innovationgate.webgate.api.WGException
boolean hasVar(java.lang.String name) throws de.innovationgate.webgate.api.WGException
name
- Name of the variablede.innovationgate.webgate.api.WGException
java.lang.Object getVar(java.lang.String name) throws de.innovationgate.webgate.api.WGException
name
- Name of the variablede.innovationgate.webgate.api.WGException
java.lang.Object removeVar(java.lang.String name) throws de.innovationgate.webgate.api.WGException
name
- Name of the variablede.innovationgate.webgate.api.WGException
TMLPageWebSocket getWebSocket() throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException