Package com.microstrategy.web.tags

Interface AnchorTag

All Superinterfaces:

EnumHTMLTags, Tag

All Known Implementing Classes:

AnchorTagImpl, AnchorWebTag

public interface AnchorTag
extends Tag

The AnchorTag represents a HTML anchor tag.

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TAG_NAME	The constant name of the AnchorTag.

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

static final java.lang.String TAG_NAME

The constant name of the AnchorTag.

See Also:

Constant Field Values

Method Detail

getParameterBuilder

ParameterBuilder getParameterBuilder()

Returns the ParameterBuilder instance associated with this tag

Returns:

an instance of ParameterBuilder.

See Also:

setParameterBuilder(ParameterBuilder)

setParameterBuilder

void setParameterBuilder(ParameterBuilder builder)

Sets a valid ParameterBuilder instance.

Parameters:

builder - an instance of ParameterBuilder.

See Also:

ContainerServices.newHiddenInputParameterBuilder(), ContainerServices.newURIParameterBuilder()

getWebEvent

WebEvent getWebEvent()

Returns the WebEvent associated with this tag

Returns:

an instance of WebEvent.

setWebEvent

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

See Also:

WebEventHandlerFactory.newMultipleEventHelper()

getChildStateToInclude

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.

Returns:

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

See Also:

setChildStateToInclude(int)

setChildStateToInclude

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)

Parameters:

howMuchChildState - This is a value from EnumWebPersistableState

getEventElements

int getEventElements()

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

Returns:

the value set by setEventElements(int)

setEventElements

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.

isIFrameEvent

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.

setUseIFrame

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.

getHash

java.lang.String getHash()

Returns the value set using setHash(String)

Returns:

value set using setHash(String)

setHash

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

Parameters:

hash -