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

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

All Implemented Interfaces:

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

public class Button
extends AbstractBaseTag
implements URLParams, IAttributeConsumer

Generates a button on the page with the specified attributes. The <netui:button> tag must be enclosed in <netui:form...> ... </netui:form> tags. You can specify the action that the form will raise on the <netui:form> tag.

Attribute Descriptions
Attribute	Required	Runtime Expression Evaluation	Data Bindable
accessKey	No	No	No
	Define the keyboard navigation key for the element.
action	No	No	No
	The overriding action caused by pressing this button.
alt	No	No	Read Only
	Define the alt attribute of the <Input> element.
disabled	No	No	Read Only
	A boolean value which if true will cause the Button to be disabled.
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.
type	No	No	No
	The type of button this is (defaults to 'submit').
value	No	No	Read Only
	The label of this button.

See Also:

Form, Serialized Form

Example:

In this sample, the <netui:button> submits data to the Controller file's processData action method (specified on the <netui:form>'s action attribute).

     <netui:form action="processData">
        <!--
        input elements here
        -->
        <netui:button value="Submit" type="submit"/>
     </netui:form>

Code Sample

[BEA_HOME]/weblogic81/samples/workshop/SamplesApp/WebApp/tagSamples/netui/button/index.jsp

Beadoc.see:

<netui:form> Tag Sample

Beadoc.tagdescription:

Renders an HTML button with the specified attributes. To submit data or invoke a method on the Controller file, the <netui:button> tag must a parent Form tag. The action attribute on the <netui:button> is for the purpose of overriding the action attribute on the enclosing <netui:form> tag. If no action attribute is specified on the <netui:button> tag, the action attribute on the <netui:form> tag will determine which action method is invoked.

Field Summary

protected String	action The action of this button.
static String	ACTION_OVERRIDE
protected String	text The body content of this tag (if any).
static String	TYPE
protected String	value The text of the button (this will override any body text).
static String	VALUE

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, USEMAP, VALIGN, 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

Button()

Method Summary

void	addParameter(String name, Object value) Adds a URL parameter to the generated hyperlink.
int	doAfterBody() Save the associated button label from the body content (if any).
int	doEndTag() Render the button.
int	doStartTag() Process the start of the Button.
String	getAccessKey() Gets the accessKey attribute value.
String	getAction() Return the action of the Button.
String	getAlt() Gets the alt attribute on the generate <input tag.
String	getDisabled() Returns the boolean value or expression indicating the disable state of the button.
String	getOnBlur() Gets the onBlur javascript event.
String	getOnChange() Gets the onChange javascript event.
String	getOnClick() Gets the onClick javascript event.
String	getOnDblClick() Gets the onDblClick javascript event.
String	getOnFocus() Gets the onFocus javascript event.
String	getOnKeyDown() Gets the onKeyDown javascript event.
String	getOnKeyPress() Gets the onKeyPress javascript event.
String	getOnKeyUp() Gets the onKeyUp javascript event.
String	getOnMouseDown() Gets the onMouseDown javascript event.
String	getOnMouseMove() Gets the onMouseMove javascript event.
String	getOnMouseOut() Gets the onMouseOut javascript event.
String	getOnMouseOver() Gets the onMouseOver javascript event.
String	getOnMouseUp() Gets the onMouseUp javascript event.
String	getOnSelect() Gets the onSelect javascript event.
String	getStyle() Gets the style of the rendered html tag.
String	getStyleClass() Gets the style class of the rendered html tag.
String	getTabindex() Gets the tabIndex of the rendered html tag.
String	getTagId() Return the ID of the button.
String	getTagName() Return the name of the Tag.
String	getType() Return the type of the Button.
String	getValue() Returns the value of the Button's text.
protected void	localRelease() Release any acquired resources.
void	setAccessKey(String accessKey) Sets the accessKey attribute value.
void	setAction(String action) Set the name of the action for the Button.
void	setAlt(String alt) Sets the alt attribute value.
void	setAttribute(String name, String value) Set an attribute value.
void	setDisabled(String disabled) Set the disable state either with the literal "true" or "false" or with an expression.
void	setOnBlur(String onblur) Sets the onBlur javascript event.
void	setOnChange(String onchange) Sets the onChange javascript event.
void	setOnClick(String onclick) Sets the onClick javascript event.
void	setOnDblClick(String ondblclick) Sets the onDblClick javascript event.
void	setOnFocus(String onfocus) Sets the onFocus javascript event.
void	setOnKeyDown(String onkeydown) Sets the onKeyDown javascript event.
void	setOnKeyPress(String onkeypress) Sets the onKeyPress javascript event.
void	setOnKeyUp(String onkeyup) Sets the onKeyUp javascript event.
void	setOnMouseDown(String onmousedown) Sets the onMouseDown javascript event.
void	setOnMouseMove(String onmousemove) Sets the onMouseMove javascript event.
void	setOnMouseOut(String onmouseout) Sets the onMouseOut javascript event.
void	setOnMouseOver(String onmouseover) Sets the onMouseOver javascript event.
void	setOnMouseUp(String onmouseup) Sets the onMouseUp javascript event.
void	setOnSelect(String onselect) Sets the onSelect javascript event.
void	setStyle(String style) Sets the style of the rendered html tag.
void	setStyleClass(String styleClass) Sets the style class of the rendered html tag.
void	setTabindex(String tabindex) Sets the tabIndex of the rendered html tag.
void	setTagId(String tagId) Set the ID of the button.
void	setType(String type) Set the type of the Button (submit, button, or reset).
void	setValue(String value) Set the value of the Button's text.

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

