Package com.microstrategy.web.tags

Class IncludeTagImpl

java.lang.Object

com.microstrategy.web.tags.TagImpl

com.microstrategy.web.tags.IncludeTagImpl

All Implemented Interfaces:

EnumHTMLTags, IncludeTag, Tag, java.io.Serializable

public class IncludeTagImpl
extends TagImpl
implements IncludeTag

Since:

MicroStrategy Web 8.0.2

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.microstrategy.web.tags.EnumHTMLTags

ATT_ACTION, ATT_ALIGN, ATT_ALT, ATT_AUTOCOMPLETE, ATT_BORDER, ATT_CELLPADDING, ATT_CELLSPACING, ATT_CHECKED, ATT_CLASS, ATT_CMD_FORMAT_TYPE, ATT_CMDID, ATT_CMDLVL, ATT_COLS, ATT_COLSPAN, ATT_DG, ATT_DIALOG, ATT_DISABLED, ATT_FOR, ATT_HEIGHT, ATT_HREF, ATT_HSPACE, ATT_ID, ATT_IFRAME, ATT_LANGUAGE, ATT_MAXLENGTH, ATT_METHOD, ATT_MODAL, ATT_NAME, ATT_NOWRAP, ATT_ONCHANGE, ATT_ONCLICK, ATT_ONFOCUS, ATT_ONKEYDOWN, ATT_ONKEYUP, ATT_ONMOUSEOUT, ATT_ONMOUSEOVER, ATT_ONSUBMIT, ATT_PARAM, ATT_PLACEHOLDER, ATT_READONLY, ATT_REL, ATT_ROWS, ATT_ROWSPAN, ATT_SCRIPT_CLASS, ATT_SELECTED, ATT_SIZE, ATT_SRC, ATT_STYLE, ATT_SUMMARY, ATT_TARGET, ATT_TITLE, ATT_TY, ATT_TYPE, ATT_VALIGN, ATT_VALUE, ATT_VALUE_ABSBOTTOM, ATT_VALUE_ABSMIDDLE, ATT_VALUE_BOTTOM, ATT_VALUE_BUTTON, ATT_VALUE_CHECKBOX, ATT_VALUE_DEFAULT, ATT_VALUE_EMBED, ATT_VALUE_FALSE, ATT_VALUE_HIDDEN, ATT_VALUE_IMAGE, ATT_VALUE_JAVASCRIPT, ATT_VALUE_LEFT, ATT_VALUE_MAX, ATT_VALUE_MIDDLE, ATT_VALUE_MIN, ATT_VALUE_NUMBER, ATT_VALUE_POST, ATT_VALUE_RADIO, ATT_VALUE_SUBMIT, ATT_VALUE_TEXT, ATT_VALUE_TOP, ATT_VALUE_TRUE, ATT_VSPACE, ATT_WIDTH, TAG_NAME_ANCHOR, TAG_NAME_CELL, TAG_NAME_DIV, TAG_NAME_HEADER, TAG_NAME_IFRAME, TAG_NAME_IMAGE, TAG_NAME_INPUT, TAG_NAME_LABEL, TAG_NAME_MAP, TAG_NAME_OPTION, TAG_NAME_ROW, TAG_NAME_SCRIPT, TAG_NAME_SELECT, TAG_NAME_SPAN, TAG_NAME_STYLE, TAG_NAME_TABLE, TAG_NAME_TBODY, TAG_NAME_TEXTAREA, TAG_NAME_THEAD

Fields inherited from interface com.microstrategy.web.tags.IncludeTag

ATTR_NAME_FILE_NAME, TAG_NAME_INCLUDE

Constructor Summary

Constructors

Constructor	Description
IncludeTagImpl()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFileName()	Returns the location of the file It is actually the value of the attribute IncludeTag.ATTR_NAME_FILE_NAME.
LayoutTag	getTemplateContent()	Returns the tree representation of the included template source
void	populateTemplate(java.lang.String fileName, LayoutSource layoutSource, LayoutParser layoutParser)	Retrieves the content of the included external file and sets the content on the tag
void	render(MarkupOutput markup, LayoutContext context)	This method calls the rendering on the dynamically generated layoutTag The includeTag doesn't render its static tree structure.

Methods inherited from class com.microstrategy.web.tags.TagImpl

addChild, addChild, addChild, addTextChild, addTextChild, checkEmptyString, checkModifiable, checkNullObject, doEndTag, doStartTag, generateErrorMessage, getAttribute, getAttributeNames, getAttributeNamesCollection, getAttributesCollection, getChildren, getChildrenCollection, getContent, getCssClass, getDeepCopy, getDynamicAttributesCollection, getId, getLineNumber, getPreserveCase, getRootTag, getSealed, getStyle, getTagName, isClosedRequired, isContentInline, isDynamic, removeAttribute, removeChildren, render, renderAllAttributes, renderChildTags, renderCloseTag, renderCloseTag, renderOpenTag, renderOpenTag, replaceContent, setAttribute, setAttributes, setCssClass, setDynamic, setDynamicInternal, setId, setIsClosedRequired, setIsContentInline, setLineNumber, setPreserveCase, setRootTag, setSealed, setStyle, setTagName, shouldCloseTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.tags.Tag

addChild, addChild, addChild, addTextChild, addTextChild, doEndTag, doStartTag, getAttribute, getAttributeNames, getChildren, getContent, getCssClass, getDeepCopy, getId, getLineNumber, getPreserveCase, getRootTag, getSealed, getStyle, getTagName, isClosedRequired, isContentInline, isDynamic, removeChildren, render, renderCloseTag, renderOpenTag, renderOpenTag, replaceContent, setAttribute, setAttributes, setCssClass, setDynamic, setId, setIsClosedRequired, setIsContentInline, setLineNumber, setPreserveCase, setRootTag, setSealed, setStyle, setTagName

Constructor Detail

IncludeTagImpl

public IncludeTagImpl()

Method Detail

getFileName

public java.lang.String getFileName()

Returns the location of the file It is actually the value of the attribute IncludeTag.ATTR_NAME_FILE_NAME.

Specified by:

getFileName in interface IncludeTag

Returns:

the value of the attribute IncludeTag.ATTR_NAME_FILE_NAME.

getTemplateContent

public LayoutTag getTemplateContent()

Returns the tree representation of the included template source

Specified by:

getTemplateContent in interface IncludeTag

Returns:

LayoutTag

populateTemplate

public void populateTemplate(java.lang.String fileName,
                             LayoutSource layoutSource,
                             LayoutParser layoutParser)

Retrieves the content of the included external file and sets the content on the tag

Specified by:

populateTemplate in interface IncludeTag

Parameters:

fileName - - The location of the external file

layoutSource - - The layoutSource to load the external file

layoutParser - - The layoutParser to parse the external file

render

public void render(MarkupOutput markup,
                   LayoutContext context)
            throws MalformedMethodException

This method calls the rendering on the dynamically generated layoutTag The includeTag doesn't render its static tree structure. (1) context == null, print out layout-related tags (2) context != null, render dynamice content from layout-related tags

Specified by:

render in interface Tag

Overrides:

render in class TagImpl

Parameters:

markup - MarkupOutput

context - LayoutContext

Throws:

RenderUnsuccessfulException

MalformedMethodException - thrown if error occurs at rendering.