de.innovationgate.wgpublisher.webtml

Class BaseTagStatus

java.lang.Object

de.innovationgate.wgpublisher.webtml.BaseTagStatus

Direct Known Subclasses:

ActionBase.Status, Body.BodyStatus, Case.Status, CaseElse.Status, Collection.Status, CreatePage.Status, Element.Status, Else.Status, ElseIf.Status, Evaluate.Status, ForEach.Status, FormBase.FormStatus, FormMessages.Status, GroupChange.Status, If.Status, Include.Status, MetaData.Status, Option.Status, Query.Status, Range.Status, Root.Status, Select.Status, Then.Status

public class BaseTagStatus
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
boolean	cancelTag Flag showing if the tags execution was canceled
TMLContext	childTMLContext The WebTML context inherited to child tags
boolean	directOutput
boolean	evalBody Flag if the tag should evaluate its body content
java.lang.String	id The tags unique id
int	iteration Iteration counter
javax.servlet.jsp.PageContext	pageContext
BaseTagStatus	parentTag The status of our tags parent tag
java.lang.Object	result The tags result in native data type
int	sourceLine The line in the WebTML module which defines this tag
java.lang.Class<?>	tagClass The class of the tag whose status we are
TMLContext	tmlContext This tags own WebTML context
boolean	trimResultString
boolean	writeVars Flag if the tag should write any variables

Constructor Summary

Constructors

Constructor and Description
BaseTagStatus()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSubtags(int number)
void	addWarning(java.lang.String msg, boolean severe)
void	addWarning(TMLContext cx, java.lang.String msg, boolean severe, java.lang.Throwable cause)
BaseTagStatus	appendResult(java.io.Reader reader)
BaseTagStatus	appendResult(java.lang.String tmlResult)
void	clearResult()
void	determineOutputType(Base tag) Determining if the current tag may do direct output
BaseTagStatus	getAncestorIncludeTag(java.lang.String type) search recursive for a parent includeTag with the given type
BaseTagStatus	getAncestorTag(java.lang.Class<?> parentClass)
BaseTagStatus	getAncestorTag(java.lang.Class<? extends java.lang.Object> parentClass, boolean traverseAcrossRootTags)
WGACore	getCore()
java.lang.String	getDesignDBKey()
java.util.Map<java.lang.String,java.lang.Object>	getLocalOptions() Returns a map of all WebTML options that were defined directly for the current WebTML tag.
java.lang.Object	getLocalVar(java.lang.String name)
java.lang.Object	getOption(java.lang.String optionName)
java.util.List<java.lang.String>	getOptionNames()
TMLOption	getOptionObject(java.lang.String optionName)
BaseTagStatus	getParentTag()
BaseTagStatus	getParentTag(java.lang.Class<?> tagClass)
java.lang.String	getRelevantForm()
java.lang.String	getRequestURL()
java.lang.String	getResultString(boolean includeFormatting, boolean trim)
Root.Status	getRootTag()
java.util.Map<java.lang.String,BaseTagStatus>	getTagIds()
java.lang.Object	getTagInfo(java.lang.String name)
java.util.Map<java.lang.String,TMLOption>	getTagOptions()
BaseTagStatus	getTagStatusById(java.lang.String id)
BaseTagStatus	getTagStatusById(java.lang.String id, java.lang.Class<?> tagClass)
java.lang.String	getTMLModuleMediaKey()
java.lang.String	getTMLModuleName()
java.util.List<Warning>	getWarnings()
java.lang.String	getWGPPath()
boolean	hasLocalVar(java.lang.String name)
void	initAttributeDelegates(Base tag)
boolean	isBrowserInterface4()
boolean	isStatusDirectOutputCapable(Base tag)
java.lang.Object	removeLocalVar(java.lang.String name)
void	removeOption(java.lang.String option)
void	retrieveParentTag(Base tag)
void	setLocalVar(java.lang.String name, java.lang.Object object)
void	setOption(java.lang.String name, java.lang.Object value, java.lang.String scope)

Methods inherited from class java.lang.Object

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

Field Detail

tagClass

public java.lang.Class<?> tagClass

The class of the tag whose status we are

parentTag

public BaseTagStatus parentTag

The status of our tags parent tag

tmlContext

public TMLContext tmlContext