Field Detail

ACTION_OVERRIDE

public static final String ACTION_OVERRIDE

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

text

protected String text

The body content of this tag (if any).

action

protected String action

The action of this button. If an action is specified for this button, it will override the action of the enclosing Form tag.

value

protected String value

The text of the button (this will override any body text).

Constructor Detail

Button

public Button()

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

getAction

public String getAction()

Return the action of the Button.

Returns:

a String representing the action name of the Button.

setAction

public void setAction(String action)

Set the name of the action for the Button.

Parameters:

action - - the name of the action to set for the Button.

Beadoc.attributedescription:

The action method invoked. The value of this attribute will override the action attribute of the parent <netui:form> tag.

Beadoc.attributesyntaxvalue:

string_action

Beadoc.databindable:

false

getTagId

public String getTagId()

Return the ID of the button.

Returns:

the ID.

setTagId

public void setTagId(String tagId)

Set the ID of the button.

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

getDisabled

public String getDisabled()

Returns the boolean value or expression indicating the disable state of the button.

Returns:

the disabled state (true or false) or an expression

setDisabled

public void setDisabled(String disabled)

Set the disable state either with the literal "true" or "false" or with an expression.

Parameters:

disabled - - true or false or an expression

Beadoc.attributedescription:

Boolean. If set to true, the button will be visible, but diabled.

Beadoc.attributesyntaxvalue:

boolean_disabled

Beadoc.databindable:

Read Only

getType

public String getType()

Return the type of the Button.

Returns:

the Button type.

setType

public void setType(String type)

Set the type of the Button (submit, button, or reset).

Parameters:

type - - the type of the Button.

Beadoc.attributedescription:

The type of the button. Possible values are submit, button, or reset. The default value is submit.

Beadoc.attributesyntaxvalue:

string_type

Beadoc.databindable:

false

getValue

public String getValue()

Returns the value of the Button's text.

Returns:

the Button value.

setValue

public void setValue(String value)

Set the value of the Button's text.

Parameters:

value - - the value of the Button's text.

Beadoc.attributedescription:

The text displayed by the rendered HTML button.

Beadoc.attributesyntaxvalue:

string_value

Beadoc.databindable:

Read Only

addParameter

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

Adds a URL parameter to the generated hyperlink.

Specified by:

addParameter in interface URLParams

Parameters:

name - - the name of the parameter to be added.

value - - the value of the parameter to be added (a String or String[]).

Throws:

javax.servlet.jsp.JspException

doStartTag

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

Process the start of the Button.

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

