com.bea.wlw.netui.tags.html
Class Hidden

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          com.bea.wlw.netui.tags.AbstractBaseTag
              com.bea.wlw.netui.tags.DataSourceTag
                  com.bea.wlw.netui.tags.html.Hidden

All Implemented Interfaces:

HtmlConstants, IAttributeConsumer, Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class Hidden
extends DataSourceTag
implements IAttributeConsumer

Generates a hidden tag with a given value.

Attribute Descriptions
Attribute	Required	Runtime Expression Evaluation	Data Bindable
dataInput	No	No	Read Only
	The dataInput attribute overrides the dataSource for the input of the value. It allows a hidden field to read it's value from one place and return the value to a new destination. The dataInput attribute must be a data binding expression enclosed in curly braces, for example, {pageFlow.hiddenValue}
dataSource	Yes	No	Read / Write
	The name of a form bean property or an expression that resolves to a bean property.
tagId	No	No	No
	The ID of this button used by the enclosing html tag to get the tag's real ID attribute for JavaScript and focus purposes. The real ID attribute id is generated based upon this name.

See Also:

Serialized Form

Example:

In this sample, the <netui:hidden> gets it value from the Page Flow's hiddenValue property and writes its value (on submission of a <netui:form> tag that encloses it) to the Form Bean's hidden property.

      <netui:hidden dataSource="{actionForm.hidden}" dataInput="{pageFlow.hiddenValue}" />

Beadoc.tagdescription:

Generates an HTML hidden tag with a given value.

The dataInput attribute overrides the dataSource attribute for the input of the value. It allows a <netui:hidden> tag to read it's value from one place (whatever is referenced by the dataInput attribute) and submit the value to a new destination (whatever is referenced by the dataSource attribute). The dataInput attribute may take a String literal or a data binding expression.

Field Summary

Fields inherited from class com.bea.wlw.netui.tags.AbstractBaseTag

ATTR_GENERAL, ATTR_GENERAL_EXPRESSION, ATTR_JAVASCRIPT, ATTR_STYLE, JAVASCRIPT_STATUS, NETUI_UNIQUE_CNT

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface com.bea.wlw.netui.tags.html.HtmlConstants

ACCEPT, ACCESSKEY, ACTION, ALIGN, ALINK, ALT, ANCHOR, BACKGROUND, BASE, BGCOLOR, BODY, BORDER, BR, CAPTION, CELLPADDING, CELLSPACING, CHAR, CHAROFF, CHARSET, CHECKED, CLASS, COLS, COORDS, DIR, DISABLED, DIV, ENCTYPE, FOR, FORM, FORM_GET, FORM_POST, FRAME, HEIGHT, HREF, HREFLANG, HSPACE, HTML, ID, IMAGE, INPUT, INPUT_BUTTON, INPUT_CHECKBOX, INPUT_FILE, INPUT_HIDDEN, INPUT_IMAGE, INPUT_PASSWORD, INPUT_RADIO, INPUT_RESET, INPUT_SUBMIT, INPUT_TEXT, ISMAP, LABEL, LANG, LINK, LONGDESC, MAXLENGTH, METHOD, NAME, ONBLUR, ONCHANGE, ONCLICK, ONDBLCLICK, ONFOCUS, ONKEYDOWN, ONKEYPRESS, ONKEYUP, ONLOAD, ONMOUSEDOWN, ONMOUSEMOVE, ONMOUSEOUT, ONMOUSEOVER, ONMOUSEUP, ONRESET, ONSELECT, ONSUBMIT, ONUNLOAD, OPTION, READONLY, REL, REV, ROWS, RULES, SELECT, SHAPE, SIZE, SPAN, SRC, STYLE, SUMMARY, TABINDEX, TABLE, TARGET, TD, TEXT, TEXTAREA, TITLE, TR, TYPE, USEMAP, VALIGN, VALUE, VLINK, VSPACE, WIDTH

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Hidden()

Method Summary

int	doAfterBody()
int	doEndTag() Generate the hidden input tag.
int	doStartTag()
String	getDataInput() The value of the dataInput attribute.
String	getTabindex() Gets the tabIndex of the rendered html tag.
String	getTagId() Return the ID of the hidden.
String	getTagName() Return the name of the Tag.
protected void	localRelease() Release any acquired resources.
void	setAttribute(String name, String value) Set an attribute value.
void	setDataInput(String dataInput) Set the data input.
void	setTabindex(String tabindex) Sets the tabIndex of the rendered html tag.
void	setTagId(String tagId) Set the ID of the hidden.

Methods inherited from class com.bea.wlw.netui.tags.DataSourceTag

addNamingInterceptor, doNaming, evaluateDataSource, getDataSource, qualifyAttribute, removeNamingInterceptor, setDataSource

