de.innovationgate.wgpublisher.webtml

Class Base

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

de.innovationgate.wgpublisher.webtml.Base

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.DynamicAttributes, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

ActionBase, Between, Body, CaseElse, Collection, Comment, ConditionBase, CreateButton, CreatePage, Disable, Element, Else, Evaluate, ForEach, FormBase, FormMessages, GroupChange, Htmlhead, Image, Include, Label, Level, Link, MetaData, Option, Param, Query, Range, Root, Select, Then, URLParam, Validate, Warnings

public abstract class Base
extends javax.servlet.jsp.tagext.BodyTagSupport
implements javax.servlet.jsp.tagext.DynamicAttributes

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Base.DynamicAttribute
static class	Base.DynamicAttributeValueType
class	Base.MixedAttributeResolver
static interface	Base.ResultInterceptor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AJAX_MODE_NO_PORTLET_REFRESH
static java.lang.String	ATTRIB_INCLUDEPARENT
static java.text.DateFormat	DEBUG_TIMESTAMP_FORMAT
static java.lang.String	OPTION_CURRENT_MEDIAKEY
static java.lang.String	OPTION_DEFAULT_LABELCONTAINER
static java.lang.String	OPTION_DEFAULT_LABELFILE
static java.lang.String	OPTION_DEFAULT_XPLANGUAGE
static java.lang.String	OPTION_DESIGNDB
static java.lang.String	OPTION_IMAGE_DERIVATES
static java.lang.String	OPTION_INCLUDELEVEL
static java.lang.String	OPTION_INNER_LAYOUT
static java.lang.String	OPTION_ITEM_MAPPINGS
static java.lang.String	OPTION_LINK_ACTION
static java.lang.String	OPTION_LINK_MEDIUM
static java.lang.String	OPTION_META_MAPPINGS
static java.lang.String	OPTION_MODULE_CONTROLLER
static java.lang.String	OPTION_PORTLET_EVENT_STARTINDEX
static java.lang.String	OPTION_PORTLET_NAMESPACE
static java.lang.String	OPTION_RESULT_INTERCEPTORS
static java.lang.String	OPTION_TMLMODULE_MEDIAKEY
static java.lang.String	OPTION_TMLMODULE_NAME
static java.lang.String	OPTION_WEBTML_SCOPE
static java.lang.String	SYSTEMOPTION_PREFIX
static java.lang.String	TAGVALUE_DYNAMIC_ATTRIBUTES
static java.lang.String	TAGVALUE_STATUS
static java.util.Set<java.lang.String>	UNRECOVERABLE_OPTIONS
static java.lang.String	URL_VERSION_PARAMETER

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
Base()

Method Summary

Methods

