Package com.microstrategy.web.tags
Interface ArgumentTag
-
- All Superinterfaces:
EnumHTMLTags
,Tag
,ValuefulTag
public interface ArgumentTag extends ValuefulTag
TheArgument
interface represents an argument of a method defined in either aTransform
orTransformable
.An argument has name, value, and type. The type could be any fully qualified class name, as well as those built in types such as
boolean, long, int, or string
. The argument value could come from aListTag
whose dynamic elements are cached in aLayoutContext
object and retrievable by the list tag name.- Since:
- MicroStrategy Web 8.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTR_NAME_ARG_TYPE
The constant name of the attributetype
.static java.lang.String
ATTR_NAME_BASE_PARAM
The constant name of the attributebase
.static java.lang.String
TAG_NAME_ARGUMENT
The constant name of theArgumentTag
.static java.lang.String
VALUE_NAME_TYPE_BOOLEAN
The Argument type ofboolean
.static java.lang.String
VALUE_NAME_TYPE_INTEGER
The Argument type ofint
.static java.lang.String
VALUE_NAME_TYPE_LONG
The Argument type oflong
.static java.lang.String
VALUE_NAME_TYPE_STRING
The Argument type ofstring
.-
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
-
Fields inherited from interface com.microstrategy.web.tags.ValuefulTag
ATTR_NAME_ARG_VALUE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getListName()
Returns the name of the list tag whose first element will serve as the current Argument tag's value.java.lang.Object
getResolvedValue(LayoutContext context)
Returns the resolved value of the current Argument tag.java.lang.Class
getType()
Returns the type class of the current Argument tag.void
setListName(java.lang.String listName)
Sets the name of a list tag whose first element will serve as the current Argument tag's value.void
setType(java.lang.String type)
Sets a type to the current Argument tag.-
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
-
Methods inherited from interface com.microstrategy.web.tags.ValuefulTag
getResolvedValue, setValue
-
-
-
-
Field Detail
-
TAG_NAME_ARGUMENT
static final java.lang.String TAG_NAME_ARGUMENT
The constant name of theArgumentTag
.- See Also:
- Constant Field Values
-
ATTR_NAME_BASE_PARAM
static final java.lang.String ATTR_NAME_BASE_PARAM
The constant name of the attributebase
.- Since:
- MicroStrategy Web 9.0.0
- See Also:
- Constant Field Values
-
ATTR_NAME_ARG_TYPE
static final java.lang.String ATTR_NAME_ARG_TYPE
The constant name of the attributetype
.- See Also:
- Constant Field Values
-
VALUE_NAME_TYPE_BOOLEAN
static final java.lang.String VALUE_NAME_TYPE_BOOLEAN
The Argument type ofboolean
.- See Also:
- Constant Field Values
-
VALUE_NAME_TYPE_LONG
static final java.lang.String VALUE_NAME_TYPE_LONG
The Argument type oflong
.- See Also:
- Constant Field Values
-
VALUE_NAME_TYPE_INTEGER
static final java.lang.String VALUE_NAME_TYPE_INTEGER
The Argument type ofint
.- See Also:
- Constant Field Values
-
VALUE_NAME_TYPE_STRING
static final java.lang.String VALUE_NAME_TYPE_STRING
The Argument type ofstring
.- See Also:
- Constant Field Values
-
-
Method Detail
-
getType
java.lang.Class getType() throws TypeUnsupportedException
Returns the type class of the current Argument tag. It is actually the value of the attibuteATTR_NAME_ARG_TYPE
.- Returns:
- the type class of the current Argument tag.
- Throws:
TypeUnsupportedException
- thrown if there is any error obtaining the Argument type.
-
setType
void setType(java.lang.String type) throws UnmodifiableException
Sets a type to the current Argument tag. It is actually the value of the attibuteATTR_NAME_ARG_TYPE
. Besides these predefined types, any fully qualified class name is a valid Argument type.- Parameters:
type
- the type to set.- Throws:
UnmodifiableException
- thrown if the current tag is read-only.
-
getListName
java.lang.String getListName()
Returns the name of the list tag whose first element will serve as the current Argument tag's value.- Returns:
- the name of the list tag.
-
setListName
void setListName(java.lang.String listName) throws UnmodifiableException
Sets the name of a list tag whose first element will serve as the current Argument tag's value.- Parameters:
listName
- the name of a list tag.- Throws:
UnmodifiableException
- thrown if the current tag is read-only.
-
getResolvedValue
java.lang.Object getResolvedValue(LayoutContext context) throws ArgumentUnresolvedException, EmptyListException
Returns the resolved value of the current Argument tag.- Parameters:
context
- theLayoutContext
within which the Argument value gets resolved.- Returns:
- the resolved value of the current Argument tag.
- Throws:
ArgumentUnresolvedException
- thrown if the Argument value can not be resolved.EmptyListException
- thrown if the named list contains no element within it.
-
-