Methods inherited from class com.bea.wlw.netui.tags.AbstractBaseTag

addTagIdMapping, containsExpression, evaluateAttributeToString, evaluateExpression, filter, filter, formatErrorString, formatString, getAttribute, getErrorsReport, getExpressionEvaluator, getJavaScriptUtils, getNearestForm, getNextId, getQualifiedBundleName, getScriptReporter, getUserLocale, hasErrors, isExpression, prepForRendering, registerAttribute, registerError, registerTagError, release, removeAttribute, renderAttribute, renderAttributes, reportErrors, rewriteName, setPageContext, updateExpression, write

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setParent

Constructor Detail

Hidden

public Hidden()

Method Detail

getTagName

public String getTagName()

Return the name of the Tag.

Specified by:

getTagName in class AbstractBaseTag

setAttribute

public void setAttribute(String name,
                         String value)
                  throws javax.servlet.jsp.JspException

Set an attribute value. The name represents the name of the attribute. The value represents the value and may contain a netui expression. This method may result in errors being generated. This requires that the tag buffer its body and write attributes in the end tag. For the hidden tag it is not legal to set the id, name, type, or value attributes with this method.

Specified by:

setAttribute in interface IAttributeConsumer

Parameters:

name - The name of the attribute. This value may not be null or the empty string.

value - The value of the attribute. This may contain a netui expression.

Throws:

javax.servlet.jsp.JspException - A JspException may be thrown if there is an error setting the attribute.

getTagId

public String getTagId()

Return the ID of the hidden.

Returns:

the ID.

setTagId

public void setTagId(String tagId)

Set the ID of the hidden.

Parameters:

tagId - - the ID.

Beadoc.attributedescription:

String value. Sets the id (or name) attribute of the rendered HTML tag. Note that the real id attribute rendered in the browser may be changed by the application container (for example, Portal containers may change the rendered id value to ensure the uniqueness of id's on the page). In this case, the real id rendered in the browser may be looked up through the JavaScript function getNetuiTagName( tagId, tag ).

For example, assume that some tag's tagId attribute is set to foo.

    <netui:textBox tagId="foo" />

Then the following JavaScript function will return the real id attribute rendered in the browser:

    getNetuiTagName( "foo", this )

To get a <netui:form> element and all of its children elements in JavaScript, use the same JavaScript function getNetuiTagName( tagId, tag ). For example, assume that there is a <netui:form> whose tagId attribute is set to bar.

    <netui:form tagId="bar" >

Then the following JavaScript function will return the <netui:form> element and its children (packaged as an array).

    document[getNetuiTagName( "bar", this )]

To retreive the value entered into a <netui:textBox> within the <netui:form> tag, use the following JavaScript expression.

    document[getNetuiTagName("bar", this)][getNetuiTagName("foo", this)].value

The second parameter ensures that the JavaScript function begins its search within the correct Portlet scope. Pass the JavaScript keyword this as the second parameter. For detailed information on using the function getNetuiTagName( tagId, tag ) see Using JavaScript in Page Flow and Portal Applications.

Beadoc.attributesyntaxvalue:

string_tagId

Beadoc.databindable:

false

getDataInput

public String getDataInput()

The value of the dataInput attribute.

Returns:

the current value of the data input attribute.

setDataInput

public void setDataInput(String dataInput)

Set the data input. This value will override the dataSource and provide the input value on the select box.

Parameters:

dataInput - the value of the input to the page. This value may contain an expression.

Beadoc.attributedescription:

The dataInput attribute overrides the dataSource attribute for the input of the value. It allows a <netui:hidden> tag to read it's value from one place (whatever is referenced by the dataInput attribute) and return the value to a new destination (whatever is referenced by the dataSource attribute). This attribute may take a String literal or a data binding expression.

Beadoc.attributesyntaxvalue:

string_or_expression_dataInput

Beadoc.databindable:

Read Only

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException - if a JSP exception has occurred

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException - if a JSP exception has occurred

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Generate the hidden input tag.

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException - if a JSP exception has occurred

localRelease

protected void localRelease()

Release any acquired resources.

Overrides:

localRelease in class DataSourceTag

setTabindex

public void setTabindex(String tabindex)

Sets the tabIndex of the rendered html tag.

Parameters:

tabindex - - the tab index.

Beadoc.attributedescription:

The tabIndex of the rendered HTML tag. This attribute determines the position of the rendered HTML tag in the sequence of tags that the user may advance through by pressing the TAB key.

Beadoc.attributesyntaxvalue:

string_tabIndex

Beadoc.databindable:

false

getTabindex

public String getTabindex()

Gets the tabIndex of the rendered html tag.

Returns:

the tabindex.