Modifier and Type	Method and Description
void	addResultInterceptor(Base.ResultInterceptor ic)
void	addWarning(java.lang.String message)
void	addWarning(java.lang.String message, boolean cancelTag)
void	buildHTMLHead(boolean metaOutput, java.lang.String scripts)
java.util.Map<java.lang.String,java.lang.Object>	buildNamedActionParameters(boolean serializable)
void	clearWarnings()
void	defaultSetDynamicAttribute(java.util.List<java.lang.String> prefixes, java.lang.String uri, java.lang.String localName, java.lang.Object value)
int	doAfterBody()
int	doEndTag()
int	doStartTag()
java.lang.String	getAppendvar()
boolean	getCancelTag() Gets the cancelTag
TMLContext	getChildTagContext() Gets the childTmlContext
java.lang.String	getContext() Gets the context
WGACore	getCore()
org.dom4j.Element	getDebugNode()
java.lang.String	getDefaultExpressionLanguage()
java.lang.String	getDesignDBKey()
WGPDispatcher	getDispatcher()
java.lang.String	getDivider() Gets the divider
java.lang.String	getEncode() Gets the encode
java.lang.String	getFormat() Gets the format
java.lang.String	getId() Gets the id
java.lang.String	getIf()
int	getIteration() Gets the iteration
org.dom4j.Element	getIterationDebugNode()
java.lang.Integer	getLevel()
TMLContext	getMainContext()
java.lang.String	getMimeType()
java.lang.Object	getOption(java.lang.String optionName)
java.lang.String	getOutput() Gets the output
java.io.OutputStream	getOutputStream()
javax.servlet.jsp.PageContext	getPageContext()
BaseTagStatus	getParentTag()
java.lang.String	getPrefix()
java.lang.String	getPrivatecontext() Gets the privateContext
java.lang.String	getPsessionvar()
java.lang.String	getPvar()
javax.servlet.http.HttpServletResponse	getResponse()
java.lang.String	getResultString()
java.lang.String	getResultString(boolean includeFormatting)
java.lang.String	getSessionvar() Returns the sessionvar.
java.lang.String	getSourceline()
BaseTagStatus	getStatus()
java.lang.String	getSuffix()
java.lang.String	getTagDescription()
java.lang.String	getTagName()
BaseTagStatus	getTagStatusById(java.lang.String id)
BaseTagStatus	getTagStatusById(java.lang.String id, java.lang.Class<?> tagClass)
TMLContext	getTMLContext() Gets the tagContext
TMLContext	getTMLContextForDocument(de.innovationgate.webgate.api.WGDocument doc)
java.lang.String	getTrim()
java.lang.String	getUid()
java.lang.String	getUnless()
TMLUserProfile	getUserProfile()
TMLUserProfile	getUserProfile(de.innovationgate.webgate.api.WGDatabase db)
java.lang.String	getVar() Gets the var
java.lang.String	getWGPPath()
java.lang.String	includeScript(java.lang.String script)
boolean	isAjaxRequest()
boolean	isCollectionsShowReleasedOnly()
boolean	isEvalBody() Gets the evalBody
boolean	isKeepParamsOnAJAX() Determines if AJAX action URLs are to keep URL parameters of original requests
boolean	isKeepParamsOnNonAJAX() Determines if Non-AJAX action URLs are to keep URL parameters of original requests
boolean	isResultOutput() Gets the resultOutput
boolean	isVarWritten()
boolean	isWriteVars()
void	iterationIncrement()
de.innovationgate.webgate.api.WGDatabase	openContentDB(java.lang.String key)
de.innovationgate.webgate.api.WGDatabase	openDesignDB()
void	release()
void	setAppendvar(java.lang.String appendvar)
void	setCancelTag(boolean cancelTag) Sets the cancelTag
void	setChildTagContext(TMLContext childTagContext) Sets the childTagContext
void	setContext(java.lang.String context) Sets the context
void	setDivider(java.lang.String divider) Sets the divider
void	setDynamicAttribute(java.lang.String uri, java.lang.String localName, java.lang.Object value)
void	setEncode(java.lang.String encode) Sets the encode
void	setEvalBody(boolean evalBody) Sets the evalBody
void	setFormat(java.lang.String format) Sets the format
void	setIf(java.lang.String if1)
void	setIteration(int iteration) Sets the iteration
void	setOutput(java.lang.String output) Sets the output
void	setPrefix(java.lang.String string)
void	setPrivatecontext(java.lang.String tmlContext) Sets the privateContext
void	setPsessionvar(java.lang.String pvar)
void	setPvar(java.lang.String pvar)
void	setResult(java.lang.Object result)
void	setResultOutput(boolean resultOutput) Sets the resultOutput
void	setSessionvar(java.lang.String sessionvar) Sets the sessionvar.
void	setSourceline(java.lang.String string)
void	setSuffix(java.lang.String string)
void	setTMLContext(TMLContext tagContext) Sets the tagContext
void	setTrim(java.lang.String trim)
void	setUid(java.lang.String uid)
void	setUnless(java.lang.String unless)
void	setVar(java.lang.String var) Sets the var
void	setWriteVars(boolean writeVars)
boolean	stringToBoolean(java.lang.String expr)
int	stringToInteger(java.lang.String expr, int defaultValue)
void	tmlAfterBody()
void	tmlEndTag()
void	tmlInitBody()
void	tmlStartTag()
void	writePortletEventRegistration(java.lang.StringBuffer out, TMLAction action, TMLActionCallParameters callParams, boolean keepParams, java.lang.String onEvent)

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

DEBUG_TIMESTAMP_FORMAT

public static final java.text.DateFormat DEBUG_TIMESTAMP_FORMAT

SYSTEMOPTION_PREFIX

public static final java.lang.String SYSTEMOPTION_PREFIX

See Also:

Constant Field Values

OPTION_DEFAULT_XPLANGUAGE

public static final java.lang.String OPTION_DEFAULT_XPLANGUAGE

See Also:

Constant Field Values

OPTION_DESIGNDB

public static final java.lang.String OPTION_DESIGNDB

See Also:

Constant Field Values

OPTION_LINK_ACTION

public static final java.lang.String OPTION_LINK_ACTION

