Button Class

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

public class Button

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.

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.

Related Topics

<netui:form> Tag Sample
Form

Hierarchy: Object
  TagSupport
    BodyTagSupport
      AbstractBaseTag
        Button

All Implemented Interfaces: BodyTag, IAttributeConsumer, IterationTag, Serializable, Tag, URLParams

Field Summary

`protected String`	`action` The action of this button.
`public static final String`	`ACTION_OVERRIDE` String
`protected String`	`buttonValue` String
`protected String`	`text` The body content of this tag (if any).
`protected String`	`type` The type of button this is (submit, button, or reset).
`public static final String`	`TYPE` String
`protected String`	`value` The text of the button (this will override any body text).
`public static final String`	`VALUE` String

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

ATTR_GENERAL, ATTR_GENERAL_EXPRESSION, ATTR_JAVASCRIPT, ATTR_STYLE, CLASS, ID, JAVASCRIPT_STATUS, NAME, NETUI_UNIQUE_CNT, ONCLICK, ONDBLCLICK, ONKEYDOWN, ONKEYPRESS, ONKEYUP, ONMOUSEDOWN, ONMOUSEMOVE, ONMOUSEOUT, ONMOUSEOVER, ONMOUSEUP, STYLE, TABINDEX

Fields from javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields from javax.servlet.jsp.tagext.TagSupport

id, pageContext

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

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Button()

Method Summary

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

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

addTagIdMapping, evaluateAttributeToString, filter, filter, getJavaScriptUtils, getNearestForm, getScriptReporter, getUserLocale, registerTagError, release, renderAttribute, rewriteName, write

Methods from javax.servlet.jsp.tagext.BodyTagSupport

doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

Methods from javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods from class java.lang.Object

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

Methods from interface javax.servlet.jsp.tagext.BodyTag

doInitBody, setBodyContent

Methods from interface com.bea.wlw.netui.tags.IAttributeConsumer

setAttribute

Methods from interface javax.servlet.jsp.tagext.IterationTag

doAfterBody

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

doEndTag, doStartTag, getParent, release, setPageContext, setParent

Methods from interface com.bea.wlw.netui.tags.html.URLParams

addParameter

Field Detail

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.

ACTION_OVERRIDE

public static final String ACTION_OVERRIDE

buttonValue

protected String buttonValue

text

protected String text

The body content of this tag (if any).

type

protected String type

The type of button this is (submit, button, or reset).

TYPE

public static final String TYPE

value

protected String value

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

VALUE

public static final String VALUE

Constructor Detail

Button

public Button()

Method Detail

addParameter(String, Object) Method

public void addParameter(String name, 
                         Object value)
     throws JspException

Adds a URL parameter to the generated hyperlink.

Parameters

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

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

Exceptions

JspException

doAfterBody() Method

public int doAfterBody()
     throws JspException

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

Overrides: BodyTagSupport.doAfterBody()

Exceptions

JspException: if a JSP exception has occurred

doEndTag() Method

public int doEndTag()
     throws JspException

Render the button.

Overrides: BodyTagSupport.doEndTag()

Exceptions

JspException: if a JSP exception has occurred

doStartTag() Method

public int doStartTag()
     throws JspException

Process the start of the Button.

Overrides: BodyTagSupport.doStartTag()

Exceptions

JspException: if a JSP exception has occurred

getAccessKey() Method

public String getAccessKey()

Gets the accessKey attribute value.

Returns

the accessKey value.

getAction() Method

public String getAction()

Return the action of the Button.

Returns

a String representing the action name of the Button.

getAlt() Method

public String getAlt()

Gets the alt attribute on the generate <input tag.

Returns

the alt value.

getDisabled() Method

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

getOnBlur() Method

public String getOnBlur()

Gets the onBlur javascript event.

Returns

the onBlur event.

getOnChange() Method

public String getOnChange()

Gets the onChange javascript event.

Returns

the onChange event.

getOnClick() Method

public String getOnClick()

Gets the onClick javascript event.

Returns

the onClick event.

getOnDblClick() Method

public String getOnDblClick()

Gets the onDblClick javascript event.

Returns

the onDblClick event.

getOnFocus() Method

public String getOnFocus()

Gets the onFocus javascript event.

Returns

the onFocus event.

getOnKeyDown() Method

public String getOnKeyDown()

Gets the onKeyDown javascript event.

Returns

the onKeyDown event.

getOnKeyPress() Method

public String getOnKeyPress()

Gets the onKeyPress javascript event.

Returns

the onKeyPress event.

getOnKeyUp() Method

public String getOnKeyUp()

Gets the onKeyUp javascript event.

Returns

the onKeyUp event.

getOnMouseDown() Method

public String getOnMouseDown()

Gets the onMouseDown javascript event.

Returns

the onMouseDown event.

getOnMouseMove() Method

public String getOnMouseMove()

Gets the onMouseMove javascript event.

Returns

the onMouseMove event.

getOnMouseOut() Method

public String getOnMouseOut()

Gets the onMouseOut javascript event.

Returns

the onMouseOut event.

getOnMouseOver() Method

public String getOnMouseOver()

Gets the onMouseOver javascript event.

Returns

the onMouseOver event.

getOnMouseUp() Method

public String getOnMouseUp()

Gets the onMouseUp javascript event.

Returns

the onMouseUp event.

getOnSelect() Method

public String getOnSelect()

Gets the onSelect javascript event.

Returns

the onSelect event.

getStyle() Method

public String getStyle()

Gets the style of the rendered html tag.

Returns

the style.