Save the associated button label from the body content (if any).

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

Render the button.

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 AbstractBaseTag

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 tag in the sequence of page elements 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.

setStyle

public void setStyle(String style)

Sets the style of the rendered html tag.

Parameters:

style - - the html style.

Beadoc.attributedescription:

The style of the rendered HTML tag.

Beadoc.attributesyntaxvalue:

string_style

Beadoc.databindable:

false

getStyle

public String getStyle()

Gets the style of the rendered html tag.

Returns:

the style.

setStyleClass

public void setStyleClass(String styleClass)

Sets the style class of the rendered html tag.

Parameters:

styleClass - - the html style class.

Beadoc.attributedescription:

The class of the rendered HTML tag.

Beadoc.attributesyntaxvalue:

string_class

Beadoc.databindable:

false

getStyleClass

public String getStyleClass()

Gets the style class of the rendered html tag.

Returns:

the style class.

getAccessKey

public String getAccessKey()

Gets the accessKey attribute value.

Returns:

the accessKey value.

setAccessKey

public void setAccessKey(String accessKey)

Sets the accessKey attribute value. This should key value of the keyboard navigation key. It is recommended not to use the following values because there are often used by browsers A, C, E, F, G, H, V, left arrow, and right arrow.

Parameters:

accessKey - - the accessKey value.

Beadoc.attributedescription:

The keyboard navigation key for the element. The following values are not recommended because they are often used by browsers: A, C, E, F, G, H, V, left arrow, and right arrow

Beadoc.attributesyntaxvalue:

string_accessKey

Beadoc.databindable:

false

getAlt

public String getAlt()

Gets the alt attribute on the generate <input tag.

Returns:

the alt value.

setAlt

public void setAlt(String alt)

Sets the alt attribute value.

Parameters:

alt - - the alt value.

Beadoc.attributedescription:

The alt attribute of the element.

Beadoc.attributesyntaxvalue:

string_alt

Beadoc.databindable:

Read Only

getOnClick

public String getOnClick()

Gets the onClick javascript event.

Returns:

the onClick event.

setOnClick

public void setOnClick(String onclick)

Sets the onClick javascript event.

Parameters:

onclick - - the onClick event.

Beadoc.attributedescription:

The onClick JavaScript event.

Beadoc.attributesyntaxvalue:

string_onClick

Beadoc.databindable:

false

getOnDblClick

public String getOnDblClick()

Gets the onDblClick javascript event.

Returns:

the onDblClick event.

setOnDblClick

public void setOnDblClick(String ondblclick)

Sets the onDblClick javascript event.

Parameters:

ondblclick - - the onDblClick event.

Beadoc.attributedescription:

The onDblClick JavaScript event.

Beadoc.attributesyntaxvalue:

string_onDblClick

Beadoc.databindable:

false

getOnKeyDown

public String getOnKeyDown()

Gets the onKeyDown javascript event.

Returns:

the onKeyDown event.

setOnKeyDown

public void setOnKeyDown(String onkeydown)

Sets the onKeyDown javascript event.

Parameters:

onkeydown - - the onKeyDown event.

Beadoc.attributedescription:

The onKeyDown JavaScript event.

Beadoc.attributesyntaxvalue:

string_onKeyDown

Beadoc.databindable:

false

getOnKeyPress

public String getOnKeyPress()

Gets the onKeyPress javascript event.

Returns:

the onKeyPress event.

setOnKeyPress

public void setOnKeyPress(String onkeypress)

Sets the onKeyPress javascript event.

Parameters:

onkeypress - - the onKeyPress event.

Beadoc.attributedescription:

The onKeyPress JavaScript event.

Beadoc.attributesyntaxvalue:

string_onKeyPress

Beadoc.databindable:

false

getOnKeyUp

public String getOnKeyUp()

Gets the onKeyUp javascript event.

Returns:

the onKeyUp event.

setOnKeyUp

public void setOnKeyUp(String onkeyup)

Sets the onKeyUp javascript event.

Parameters:

onkeyup - - the onKeyUp event.

Beadoc.attributedescription:

The onKeyUp JavaScript event.