See Also:

Constant Field Values

OPTION_LINK_MEDIUM

public static final java.lang.String OPTION_LINK_MEDIUM

See Also:

Constant Field Values

OPTION_PORTLET_NAMESPACE

public static final java.lang.String OPTION_PORTLET_NAMESPACE

See Also:

Constant Field Values

OPTION_CURRENT_MEDIAKEY

public static final java.lang.String OPTION_CURRENT_MEDIAKEY

See Also:

Constant Field Values

OPTION_TMLMODULE_NAME

public static final java.lang.String OPTION_TMLMODULE_NAME

See Also:

Constant Field Values

OPTION_TMLMODULE_MEDIAKEY

public static final java.lang.String OPTION_TMLMODULE_MEDIAKEY

See Also:

Constant Field Values

OPTION_RESULT_INTERCEPTORS

public static final java.lang.String OPTION_RESULT_INTERCEPTORS

See Also:

Constant Field Values

OPTION_DEFAULT_LABELFILE

public static final java.lang.String OPTION_DEFAULT_LABELFILE

See Also:

Constant Field Values

OPTION_DEFAULT_LABELCONTAINER

public static final java.lang.String OPTION_DEFAULT_LABELCONTAINER

See Also:

Constant Field Values

OPTION_INNER_LAYOUT

public static final java.lang.String OPTION_INNER_LAYOUT

See Also:

Constant Field Values

OPTION_PORTLET_EVENT_STARTINDEX

public static final java.lang.String OPTION_PORTLET_EVENT_STARTINDEX

See Also:

Constant Field Values

OPTION_WEBTML_SCOPE

public static final java.lang.String OPTION_WEBTML_SCOPE

See Also:

Constant Field Values

OPTION_IMAGE_DERIVATES

public static final java.lang.String OPTION_IMAGE_DERIVATES

See Also:

Constant Field Values

OPTION_MODULE_CONTROLLER

public static final java.lang.String OPTION_MODULE_CONTROLLER

See Also:

Constant Field Values

OPTION_META_MAPPINGS

public static final java.lang.String OPTION_META_MAPPINGS

See Also:

Constant Field Values

OPTION_ITEM_MAPPINGS

public static final java.lang.String OPTION_ITEM_MAPPINGS

See Also:

Constant Field Values

OPTION_INCLUDELEVEL

public static final java.lang.String OPTION_INCLUDELEVEL

See Also:

Constant Field Values

UNRECOVERABLE_OPTIONS

public static final java.util.Set<java.lang.String> UNRECOVERABLE_OPTIONS

URL_VERSION_PARAMETER

public static final java.lang.String URL_VERSION_PARAMETER

TAGVALUE_STATUS

public static final java.lang.String TAGVALUE_STATUS

See Also:

Constant Field Values

TAGVALUE_DYNAMIC_ATTRIBUTES

public static final java.lang.String TAGVALUE_DYNAMIC_ATTRIBUTES

See Also:

Constant Field Values

ATTRIB_INCLUDEPARENT

public static final java.lang.String ATTRIB_INCLUDEPARENT

AJAX_MODE_NO_PORTLET_REFRESH

public static final java.lang.String AJAX_MODE_NO_PORTLET_REFRESH

See Also:

Constant Field Values

Constructor Detail

Base

public Base()

Method Detail

getStatus

public BaseTagStatus getStatus()

setResult

public void setResult(java.lang.Object result)

addWarning

public void addWarning(java.lang.String message,
              boolean cancelTag)

addWarning

public void addWarning(java.lang.String message)

clearWarnings

public void clearWarnings()

getMainContext

public TMLContext getMainContext()

getTMLContextForDocument

public TMLContext getTMLContextForDocument(de.innovationgate.webgate.api.WGDocument doc)

stringToBoolean

public boolean stringToBoolean(java.lang.String expr)

stringToInteger

public int stringToInteger(java.lang.String expr,
                  int defaultValue)

getTagStatusById

public BaseTagStatus getTagStatusById(java.lang.String id)

getTagStatusById

public BaseTagStatus getTagStatusById(java.lang.String id,
                             java.lang.Class<?> tagClass)

doStartTag

public final int doStartTag()
                     throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

See Also:

BodyTagSupport.doStartTag()

getParentTag

public BaseTagStatus getParentTag()

doEndTag

public final int doEndTag()
                   throws javax.servlet.jsp.JspException

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

See Also:

BodyTagSupport.doEndTag()

addResultInterceptor