getStyleClass() Method

public String getStyleClass()

Gets the style class of the rendered html tag.

Returns

the style class.

getTabindex() Method

public String getTabindex()

Gets the tabIndex of the rendered html tag.

Returns

the tabindex.

getTagId() Method

public String getTagId()

Return the ID of the button.

Returns

the ID.

getTagName() Method

public String getTagName()

Return the name of the Tag.

Overrides: AbstractBaseTag.getTagName()

getType() Method

public String getType()

Return the type of the Button.

Returns

the Button type.

getValue() Method

public String getValue()

Returns the value of the Button's text.

Returns

the Button value.

localRelease() Method

protected void localRelease()

Release any acquired resources.

Overrides: AbstractBaseTag.localRelease()

setAccessKey(String) Method

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.

setAction(String) Method

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.

setAlt(String) Method

public void setAlt(String alt)

Sets the alt attribute value.

Parameters

alt: - the alt value.

setAttribute(String, String) Method

public void setAttribute(String name, 
                         String value)
     throws 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.

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.

Exceptions

JspException: A JspException may be thrown if there is an error setting the attribute.

setDisabled(String) Method

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

setOnBlur(String) Method

public void setOnBlur(String onblur)

Sets the onBlur javascript event.

Parameters

onblur: - the onBlur event.

setOnChange(String) Method

public void setOnChange(String onchange)

Sets the onChange javascript event.

Parameters

onchange: - the onChange event.

setOnClick(String) Method

public void setOnClick(String onclick)

Sets the onClick javascript event.

Parameters

onclick: - the onClick event.

setOnDblClick(String) Method

public void setOnDblClick(String ondblclick)

Sets the onDblClick javascript event.

Parameters

ondblclick: - the onDblClick event.

setOnFocus(String) Method

public void setOnFocus(String onblur)

Sets the onFocus javascript event.

Parameters

onblur: - the onFocus event.

setOnKeyDown(String) Method

public void setOnKeyDown(String onkeydown)

Sets the onKeyDown javascript event.

Parameters

onkeydown: - the onKeyDown event.

setOnKeyPress(String) Method

public void setOnKeyPress(String onkeypress)

Sets the onKeyPress javascript event.

Parameters

onkeypress: - the onKeyPress event.

setOnKeyUp(String) Method

public void setOnKeyUp(String onkeyup)

Sets the onKeyUp javascript event.

Parameters

onkeyup: - the onKeyUp event.

setOnMouseDown(String) Method

public void setOnMouseDown(String onmousedown)

Sets the onMouseDown javascript event.

Parameters

onmousedown: - the onMouseDown event.

setOnMouseMove(String) Method

public void setOnMouseMove(String onmousemove)

Sets the onMouseMove javascript event.

Parameters

onmousemove: - the onMouseMove event.

setOnMouseOut(String) Method

public void setOnMouseOut(String onmouseout)

Sets the onMouseOut javascript event.

Parameters

onmouseout: - the onMouseOut event.

setOnMouseOver(String) Method

public void setOnMouseOver(String onmouseover)

Sets the onMouseOver javascript event.

Parameters

onmouseover: - the onMouseOver event.

setOnMouseUp(String) Method

public void setOnMouseUp(String onmouseup)

Sets the onMouseUp javascript event.

Parameters

onmouseup: - the onMouseUp event.

setOnSelect(String) Method

public void setOnSelect(String onselect)

Sets the onSelect javascript event.

Parameters

onselect: - the onSelect event.

setStyle(String) Method

public void setStyle(String style)

Sets the style of the rendered html tag.

Parameters

style: - the html style.

setStyleClass(String) Method

public void setStyleClass(String styleClass)

Sets the style class of the rendered html tag.

Parameters

styleClass: - the html style class.

setTabindex(String) Method

public void setTabindex(String tabindex)

Sets the tabIndex of the rendered html tag.

Parameters

tabindex: - the tab index.

setTagId(String) Method

public void setTagId(String tagId)

Set the ID of the button.

Parameters

tagId: - the ID.

setType(String) Method

public void setType(String type)

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

Parameters

type: - the type of the Button.

setValue(String) Method

public void setValue(String value)

Set the value of the Button's text.

Parameters

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

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

Field Summary

Constructor Summary

Method Summary

Field Detail

action

ACTION_OVERRIDE

buttonValue

text

type

TYPE

value

VALUE

Constructor Detail

Button

Method Detail

addParameter(String, Object) Method

Parameters

Exceptions

doAfterBody() Method

Exceptions

doEndTag() Method

Exceptions

doStartTag() Method

Exceptions

getAccessKey() Method

Returns

getAction() Method

Returns

getAlt() Method

Returns

getDisabled() Method

Returns

getOnBlur() Method

Returns

getOnChange() Method

Returns

getOnClick() Method

Returns

getOnDblClick() Method

Returns

getOnFocus() Method

Returns

getOnKeyDown() Method

Returns

getOnKeyPress() Method

Returns

getOnKeyUp() Method

Returns

getOnMouseDown() Method

Returns

getOnMouseMove() Method

Returns

getOnMouseOut() Method

Returns

getOnMouseOver() Method

Returns

getOnMouseUp() Method

Returns

getOnSelect() Method

Returns

getStyle() Method

Returns

getStyleClass() Method

Returns

getTabindex() Method

Returns

getTagId() Method

Returns

getTagName() Method

getType() Method

Returns

getValue() Method

Returns

localRelease() Method

setAccessKey(String) Method

Parameters

setAction(String) Method

Parameters

setAlt(String) Method

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