NetUI Tag Library Documentation (Version 1.0.2)

netui
netui:imageButton Tag

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

Syntax

<netui:imageButton
    [accessKey="string_accessKey"]
    [align="string_align"]
    [alt="string_alt"]
    [dir="string_dir"]
    [disabled="boolean_disabled"]
    [ismap="string_ismap"]
    [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"]
    [rolloverImage="string_rolloverImage"]
    [src="string_src"]
    [style="string_style"]
    [styleClass="string_styleClass"]
    [tabindex="string_tabIndex"]
    [tagId="string_tagId"]
    [title="string_title"]
    [usemap="string_usemap"]
    [value="string_value"] >
    ... JSP content ...
</netui:imageButton>

Description

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

JavaScript

If the <netui:imageButton> specifies a rolloverImage attribute, the following JavaScript will be written to the page:

    function swapImage(control, image)
    {
        control.src = image;
    }

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

The alignment of the image.
alt
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The alternative text of the image
dir
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Specifies the direction of text. (LTR | RTL)
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.
ismap
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the ismap of for the map.
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.
rolloverImage
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The URI of the rollover image.
src
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The image source URI
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 rendered HTML tag in the sequence of tags 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.

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

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

Sets the usemap of for the map.
value
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The value of the image button.

Example

In this sample, an <netui:imageButton> tag displays the image "house.jpg". On mouseover, the image "house_highlight.jpg" is displayed. When clicked, the <netui:imageButton> will invoke the action specified by its parent <netui:form> tag.

    <netui:form action="formSubmit">
         <netui:imageButton rolloverImage="house_highlight.jpg" src="house.jpg" />
     </netui:form>


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