| java.lang.Object | |
| ↳ | com.microstrategy.web.tags.TagImpl |
Known Direct Subclasses
|
Known Indirect Subclasses
|
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.microstrategy.web.tags.EnumHTMLTags
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| TagImpl() | |||||||||||
| TagImpl(String tagName) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Tag |
addChild(Tag tag)
Adds a child tag.
| ||||||||||
| Tag |
addChild(String tagName)
Adds a child tag with the speicified tag name.
| ||||||||||
| MarkupOutput |
addChild(MarkupOutput markup)
Adds a
MarkupOutput instance as a child of the current tag. | ||||||||||
| String |
addTextChild(String text)
Adds a text as a child of the current tag.
| ||||||||||
| String |
addTextChild(String text, boolean encode)
Adds a text as a child of the current tag.
| ||||||||||
| void |
doEndTag(LayoutContext context)
This method is called after the rendering method renderCloseTag(MarkupOutput)
is called to render the closing part of a tag, such as " | ||||||||||
renderOpenTag(MarkupOutput, LayoutContext)
is called to render the opening part of a tag, such as "| String | generateErrorMessage(Tag origin, String msg) |
| String |
getAttribute(String attrName)
Returns the attribute value with the specified attribute name.
|
| Enumeration |
getAttributeNames()
Returns a Enumeration of attributes of the current tag.
|
| Enumeration |
getChildren()
Returns a Enumeration of children of the current tag.
|
| MarkupOutput |
getContent()
Returns a new
MarkupOutput instance and Adds it as a child
of the current tag. |
| String |
getCssClass()
Returns the
Cascading Style Sheets class name associated
with the current tag. |
| Tag |
getDeepCopy()
Returns a deep copy of this tag
|
| String |
getId()
Returns the ID attribute value of the current tag.
|
| int |
getLineNumber()
Returns the line number of the current tag in the layout source.
|
| boolean |
getPreserveCase()
Gets the character cases when rendering the tag name and attribute name.
|
| Tag |
getRootTag()
Returns the root tag in the tag hierarchical tree.
|
| boolean |
getSealed()
Returns a boolean value indicating whether the current tag is read-only.
|
| String |
getStyle()
Returns the value of the style attribute.
|
| String |
getTagName()
Returns the name of the current tag.
|
| boolean |
isClosedRequired()
Returns a boolean value indicating whether a closing tag, which looks like
</foo>, is required when rendering the current tag. |
| boolean |
isContentInline()
Returns a boolean value indicating whether the rendering result of the
current tag needs to be written in a single line.
|
| boolean |
isDynamic()
Returns a boolean value indicating whether the current tag is dynamic.
|
| void |
removeChildren()
Remove any existing child tag from this tag.
|
| void |
render(MarkupOutput markup, LayoutContext context)
(1) context == null, print out layout-related tags
(2) context != null, render dynamic content from layout-related tags
|
| void |
render(MarkupOutput markup)
Renders the current tag including all its children tags and stores the
rendering result in the specified
MarkupOutput instance. |
| void |
renderCloseTag(MarkupOutput markup)
Renders the closing tag of the current tag and stores the rendering
result in the specified
MarkupOutput object. |
| void | renderCloseTag(MarkupOutput markup, LayoutContext context) |
| void |
renderOpenTag(MarkupOutput markup, LayoutContext context)
Renders the openning tag of the current tag and stores the rendering
result in the specified
MarkupOutput object. |
| void |
renderOpenTag(MarkupOutput markup)
Renders the openning tag of the current tag ans store the rendering
result in the specified
MarkupOutput object. |
| void |
replaceContent(Tag srcTag)
copyContent Replace the current tag's content with the srcTag's content
|
| void |
setAttribute(String attrName, String attrValue)
Sets a new value to the attribute with the specified attribute name.
|
| void |
setAttributes(Map attributes)
Sets a Map of attributes to the current tag.
|
| void |
setCssClass(String css)
Sets a class name for the Cascading Style Sheets attribute on the current
tag.
|
| void |
setDynamic(boolean dyn)
Sets a boolean value indicating whether the current tag is dynamic.
|
| void |
setId(String id)
Sets a value to the ID attribute on the current tag.
|
| void |
setIsClosedRequired(boolean closeReq)
Sets a boolean value indicating whether a closing tag, which looks like
</foo>, is required when rendering the current tag. |
| 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.
|
| void |
setLineNumber(int lineNumber)
Sets the line number of the current tag in the layout source.
|
| void |
setPreserveCase(boolean preserveCase)
Sets the character cases when rendering the tag name and attribute name.
|
| void |
setRootTag(Tag root)
Sets a root tag of the tag tree to which the current tag belongs.
|
| void |
setSealed()
Marks the current tag as read-only.
|
| void |
setStyle(String style)
Set a value to the style attribute.
|
| void |
setTagName(String name)
Sets the current tag name.
|
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void | checkEmptyString(String s, String msg) | ||||||||||
| void | checkModifiable() | ||||||||||
| void | checkNullObject(Object o, String msg) | ||||||||||
| Map | getAttributeNamesCollection() | ||||||||||
| Map | getAttributesCollection() | ||||||||||
| List | getChildrenCollection() | ||||||||||
| List | getDynamicAttributesCollection() | ||||||||||
| void | removeAttribute(String name) | ||||||||||
| void | renderAllAttributes(MarkupOutput markup, LayoutContext context) | ||||||||||
| void | renderChildTags(MarkupOutput markup, LayoutContext context) | ||||||||||
| void | setDynamicInternal(boolean dyn) | ||||||||||
| boolean | shouldCloseTag() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 "
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Adds a child tag.
| tag | the child tag to be added. |
|---|
| UnmodifiableException |
|---|
Adds a child tag with the speicified tag name.
| tagName | the child tag name. |
|---|
| UnmodifiableException |
|---|
Adds a MarkupOutput instance as a child of the current tag.
| markup | a MarkupOutput instance to be added. |
|---|
MarkupOutput instance just being added.| UnmodifiableException |
|---|
Adds a text as a child of the current tag.
| text | a text string to be added. |
|---|
| UnmodifiableException |
|---|
Adds a text as a child of the current tag.
| text | a text string to be added. |
|---|---|
| encode | true if the text should be encoded |
| UnmodifiableException |
|---|
This method is called after the rendering method renderCloseTag(MarkupOutput)
is called to render the closing part of a tag, such as "". It is recommended
to put all the cleaning work in this method that does not require rendering to the
MarkupOutput object.
| context | the LayoutContext object within which the rendering
occurs. |
|---|
This method is called before the rendering method renderOpenTag(MarkupOutput, LayoutContext)
is called to render the opening part of a tag, such as "
| context | the LayoutContext object within which the rendering
occurs. |
|---|
Returns the attribute value with the specified attribute name.
Null is returned if there is no such an attribute.
| attrName | the attribute name. |
|---|
Returns a Enumeration of attributes of the current tag.
Returns a Enumeration of children of the current tag.
Returns a new MarkupOutput instance and Adds it as a child
of the current tag. If the last child is a MarkupOutput
object, just returns that one for the sake of memory consumption and
performance.
MarkupOutput instance.| UnmodifiableException |
|---|
Returns the Cascading Style Sheets class name associated
with the current tag. It is equivalent to call the method
getAttribute(.ATT_CLASS)
Returns a deep copy of this tag
Returns the ID attribute value of the current tag. It is equivalent to
call the method getAttribute(.ATT_ID)
Returns the line number of the current tag in the layout source.
Gets the character cases when rendering the tag name and attribute name.
Returns the root tag in the tag hierarchical tree.
Returns a boolean value indicating whether the current tag is read-only.
true to indicate that the current tag is read-only.
Returns the value of the style attribute. It is equivalent to call the
method getAttribute(.ATT_STYLE)
Returns the name of the current tag.
Returns a boolean value indicating whether a closing tag, which looks like
</foo>, is required when rendering the current tag.
true to indicate that a closing tag is required.
Returns a boolean value indicating whether the rendering result of the current tag needs to be written in a single line.
true to indicate that a single line of the rendering
result is preferred.
Returns a boolean value indicating whether the current tag is dynamic.
A dynamic tag might not get its opening tag rendered when the
LayoutContext object is not null.
true to indicate that the current tag is dynamic.Remove any existing child tag from this tag.
(1) context == null, print out layout-related tags (2) context != null, render dynamic content from layout-related tags
| markup | MarkupOutput |
|---|---|
| context | LayoutContext |
| MalformedMethodException |
|---|
Renders the current tag including all its children tags and stores the
rendering result in the specified MarkupOutput instance.
| markup | the MarkupOutput object to store the rendering
result.
|
|---|
Renders the closing tag of the current tag and stores the rendering
result in the specified MarkupOutput object.
| markup | the MarkupOutput object to store the rendering
result.
|
|---|
Renders the openning tag of the current tag and stores the rendering
result in the specified MarkupOutput object.
| markup | the MarkupOutput object to store the rendering
result. |
|---|---|
| context | the LayoutContext object within which the rendering
occurs. |
| MalformedMethodException |
|---|
Renders the openning tag of the current tag ans store the rendering
result in the specified MarkupOutput object.
| markup | the MarkupOutput object to store the rendering
result.
|
|---|
copyContent Replace the current tag's content with the srcTag's content
| srcTag | Tag - The source tag which provides the content to replace with |
|---|
Sets a new value to the attribute with the specified attribute name. If the specified attribute does not exist in the current tag, adds it. If the specified attribute value is null, removes the attribute from the current tag.
| attrName | the name of the attribute |
|---|---|
| attrValue | the value of the attribute |
| UnmodifiableException |
|---|
Sets a Map of attributes to the current tag. The Map
contains pairs of attribute name and value.
| attributes | a Map of attributes |
|---|
Sets a class name for the Cascading Style Sheets attribute on the current
tag. It is equivalent to call the method
setAttribute(ATT_CLASS, css)
| css | the class name of the Cascading Style Sheets attribute |
|---|
| UnmodifiableException |
|---|
Sets a boolean value indicating whether the current tag is dynamic.
A dynamic tag might not get its opening tag rendered when the
LayoutContext object is not null.
| dyn | true to indicate that the current tag is dynamic. |
|---|
| UnmodifiableException |
|---|
Sets a value to the ID attribute on the current tag. It is equivalent to
call the method setAttribute(.ATT_ID, id)
| id | the valud of the ID attribute. |
|---|
| UnmodifiableException |
|---|
Sets a boolean value indicating whether a closing tag, which looks like
</foo>, is required when rendering the current tag.
| closeReq | true to indicate that a closing tag is
required. |
|---|
| UnmodifiableException |
|---|
Sets a boolean value indicating whether the rendering result of the current tag needs to be written in a single line.
| inline | true to indicate that a single line of the
rendering result is preferred. |
|---|
| UnmodifiableException |
|---|
Sets the line number of the current tag in the layout source.
| lineNumber | the line number of the current tag in the layout source. |
|---|
| UnmodifiableException |
|---|
Sets the character cases when rendering the tag name and attribute name.
Default is false.
| preserveCase | true to indicate case will be preserved when
rendering of the tag name and attribute name. false to indicate the
rendering of the tag name and attribute name will be in lower case. |
|---|
Sets a root tag of the tag tree to which the current tag belongs.
| root | the root tag of the tag tree. |
|---|
| UnmodifiableException |
|---|
Marks the current tag as read-only.
Set a value to the style attribute. It is equivalent to call the
method setAttribute(.ATT_STYLE, style)
| style | the style attribute value. |
|---|
| UnmodifiableException |
|---|
| IllegalArgumentException |
|---|
| IllegalArgumentException |
|---|
| MalformedMethodException |
|---|
| MalformedMethodException |
|---|