public void addResultInterceptor(Base.ResultInterceptor ic)

doAfterBody

public final int doAfterBody()
                      throws javax.servlet.jsp.JspException

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

See Also:

BodyTagSupport.doAfterBody()

tmlStartTag

public void tmlStartTag()
                 throws TMLException,
                        de.innovationgate.webgate.api.WGException

Throws:

TMLException

de.innovationgate.webgate.api.WGException

tmlAfterBody

public void tmlAfterBody()
                  throws TMLException,
                         de.innovationgate.webgate.api.WGException

Throws:

TMLException

de.innovationgate.webgate.api.WGException

tmlInitBody

public void tmlInitBody()
                 throws TMLException,
                        de.innovationgate.webgate.api.WGException

Throws:

TMLException

de.innovationgate.webgate.api.WGException

tmlEndTag

public void tmlEndTag()
               throws TMLException,
                      de.innovationgate.webgate.api.WGException

Throws:

TMLException

de.innovationgate.webgate.api.WGException

getContext

public java.lang.String getContext()

Gets the context

Returns:

Returns a String

setContext

public void setContext(java.lang.String context)

Sets the context

Parameters:

context - The context to set

getId

public java.lang.String getId()

Gets the id

Overrides:

getId in class javax.servlet.jsp.tagext.TagSupport

Returns:

Returns a String

getOutput

public java.lang.String getOutput()

Gets the output

Returns:

Returns a String

setOutput

public void setOutput(java.lang.String output)

Sets the output

Parameters:

output - The output to set

getPrivatecontext

public java.lang.String getPrivatecontext()

Gets the privateContext

Returns:

Returns a String

setPrivatecontext

public void setPrivatecontext(java.lang.String tmlContext)

Sets the privateContext

Parameters:

privateContext - The privateContext to set

getVar

public java.lang.String getVar()

Gets the var

Returns:

Returns a String

setVar

public void setVar(java.lang.String var)

Sets the var

Parameters:

var - The var to set

getResultString

public java.lang.String getResultString()

getResultString

public java.lang.String getResultString(boolean includeFormatting)

openContentDB

public de.innovationgate.webgate.api.WGDatabase openContentDB(java.lang.String key)
                                                       throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getPageContext

public javax.servlet.jsp.PageContext getPageContext()

iterationIncrement

public void iterationIncrement()

getChildTagContext

public TMLContext getChildTagContext()

Gets the childTmlContext

Returns:

Returns a TmlContext

setChildTagContext

public void setChildTagContext(TMLContext childTagContext)

Sets the childTagContext

Parameters:

childTagContext - The childTagContext to set

getTMLContext

public TMLContext getTMLContext()

Gets the tagContext

Returns:

Returns a TagContext

setTMLContext

public void setTMLContext(TMLContext tagContext)

Sets the tagContext

Parameters:

tagContext - The tagContext to set

isEvalBody

public boolean isEvalBody()

Gets the evalBody

Returns:

Returns a boolean

setEvalBody

public void setEvalBody(boolean evalBody)

Sets the evalBody

Parameters:

evalBody - The evalBody to set

isWriteVars

public boolean isWriteVars()

setWriteVars

public void setWriteVars(boolean writeVars)

getIteration

public int getIteration()

Gets the iteration

Returns:

Returns a int

setIteration

public void setIteration(int iteration)

Sets the iteration

Parameters:

iteration - The iteration to set

isResultOutput

public boolean isResultOutput()

Gets the resultOutput

Returns:

Returns a boolean

setResultOutput

public void setResultOutput(boolean resultOutput)

Sets the resultOutput

Parameters:

resultOutput - The resultOutput to set

getDivider

public java.lang.String getDivider()

Gets the divider

Returns:

Returns a String

setDivider

public void setDivider(java.lang.String divider)

Sets the divider

Parameters:

divider - The divider to set

getFormat

public java.lang.String getFormat()

Gets the format

Returns:

Returns a String

setFormat

public void setFormat(java.lang.String format)

Sets the format

Parameters:

format - The format to set

getDispatcher

public WGPDispatcher getDispatcher()

getCore

public WGACore getCore()

getMimeType

public java.lang.String getMimeType()

getEncode

public java.lang.String getEncode()

Gets the encode

Returns:

Returns a String

setEncode

public void setEncode(java.lang.String encode)

Sets the encode

Parameters:

encode - The encode to set

getLevel

public java.lang.Integer getLevel()

getWGPPath