This tags own WebTML context

childTMLContext

public TMLContext childTMLContext

The WebTML context inherited to child tags

evalBody

public boolean evalBody

Flag if the tag should evaluate its body content

writeVars

public boolean writeVars

Flag if the tag should write any variables

iteration

public int iteration

Iteration counter

cancelTag

public boolean cancelTag

Flag showing if the tags execution was canceled

result

public java.lang.Object result

The tags result in native data type

id

public java.lang.String id

The tags unique id

sourceLine

public int sourceLine

The line in the WebTML module which defines this tag

trimResultString

public boolean trimResultString

directOutput

public boolean directOutput

pageContext

public javax.servlet.jsp.PageContext pageContext

Constructor Detail

BaseTagStatus

public BaseTagStatus()

Method Detail

getTagInfo

public java.lang.Object getTagInfo(java.lang.String name)
                            throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

initAttributeDelegates

public void initAttributeDelegates(Base tag)

determineOutputType

public void determineOutputType(Base tag)

Determining if the current tag may do direct output

Parameters:

tag -

isStatusDirectOutputCapable

public boolean isStatusDirectOutputCapable(Base tag)

getAncestorTag

public BaseTagStatus getAncestorTag(java.lang.Class<?> parentClass)

getAncestorTag

public BaseTagStatus getAncestorTag(java.lang.Class<? extends java.lang.Object> parentClass,
                           boolean traverseAcrossRootTags)

getAncestorIncludeTag

public BaseTagStatus getAncestorIncludeTag(java.lang.String type)

search recursive for a parent includeTag with the given type

Parameters:

type -

Returns:

includeTag or null if not found

getParentTag

public BaseTagStatus getParentTag()

retrieveParentTag

public void retrieveParentTag(Base tag)

getParentTag

public BaseTagStatus getParentTag(java.lang.Class<?> tagClass)

getRootTag

public Root.Status getRootTag()

addSubtags

public void addSubtags(int number)

getTagStatusById

public BaseTagStatus getTagStatusById(java.lang.String id)

getTagStatusById

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

getTagIds

public java.util.Map<java.lang.String,BaseTagStatus> getTagIds()

getDesignDBKey

public java.lang.String getDesignDBKey()

getOption

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

getOptionNames

public java.util.List<java.lang.String> getOptionNames()

getOptionObject

public TMLOption getOptionObject(java.lang.String optionName)

addWarning

public void addWarning(java.lang.String msg,
              boolean severe)

addWarning

public void addWarning(TMLContext cx,
              java.lang.String msg,
              boolean severe,
              java.lang.Throwable cause)

isBrowserInterface4

public boolean isBrowserInterface4()

getRequestURL

public java.lang.String getRequestURL()

setOption

public void setOption(java.lang.String name,
             java.lang.Object value,
             java.lang.String scope)

removeOption

public void removeOption(java.lang.String option)

getRelevantForm

public java.lang.String getRelevantForm()

getTMLModuleName

public java.lang.String getTMLModuleName()

getTMLModuleMediaKey

public java.lang.String getTMLModuleMediaKey()

getLocalOptions

public java.util.Map<java.lang.String,java.lang.Object> getLocalOptions()

Returns a map of all WebTML options that were defined directly for the current WebTML tag. WebTML options that were inherited from the parent tag are omitted here.

Returns:

Map containing WebTML options, option names as key, option values as content

getWGPPath

public java.lang.String getWGPPath()

getWarnings

public java.util.List<Warning> getWarnings()

getTagOptions

public java.util.Map<java.lang.String,TMLOption> getTagOptions()

getCore

public WGACore getCore()

getResultString

public java.lang.String getResultString(boolean includeFormatting,
                               boolean trim)

clearResult

public void clearResult()

appendResult

public BaseTagStatus appendResult(java.lang.String tmlResult)
                           throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

appendResult

public BaseTagStatus appendResult(java.io.Reader reader)
                           throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

setLocalVar

public void setLocalVar(java.lang.String name,
               java.lang.Object object)

hasLocalVar

public boolean hasLocalVar(java.lang.String name)

getLocalVar

public java.lang.Object getLocalVar(java.lang.String name)

removeLocalVar

public java.lang.Object removeLocalVar(java.lang.String name)