public interface

AnchorTag

implements Tag
com.microstrategy.web.tags.AnchorTag
Known Indirect Subclasses

Class Overview

The AnchorTag represents a HTML anchor tag.

Summary

Constants
String TAG_NAME The constant name of the AnchorTag.
[Expand]
Inherited Constants
From interface com.microstrategy.web.tags.EnumHTMLTags
Public Methods
abstract int getChildStateToInclude()
Returns an integer value indicating how much child state should be added in the rendered link.
abstract int getEventElements()
Returns the setting that defines how much of the event information should be included in the renderd anchor tag
abstract String getHash()
Returns the value set using setHash(String)
abstract ParameterBuilder getParameterBuilder()
Returns the ParameterBuilder instance associated with this tag
abstract WebEvent getWebEvent()
Returns the WebEvent associated with this tag
abstract boolean isIFrameEvent()
Indicates whether the event associated with this tag should be treated as an iFrame event.
abstract void setChildStateToInclude(int howMuchChildState)
This defines how much child state should be added in the rendered link.
abstract void setEventElements(int eventElements)
Defines how much event information to include This is a value from EnumEventElement
abstract void setHash(String hash)
Sets the hash value to be append at the end of the href For instance, in the url http://server/test.jsp?abc=1#hv #hv would be the hash that you would need to specify
abstract void setParameterBuilder(ParameterBuilder builder)
Sets a valid ParameterBuilder instance.
abstract void setUseIFrame(boolean iFrame)
Indicates whether the event associated with this tag should be treated as an iFrame event.
abstract void setWebEvent(WebEvent event)
Sets a valid WebEvent associated with this tag Note the WebEvent passed in can also be an instance that supports multiple event
[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 TAG_NAME

The constant name of the AnchorTag.

Constant Value: "a"

Public Methods

public abstract int getChildStateToInclude ()

Returns an integer value indicating how much child state should be added in the rendered link. The default value is MINIMAL_STATE_INFO.

Returns
  • an integer value indicating how much child state should be added.

public abstract int getEventElements ()

Returns the setting that defines how much of the event information should be included in the renderd anchor tag

Returns

public abstract String getHash ()

Returns the value set using setHash(String)

Returns

public abstract ParameterBuilder getParameterBuilder ()

Returns the ParameterBuilder instance associated with this tag

Returns
  • an instance of ParameterBuilder.

public abstract WebEvent getWebEvent ()

Returns the WebEvent associated with this tag

Returns
  • an instance of WebEvent.

public abstract boolean isIFrameEvent ()

Indicates whether the event associated with this tag should be treated as an iFrame event. Returns the value set using setUseIFrame(boolean)

Returns
  • a boolean value indicating whether the associated event is an iFrame event.

public abstract void setChildStateToInclude (int howMuchChildState)

This defines how much child state should be added in the rendered link. This value is honored if the EventElementChildState bit is set in the parameter passed to the method setEventElements(int)

Parameters
howMuchChildState This is a value from EnumWebPersistableState

public abstract void setEventElements (int eventElements)

Defines how much event information to include This is a value from EnumEventElement

Parameters
eventElements an integer value indicating how much event information to include.

public abstract void setHash (String hash)

Sets the hash value to be append at the end of the href For instance, in the url http://server/test.jsp?abc=1#hv #hv would be the hash that you would need to specify

public abstract void setParameterBuilder (ParameterBuilder builder)

Sets a valid ParameterBuilder instance.

Parameters
builder an instance of ParameterBuilder.

public abstract void setUseIFrame (boolean iFrame)

Indicates whether the event associated with this tag should be treated as an iFrame event. If so, an HTML fragment "iframe=true" will be added to the rendered result.

Parameters
iFrame a boolean value indicating whether the associated event is an iFrame event.

public abstract void setWebEvent (WebEvent event)

Sets a valid WebEvent associated with this tag Note the WebEvent passed in can also be an instance that supports multiple event

Parameters
event an instance of WebEvent.c