NetUI Tag Library Documentation (Version 1.0.2)

netui
netui:button Tag

Renders an <input type="button"> tag with the specified attributes.

Syntax

<netui:button
    [accessKey="string_accessKey"]
    [action="string_action"]
    [alt="string_alt"]
    [dir="string_dir"]
    [disableSecondClick="boolean_disableSecondClick"]
    [disabled="boolean_disabled"]
    [lang="string_lang"]
    [onBlur="string_onBlur"]
    [onChange="string_onChange"]
    [onClick="string_onClick"]
    [onDblClick="string_onDblClick"]
    [onFocus="string_onFocus"]
    [onKeyDown="string_onKeyDown"]
    [onKeyPress="string_onKeyPress"]
    [onKeyUp="string_onKeyUp"]
    [onMouseDown="string_onMouseDown"]
    [onMouseMove="string_onMouseMove"]
    [onMouseOut="string_onMouseOut"]
    [onMouseOver="string_onMouseOver"]
    [onMouseUp="string_onMouseUp"]
    [onSelect="string_onSelect"]
    [popup="boolean_popup"]
    [renderAsButton="boolean_renderAsButton"]
    [style="string_style"]
    [styleClass="string_styleClass"]
    [tabindex="string_tabIndex"]
    [tagId="string_tagId"]
    [targetScope="string_targetScope"]
    [title="string_title"]
    [type="string_type"]
    [value="string_value"] >
    ... JSP content ...
</netui:button>

Description

Renders an <input type="button"> tag with the specified attributes. To submit data or invoke a method on the Controller file, the <netui:button> tag must have a parent <netui: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.

This tag can also render a <button> control to allow richer rendering possibilities. When the renderAsButton attribute is set to true, we render the markup with an HTML <button> tag, using the value attribute, and placing the evaluated body content as the content between the begin and end HTML button tags.

Please note that using the action override and rendering the markup with a <button> control will not work in Internet Explorer. Internet Explorer includes the name and value of every <button> control in the HTML form as parameters in the request query, regardless of whether the button has been clicked or not. The action override attribute renders a name attribute on the HTML tag. This name is used to identified by the NetUI request processor to determine if an action method other than the one on the <netui:form> tag should be invoked. With IE, the name attribute of the <button> control will always be included in the parameters or the request query and NetUI will assume an action override button was clicked, leading to incorrect behavior.

Attributes
accessKey
Required: No  |   Type: char  |   Supports runtime evaluation / JSP Expression Language: Yes

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
action
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The action method invoked. The value of this attribute will override the action attribute of the parent <netui:form> tag.
alt
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The alt attribute of the element.
dir
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Specifies the direction of text. (LTR | RTL)
disableSecondClick
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

Boolean. If disableSecondClick is set to true, the button will disable itself before submitting.
disabled
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the disable state either with the literal "true" or "false" or with an expression.
lang
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the language code for the base language of an element's attribute values and text content.
onBlur
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onBlur JavaScript event.
onChange
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onChange JavaScript event.
onClick
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onClick JavaScript event.
onDblClick
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onDblClick JavaScript event.
onFocus
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onFocus JavaScript event.
onKeyDown
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyDown JavaScript event.
onKeyPress
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyPress JavaScript event.
onKeyUp
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyUp JavaScript event.
onMouseDown
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseDown JavaScript event.
onMouseMove
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseMove JavaScript event.
onMouseOut
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseOut JavaScript event.
onMouseOver
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseOver JavaScript event.
onMouseUp
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseUp JavaScript event.
onSelect
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onSelect JavaScript event.
popup
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

Boolean. If popup is set to true, the button will open a popup window.
renderAsButton
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

Boolean. If renderAsButton is set to true, render a <button> rather than an <input> tag.
style
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Specifies style information for the current element.
styleClass
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The style class (a style sheet selector).
tabindex
Required: No  |   Type: int  |   Supports runtime evaluation / JSP Expression Language: Yes

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.
tagId
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

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 lookupIdByTagId( 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:

    lookupIdByTagId( "foo", this )

To get a <netui:form> element and all of its children elements in JavaScript, use the same JavaScript function lookupIdByTagId( 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[lookupIdByTagId( "bar", this )]

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

    document[lookupIdByTagId("bar", this)][lookupIdByTagId("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.

targetScope
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The target scope in which the associated action's page flow resides.
title
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The title.
type
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The type of the button. Possible values are submit, button, or reset. The default value is submit.
value
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The text displayed by the rendered HTML button.

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>


Tag Information
Tag Classorg.apache.beehive.netui.tags.html.Button
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone