Package com.microstrategy.web.tags

Interface LayoutTag

All Superinterfaces:

EnumHTMLTags, Tag

public interface LayoutTag
extends Tag

The LayoutTag interface represents the root tag of a layout source.

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR_NAME_LAYOUT_VERSION	The constant name of the attribute version of a layout.
static java.lang.String	TAG_NAME_LAYOUT	The constant name of the LayoutTag.

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

Method Summary

Modifier and Type	Method	Description
void	addSlotTag(SlotTag slotTag)	Adds slot tag to the layout slot tag collection.
java.lang.String	getLayoutLocation()	Returns the location of the layout source.
LayoutParser	getLayoutParser()	Returns the layout parser used to parse the layout source.
LayoutSource	getLayoutSource()	Returns the layout source where the current tag is defined.
SlotTag	getSlotTag(java.lang.String slotName)	Returns the slotTag with the specified name
java.lang.String	getVersion()	Returns the version of a layout.
void	setLayoutLocation(java.lang.String location)	Sets the location of the layout source.
void	setLayoutParser(LayoutParser layoutParser)	Sets a layout parser used to parse the layout source.
void	setLayoutSource(LayoutSource layoutSource)	Sets the layout source where the current tag is defined.
void	setVersion(java.lang.String version)	Sets the version string of a layout.

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, render, renderCloseTag, renderOpenTag, renderOpenTag, replaceContent, setAttribute, setAttributes, setCssClass, setDynamic, setId, setIsClosedRequired, setIsContentInline, setLineNumber, setPreserveCase, setRootTag, setSealed, setStyle, setTagName

Field Detail

TAG_NAME_LAYOUT

static final java.lang.String TAG_NAME_LAYOUT

The constant name of the LayoutTag.

See Also:

Constant Field Values

ATTR_NAME_LAYOUT_VERSION

static final java.lang.String ATTR_NAME_LAYOUT_VERSION

The constant name of the attribute version of a layout.

See Also:

Constant Field Values

Method Detail

getVersion

java.lang.String getVersion()

Returns the version of a layout.

Returns:

the version of a layout.

setVersion

void setVersion(java.lang.String version)
         throws UnmodifiableException

Sets the version string of a layout.

Parameters:

version - the version of a layout.

Throws:

UnmodifiableException - thrown if the current tag is read-only.

getLayoutSource

LayoutSource getLayoutSource()

Returns the layout source where the current tag is defined.

Returns:

the layout source

setLayoutSource

void setLayoutSource(LayoutSource layoutSource)
              throws UnmodifiableException

Sets the layout source where the current tag is defined.

Parameters:

layoutSource - the layout source

Throws:

UnmodifiableException - thrown if the current tag is read-only.

getLayoutParser

LayoutParser getLayoutParser()

Returns the layout parser used to parse the layout source.

Returns:

the layout parser.

setLayoutParser

void setLayoutParser(LayoutParser layoutParser)
              throws UnmodifiableException

Sets a layout parser used to parse the layout source.

Parameters:

layoutParser - a layout parser.

Throws:

UnmodifiableException - thrown if the current tag is read-only.

getLayoutLocation

java.lang.String getLayoutLocation()

Returns the location of the layout source.

Returns:

the location of the layout source.

setLayoutLocation

void setLayoutLocation(java.lang.String location)
                throws UnmodifiableException

Sets the location of the layout source.

Parameters:

location - the location of the layout source.

Throws:

UnmodifiableException - thrown if the current tag is read-only.

addSlotTag

void addSlotTag(SlotTag slotTag)
         throws java.lang.IllegalArgumentException

Adds slot tag to the layout slot tag collection. If there's a slot with the same name in the collection, it will throw an IllegalArgument exception.

Parameters:

slotTag - The tag to be added

Throws:

java.lang.IllegalArgumentException - If there's a slot with given name in the collection

Since:

MicroStrategy Web 8.0.2

getSlotTag

SlotTag getSlotTag(java.lang.String slotName)

Returns the slotTag with the specified name

Parameters:

slotName - Name of the slot tag

Returns:

SlotTag

Since:

MicroStrategy Web 8.0.2