public interface

LayoutTag

implements Tag
com.microstrategy.web.tags.LayoutTag

Class Overview

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

Summary

Constants
String ATTR_NAME_LAYOUT_VERSION The constant name of the attribute version of a layout.
String TAG_NAME_LAYOUT The constant name of the LayoutTag.
[Expand]
Inherited Constants
From interface com.microstrategy.web.tags.EnumHTMLTags
Public Methods
abstract void addSlotTag(SlotTag slotTag)
Adds slot tag to the layout slot tag collection.
abstract String getLayoutLocation()
Returns the location of the layout source.
abstract LayoutParser getLayoutParser()
Returns the layout parser used to parse the layout source.
abstract LayoutSource getLayoutSource()
Returns the layout source where the current tag is defined.
abstract SlotTag getSlotTag(String slotName)
Returns the slotTag with the specified name
abstract String getVersion()
Returns the version of a layout.
abstract void setLayoutLocation(String location)
Sets the location of the layout source.
abstract void setLayoutParser(LayoutParser layoutParser)
Sets a layout parser used to parse the layout source.
abstract void setLayoutSource(LayoutSource layoutSource)
Sets the layout source where the current tag is defined.
abstract void setVersion(String version)
Sets the version string of a layout.
[Expand]
Inherited Methods
From interface com.microstrategy.web.tags.Tag
abstract void doStartTag(LayoutContext context)
This method is called before the rendering method renderOpenTag(MarkupOutput, LayoutContext) is called to render the opening part of a tag, such as "".
abstract String getAttribute(String attrName)
Returns the attribute value with the specified attribute name.
abstract Enumeration getAttributeNames()
Returns a Enumeration of attributes of the current tag.
abstract Enumeration getChildren()
Returns a Enumeration of children of the current tag.
abstract MarkupOutput getContent()
Returns a new MarkupOutput instance and Adds it as a child of the current tag.
abstract String getCssClass()
Returns the Cascading Style Sheets class name associated with the current tag.
abstract Tag getDeepCopy()
Returns a deep copy of this tag
abstract String getId()
Returns the ID attribute value of the current tag.
abstract int getLineNumber()
Returns the line number of the current tag in the layout source.
abstract boolean getPreserveCase()
Gets the character cases when rendering the tag name and attribute name.
abstract Tag getRootTag()
Returns the root tag in the tag hierarchical tree.
abstract boolean getSealed()
Returns a boolean value indicating whether the current tag is read-only.
abstract String getStyle()
Returns the value of the style attribute.
abstract String getTagName()
Returns the name of the current tag.
abstract boolean isClosedRequired()
Returns a boolean value indicating whether a closing tag, which looks like </foo>, is required when rendering the current tag.
abstract boolean isContentInline()
Returns a boolean value indicating whether the rendering result of the current tag needs to be written in a single line.
abstract boolean isDynamic()
Returns a boolean value indicating whether the current tag is dynamic.
abstract void removeChildren()
Remove any existing child tag from this tag.
abstract void render(MarkupOutput markup)
Renders the current tag including all its children tags and stores the rendering result in the specified MarkupOutput instance.
abstract void render(MarkupOutput markup, LayoutContext context)
Renders the current tag including all its children tagas and stores the rendering result in the specified MarkupOutput object.
abstract void renderCloseTag(MarkupOutput markup)
Renders the closing tag of the current tag and stores the rendering result in the specified MarkupOutput object.
abstract void renderOpenTag(MarkupOutput markup)
Renders the openning tag of the current tag ans store the rendering result in the specified MarkupOutput object.
abstract void renderOpenTag(MarkupOutput markup, LayoutContext context)
Renders the openning tag of the current tag and stores the rendering result in the specified MarkupOutput object.
abstract void replaceContent(Tag srcTag)
Replace the current tag's content with the srcTag's content
abstract void setAttribute(String attrName, String attrValue)
Sets a new value to the attribute with the specified attribute name.
abstract void setAttributes(Map attributes)
Sets a Map of attributes to the current tag.
abstract void setCssClass(String css)
Sets a class name for the Cascading Style Sheets attribute on the current tag.
abstract void setDynamic(boolean dyn)
Sets a boolean value indicating whether the current tag is dynamic.
abstract void setId(String id)
Sets a value to the ID attribute on the current tag.
abstract void setIsClosedRequired(boolean closeReq)
Sets a boolean value indicating whether a closing tag, which looks like </foo>, is required when rendering the current tag.
abstract void setIsContentInline(boolean inline)
Sets a boolean value indicating whether the rendering result of the current tag needs to be written in a single line.
abstract void setLineNumber(int lineNumber)
Sets the line number of the current tag in the layout source.
abstract void setPreserveCase(boolean preserveCase)
Sets the character cases when rendering the tag name and attribute name.
abstract void setRootTag(Tag root)
Sets a root tag of the tag tree to which the current tag belongs.
abstract void setSealed()
Marks the current tag as read-only.
abstract void setStyle(String style)
Set a value to the style attribute.
abstract void setTagName(String name)
Sets the current tag name.

Constants

public static final String ATTR_NAME_LAYOUT_VERSION

The constant name of the attribute version of a layout.

Constant Value: "version"

public static final String TAG_NAME_LAYOUT

The constant name of the LayoutTag.

Constant Value: "layout"

Public Methods

public abstract void addSlotTag (SlotTag slotTag)

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
IllegalArgumentException If there's a slot with given name in the collection

public abstract String getLayoutLocation ()

Returns the location of the layout source.

Returns
  • the location of the layout source.

public abstract LayoutParser getLayoutParser ()

Returns the layout parser used to parse the layout source.

Returns
  • the layout parser.

public abstract LayoutSource getLayoutSource ()

Returns the layout source where the current tag is defined.

Returns
  • the layout source

public abstract SlotTag getSlotTag (String slotName)

Returns the slotTag with the specified name

Parameters
slotName Name of the slot tag
Returns
  • SlotTag

public abstract String getVersion ()

Returns the version of a layout.

Returns
  • the version of a layout.

public abstract void setLayoutLocation (String location)

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.

public abstract void setLayoutParser (LayoutParser layoutParser)

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.

public abstract void setLayoutSource (LayoutSource layoutSource)

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.

public abstract void setVersion (String version)

Sets the version string of a layout.

Parameters
version the version of a layout.
Throws
UnmodifiableException thrown if the current tag is read-only.