public java.lang.String getWGPPath()

isCollectionsShowReleasedOnly

public boolean isCollectionsShowReleasedOnly()

getCancelTag

public boolean getCancelTag()

Gets the cancelTag

Returns:

Returns a boolean

setCancelTag

public void setCancelTag(boolean cancelTag)

Sets the cancelTag

Parameters:

cancelTag - The cancelTag to set

getOutputStream

public java.io.OutputStream getOutputStream()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

getOption

public java.lang.Object getOption(java.lang.String optionName)

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.BodyTagSupport

See Also:

Tag.release()

getUserProfile

public TMLUserProfile getUserProfile(de.innovationgate.webgate.api.WGDatabase db)

getUserProfile

public TMLUserProfile getUserProfile()

getSessionvar

public java.lang.String getSessionvar()

Returns the sessionvar.

Returns:

String

setSessionvar

public void setSessionvar(java.lang.String sessionvar)

Sets the sessionvar.

Parameters:

sessionvar - The sessionvar to set

getDefaultExpressionLanguage

public java.lang.String getDefaultExpressionLanguage()

setSuffix

public void setSuffix(java.lang.String string)

Parameters:

string -

setPrefix

public void setPrefix(java.lang.String string)

Parameters:

string -

getSuffix

public java.lang.String getSuffix()

getPrefix

public java.lang.String getPrefix()

getDebugNode

public org.dom4j.Element getDebugNode()

getIterationDebugNode

public org.dom4j.Element getIterationDebugNode()

getSourceline

public java.lang.String getSourceline()

setSourceline

public void setSourceline(java.lang.String string)

getTrim

public java.lang.String getTrim()

Returns:

Returns the trim.

setTrim

public void setTrim(java.lang.String trim)

Parameters:

trim - The trim to set.

includeScript

public java.lang.String includeScript(java.lang.String script)

openDesignDB

public de.innovationgate.webgate.api.WGDatabase openDesignDB()
                                                      throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getPvar

public java.lang.String getPvar()

getPsessionvar

public java.lang.String getPsessionvar()

setPvar

public void setPvar(java.lang.String pvar)

setPsessionvar

public void setPsessionvar(java.lang.String pvar)

isVarWritten

public boolean isVarWritten()

getTagName

public java.lang.String getTagName()

buildHTMLHead

public void buildHTMLHead(boolean metaOutput,
                 java.lang.String scripts)
                   throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

getTagDescription

public java.lang.String getTagDescription()

isAjaxRequest

public boolean isAjaxRequest()

getDesignDBKey

public java.lang.String getDesignDBKey()

isKeepParamsOnAJAX

public boolean isKeepParamsOnAJAX()

Determines if AJAX action URLs are to keep URL parameters of original requests

isKeepParamsOnNonAJAX

public boolean isKeepParamsOnNonAJAX()

Determines if Non-AJAX action URLs are to keep URL parameters of original requests

getAppendvar

public java.lang.String getAppendvar()

setAppendvar

public void setAppendvar(java.lang.String appendvar)

getUid

public java.lang.String getUid()

setUid

public void setUid(java.lang.String uid)

defaultSetDynamicAttribute

public void defaultSetDynamicAttribute(java.util.List<java.lang.String> prefixes,
                              java.lang.String uri,
                              java.lang.String localName,
                              java.lang.Object value)
                                throws javax.servlet.jsp.JspException

Throws:

javax.servlet.jsp.JspException

getIf

public java.lang.String getIf()

setIf

public void setIf(java.lang.String if1)

getUnless

public java.lang.String getUnless()

setUnless

public void setUnless(java.lang.String unless)

buildNamedActionParameters

public java.util.Map<java.lang.String,java.lang.Object> buildNamedActionParameters(boolean serializable)
                                                                            throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException

writePortletEventRegistration

public void writePortletEventRegistration(java.lang.StringBuffer out,
                                 TMLAction action,
                                 TMLActionCallParameters callParams,
                                 boolean keepParams,
                                 java.lang.String onEvent)
                                   throws de.innovationgate.webgate.api.WGAPIException,
                                          TMLException

Throws:

de.innovationgate.webgate.api.WGAPIException

TMLException

setDynamicAttribute

public final void setDynamicAttribute(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.Object value)
                               throws javax.servlet.jsp.JspException

Specified by:

setDynamicAttribute in interface javax.servlet.jsp.tagext.DynamicAttributes

Throws:

javax.servlet.jsp.JspException