public interface

InputTag

implements Tag
com.microstrategy.web.tags.InputTag

Class Overview

The InputTag represents a HTML input tag.

Summary

Constants
String ENCODED_DEFAULT_TAG_NAME_PREFIX The constant prefix for the encoded value of the name attribute.
String ENCODED_IMAGE_NAME_PREFIX The constant prefix for the encoded value of the name attribute.
[Expand]
Inherited Constants
From interface com.microstrategy.web.tags.EnumHTMLTags
Public Methods
abstract String getType()
Returns the value of the attribute type for the input tag.
abstract String getValue()
Returns the value of the attribute value for the input tag.
abstract boolean isDefault()
Returns a boolean value indicating whether the current tag is default.
abstract void setChecked(boolean checked)
Sets a value to the attribute checked for the input tag.
abstract void setDefault(boolean isDefault)
Sets a boolean value indicating whether the current tag is default.
abstract void setTitle(String title)
Sets a value to the attribute title for the input tag.
abstract void setType(String type)
Sets a value to the attribute type for the input tag.
abstract void setValue(String value)
Sets a value to the attribute value for the input tag.
[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 ENCODED_DEFAULT_TAG_NAME_PREFIX

The constant prefix for the encoded value of the name attribute.

Constant Value: "defArg."

public static final String ENCODED_IMAGE_NAME_PREFIX

The constant prefix for the encoded value of the name attribute. The encoded value in turn is a name-value pair for an image.

Constant Value: "encNameVal."

Public Methods

public abstract String getType ()

Returns the value of the attribute type for the input tag.

Returns
  • the value of the attribute type.

public abstract String getValue ()

Returns the value of the attribute value for the input tag.

Returns
  • the value of the attribute value.

public abstract boolean isDefault ()

Returns a boolean value indicating whether the current tag is default. A default input tag will generate a hidden input tag before generating the content for the current input tag.

Returns
  • true to indicate that the current tag is default.

public abstract void setChecked (boolean checked)

Sets a value to the attribute checked for the input tag. It is equivalent to call the method setAttribute(ATT_CHECKED, checked).

Parameters
checked a value of the attribute checked.
Throws
UnmodifiableException thrown if the current tag is read-only.

public abstract void setDefault (boolean isDefault)

Sets a boolean value indicating whether the current tag is default. A default input tag will generate a hidden input tag before generating the content for the current input tag.

Parameters
isDefault true to indicate that the current tag is default.
Throws
UnmodifiableException thrown if the current tag is read-only.

public abstract void setTitle (String title)

Sets a value to the attribute title for the input tag. It is equivalent to call the method setAttribute(ATT_TITLE, title).

Parameters
title a value of the attribute title.
Throws
UnmodifiableException thrown if the current tag is read-only.

public abstract void setType (String type)

Sets a value to the attribute type for the input tag. It is equivalent to call the method setAttribute(ATT_TYPE, type).

Parameters
type a value of the attribute type.
Throws
UnmodifiableException thrown if the current tag is read-only.

public abstract void setValue (String value)

Sets a value to the attribute value for the input tag. It is equivalent to call the method setAttribute(ATT_VALUE, value).

Parameters
value a value of the attribute value.
Throws
UnmodifiableException thrown if the current tag is read-only.