Package com.microstrategy.web.tags
Interface DynamicTag
-
- All Superinterfaces:
EnumHTMLTags
,Tag
- All Known Subinterfaces:
AttrTag
,BaseTag
,DisplayTag
,IfTag
,ListTag
,RenderTag
,ReplaceTag
,SlotTag
- All Known Implementing Classes:
BaseTagImpl
,DisplayTagImpl
,ReplaceTagImpl
,SlotTagImpl
,WebBlockAppendListTagImpl
,WebBlockEditBlockTagImpl
,WebBlockEditListTagImpl
,WebBlockEditTagImpl
,WebBlockSetPropertyTagImpl
public interface DynamicTag extends Tag
TheDynamicTag
interface contains dynamic contents whose result can only be determined at the runtime.The dynamic contents are generated from a method call. The method could be defined in either a transformable or a transform.
- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTR_NAME_METHOD
The constant name of the attributemethod name
.static java.lang.String
ATTR_NAME_METHOD_BASE
The constant name of the attributemethod base
.static java.lang.String
ATTR_NAME_NAME
The constant name of the attributemethod name
.static int
METHOD_SOURCE_BEAN
Specifies that the method source is a transformable.static java.lang.String
METHOD_SOURCE_BEAN_NAME
The constant name of the attributebean
.static int
METHOD_SOURCE_OBJECT
Specifies that the method source is a base objectstatic int
METHOD_SOURCE_TRANSFORM
Specifies that the method source is a transform.static java.lang.String
METHOD_SOURCE_TRANSFORM_NAME
The constant name of the attributetransform
.-
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addArgument(ArgumentTag tag)
Adds anArgumentTag
as a child of the current tag.void
addOnException(OnExceptionTag tag)
Adds anOnExceptionTag
as a child of the current tag.java.util.Enumeration
getArguments()
Returns anEnumeration
over all the arguments of the method from which the dynamic contents are generated.java.lang.String
getMethodName()
Returns the method name from which the dynamic contents are generated.int
getMethodSource()
Returns the method source in which the method is defined.java.util.Enumeration
getOnExceptions()
Returns anEnumeration
over all the exception tags associated with the method from which the dynamic contents are generated.java.lang.Object
invokeMethod(MarkupOutput markup, LayoutContext context)
Invokes the method to generate the dynamic contents.void
setMethodName(java.lang.String methodName)
Sets the method name from which the dynamic contents are generated.void
setMethodSource(java.lang.String source)
Sets the method source in which the method is defined.-
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
-
ATTR_NAME_METHOD_BASE
static final java.lang.String ATTR_NAME_METHOD_BASE
The constant name of the attributemethod base
.- See Also:
- Constant Field Values
-
ATTR_NAME_METHOD
static final java.lang.String ATTR_NAME_METHOD
The constant name of the attributemethod name
.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
ATTR_NAME_NAME
static final java.lang.String ATTR_NAME_NAME
The constant name of the attributemethod name
.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
METHOD_SOURCE_BEAN_NAME
static final java.lang.String METHOD_SOURCE_BEAN_NAME
The constant name of the attributebean
.- See Also:
- Constant Field Values
-
METHOD_SOURCE_TRANSFORM_NAME
static final java.lang.String METHOD_SOURCE_TRANSFORM_NAME
The constant name of the attributetransform
.- See Also:
- Constant Field Values
-
METHOD_SOURCE_BEAN
static final int METHOD_SOURCE_BEAN
Specifies that the method source is a transformable.- See Also:
- Constant Field Values
-
METHOD_SOURCE_TRANSFORM
static final int METHOD_SOURCE_TRANSFORM
Specifies that the method source is a transform.- See Also:
- Constant Field Values
-
METHOD_SOURCE_OBJECT
static final int METHOD_SOURCE_OBJECT
Specifies that the method source is a base object- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
getMethodName
java.lang.String getMethodName()
Returns the method name from which the dynamic contents are generated. The method name is actually the value of the attibuteATTR_NAME_METHOD
.- Returns:
- the method name.
-
setMethodName
void setMethodName(java.lang.String methodName) throws UnmodifiableException
Sets the method name from which the dynamic contents are generated. The method name is actually the value of the attibuteATTR_NAME_METHOD
.- Parameters:
methodName
- the method name.- Throws:
UnmodifiableException
- thrown if the current tag is read-only.
-
getArguments
java.util.Enumeration getArguments()
Returns anEnumeration
over all the arguments of the method from which the dynamic contents are generated.- Returns:
- an
Enumeration
over all the arguments.
-
addArgument
void addArgument(ArgumentTag tag) throws UnmodifiableException
Adds anArgumentTag
as a child of the current tag.- Parameters:
tag
- anArgumentTag
to be added.- Throws:
UnmodifiableException
- thrown if the current tag is read-only.
-
addOnException
void addOnException(OnExceptionTag tag) throws UnmodifiableException
Adds anOnExceptionTag
as a child of the current tag.- Parameters:
tag
- anOnExceptionTag
to be added.- Throws:
UnmodifiableException
- thrown if the current tag is read-only.- Since:
- MicroStrategy Web 9.0.0
-
getOnExceptions
java.util.Enumeration getOnExceptions()
Returns anEnumeration
over all the exception tags associated with the method from which the dynamic contents are generated.- Returns:
- an
Enumeration
over all theOnExceptionTag
tags. - Since:
- MicroStrategy Web 9.0.0
-
getMethodSource
int getMethodSource()
Returns the method source in which the method is defined. Method source can be one of the following- Returns:
- the method source.
-
setMethodSource
void setMethodSource(java.lang.String source) throws UnmodifiableException
Sets the method source in which the method is defined. Method source can be one of the following- Parameters:
source
- the method source.- Throws:
UnmodifiableException
- thrown if the current tag is read-only.
-
invokeMethod
java.lang.Object invokeMethod(MarkupOutput markup, LayoutContext context) throws MalformedMethodException, EmptyListException
Invokes the method to generate the dynamic contents.- Parameters:
markup
- aMarkupOutput
object which could be the first parameter of the method if the current tag is aRenderTag
.context
- aLayoutContext
object from which the method source and list values are cached.- Returns:
- the return value of the method call.
- Throws:
MalformedMethodException
- thrown if there is any exception making the method call.EmptyListException
- thrown if theList
cached in theLayoutContext
is empty.
-
-