Beadoc.attributesyntaxvalue:

string_onKeyUp

Beadoc.databindable:

false

getOnMouseDown

public String getOnMouseDown()

Gets the onMouseDown javascript event.

Returns:

the onMouseDown event.

setOnMouseDown

public void setOnMouseDown(String onmousedown)

Sets the onMouseDown javascript event.

Parameters:

onmousedown - - the onMouseDown event.

Beadoc.attributedescription:

The onMouseDown JavaScript event.

Beadoc.attributesyntaxvalue:

string_onMouseDown

Beadoc.databindable:

false

getOnMouseMove

public String getOnMouseMove()

Gets the onMouseMove javascript event.

Returns:

the onMouseMove event.

setOnMouseMove

public void setOnMouseMove(String onmousemove)

Sets the onMouseMove javascript event.

Parameters:

onmousemove - - the onMouseMove event.

Beadoc.attributedescription:

The onMouseMove JavaScript event.

Beadoc.attributesyntaxvalue:

string_onMouseMove

Beadoc.databindable:

false

getOnMouseOut

public String getOnMouseOut()

Gets the onMouseOut javascript event.

Returns:

the onMouseOut event.

setOnMouseOut

public void setOnMouseOut(String onmouseout)

Sets the onMouseOut javascript event.

Parameters:

onmouseout - - the onMouseOut event.

Beadoc.attributedescription:

The onMouseOut JavaScript event.

Beadoc.attributesyntaxvalue:

string_onMouseOut

Beadoc.databindable:

false

getOnMouseOver

public String getOnMouseOver()

Gets the onMouseOver javascript event.

Returns:

the onMouseOver event.

setOnMouseOver

public void setOnMouseOver(String onmouseover)

Sets the onMouseOver javascript event.

Parameters:

onmouseover - - the onMouseOver event.

Beadoc.attributedescription:

The onMouseOver JavaScript event.

Beadoc.attributesyntaxvalue:

string_onMouseOver

Beadoc.databindable:

false

getOnMouseUp

public String getOnMouseUp()

Gets the onMouseUp javascript event.

Returns:

the onMouseUp event.

setOnMouseUp

public void setOnMouseUp(String onmouseup)

Sets the onMouseUp javascript event.

Parameters:

onmouseup - - the onMouseUp event.

Beadoc.attributedescription:

The onMouseUp JavaScript event.

Beadoc.attributesyntaxvalue:

string_onMouseUp

Beadoc.databindable:

false

getOnBlur

public String getOnBlur()

Gets the onBlur javascript event.

Returns:

the onBlur event.

setOnBlur

public void setOnBlur(String onblur)

Sets the onBlur javascript event.

Parameters:

onblur - - the onBlur event.

Beadoc.attributedescription:

The onBlur JavaScript event.

Beadoc.attributesyntaxvalue:

string_onBlur

Beadoc.databindable:

false

getOnFocus

public String getOnFocus()

Gets the onFocus javascript event.

Returns:

the onFocus event.

setOnFocus

public void setOnFocus(String onfocus)

Sets the onFocus javascript event.

Parameters:

onblur - - the onFocus event.

Beadoc.attributedescription:

The onFocus JavaScript event.

Beadoc.attributesyntaxvalue:

string_onFocus

Beadoc.databindable:

false

getOnChange

public String getOnChange()

Gets the onChange javascript event.

Returns:

the onChange event.

setOnChange

public void setOnChange(String onchange)

Sets the onChange javascript event.

Parameters:

onchange - - the onChange event.

Beadoc.attributedescription:

The onChange JavaScript event.

Beadoc.attributesyntaxvalue:

string_onChange

Beadoc.databindable:

false

getOnSelect

public String getOnSelect()

Gets the onSelect javascript event.

Returns:

the onSelect event.

setOnSelect

public void setOnSelect(String onselect)

Sets the onSelect javascript event.

Parameters:

onselect - - the onSelect event.

Beadoc.attributedescription:

The onSelect JavaScript event.

Beadoc.attributesyntaxvalue:

string_onSelect

Beadoc.databindable:

false