Package com.microstrategy.web.tags

Class AnchorTagImpl

java.lang.Object

com.microstrategy.web.tags.TagImpl

com.microstrategy.web.tags.AnchorTagImpl

All Implemented Interfaces:

AnchorTag, EnumHTMLTags, Tag, java.io.Serializable

Direct Known Subclasses:

AnchorWebTag

public class AnchorTagImpl
extends TagImpl
implements AnchorTag

The AnchorTagImpl class provides the default implementation of the interface AnchorTag.

Since:

MicroStrategy Web 8.0.0

See Also:

Serialized Form

Field Summary

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

TAG_NAME

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

Constructor Summary

Constructors

Constructor	Description
AnchorTagImpl()

Method Summary

Modifier and Type	Method	Description
int	getChildStateToInclude()	Returns an integer value indicating how much child state should be added in the rendered link.
int	getEventElements()	Returns the setting that defines how much of the event information should be included in the renderd anchor tag
java.lang.String	getHash()	Returns the value set using setHash(String)
ParameterBuilder	getParameterBuilder()	Returns the ParameterBuilder instance associated with this tag
WebEvent	getWebEvent()	Returns the WebEvent associated with this tag
boolean	isIFrameEvent()	Indicates whether the event associated with this tag should be treated as an iFrame event.
protected void	renderAllAttributes(MarkupOutput markup, LayoutContext context)	Renders all the attributes of this AnchorTag.
void	setChildStateToInclude(int howMuchChildState)	This defines how much child state should be added in the rendered link.
void	setEventElements(int eventElements)	Defines how much event information to include This is a value from EnumEventElement
void	setHash(java.lang.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
void	setParameterBuilder(ParameterBuilder builder)	Sets a valid ParameterBuilder instance.
void	setUseIFrame(boolean iFrame)	Indicates whether the event associated with this tag should be treated as an iFrame event.
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

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

Constructor Detail

AnchorTagImpl

public AnchorTagImpl()

Method Detail

getParameterBuilder

public ParameterBuilder getParameterBuilder()

Returns the ParameterBuilder instance associated with this tag

Specified by:

getParameterBuilder in interface AnchorTag

Returns:

an instance of ParameterBuilder.

See Also:

setParameterBuilder(ParameterBuilder)

setParameterBuilder

public void setParameterBuilder(ParameterBuilder builder)

Sets a valid ParameterBuilder instance.

Specified by:

setParameterBuilder in interface AnchorTag

Parameters:

builder - an instance of ParameterBuilder.

See Also:

ContainerServices.newHiddenInputParameterBuilder(), ContainerServices.newURIParameterBuilder()

getWebEvent

public WebEvent getWebEvent()

Returns the WebEvent associated with this tag

Specified by:

getWebEvent in interface AnchorTag

Returns:

an instance of WebEvent.

setWebEvent

public 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

Specified by:

setWebEvent in interface AnchorTag

Parameters:

event - an instance of WebEvent.c

See Also:

WebEventHandlerFactory.newMultipleEventHelper()

renderAllAttributes

protected void renderAllAttributes(MarkupOutput markup,
                                   LayoutContext context)
                            throws MalformedMethodException

Renders all the attributes of this AnchorTag.

Overrides:

renderAllAttributes in class TagImpl

Parameters:

markup - the MarkupOutput object to store the rendered results

context - the LayoutContext object

Throws:

MalformedMethodException - thrown if there is any rendering error.

getEventElements

public int getEventElements()

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

Specified by:

getEventElements in interface AnchorTag

Returns:

the value set by setEventElements(int)

setEventElements

public void setEventElements(int eventElements)

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

Specified by:

setEventElements in interface AnchorTag

Parameters:

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

getChildStateToInclude

public int getChildStateToInclude()

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

Specified by:

getChildStateToInclude in interface AnchorTag

Returns:

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

See Also:

setChildStateToInclude(int)

setChildStateToInclude

public void setChildStateToInclude(int howMuchChildState)

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

Specified by:

setChildStateToInclude in interface AnchorTag

Parameters:

howMuchChildState - This is a value from EnumWebPersistableState

isIFrameEvent

public boolean isIFrameEvent()

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

Specified by:

isIFrameEvent in interface AnchorTag

Returns:

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

setUseIFrame

public 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.

Specified by:

setUseIFrame in interface AnchorTag

Parameters:

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

getHash

public java.lang.String getHash()

Returns the value set using setHash(String)

Specified by:

getHash in interface AnchorTag

Returns:

value set using setHash(String)

setHash

public void setHash(java.lang.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

Specified by:

setHash in interface AnchorTag

Parameters:

hash -