NetUI Tag Library Documentation (Version 1.0.2)

netui
netui:area Tag

Generates a URL-encoded area to a specified URI.

Syntax

<netui:area
    [accessKey="string_accessKey"]
    [action="string_action"]
    [alt="string_alt"]
    [coords="string_coordinates"]
    [dir="string_dir"]
    [disableSecondClick="boolean_disableSecondClick"]
    [formSubmit="boolean_formSubmit"]
    [href="string_href"]
    [lang="string_lang"]
    [location="string_location"]
    [onBlur="string_onBlur"]
    [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"]
    [popup="boolean_popup"]
    [shape="string_shape"]
    [style="string_style"]
    [styleClass="string_styleClass"]
    [tabindex="string_tabIndex"]
    [tagId="string_tagId"]
    [targetScope="string_targetScope"]
    [title="string_title"] >
    ... JSP content ...
</netui:area>

Description

Generates a URL-encoded area to a specified URI.

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 to invoke. The action method must be in the Controller file of the Page Flow directory.
alt
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Specifies alternate text for the area.
coords
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The coordinates.
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 anchor will disable itself after being clicked.
formSubmit
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

Boolean. If formSubmit is set to true, and the <netui:anchor> tag is within a <netui:form> tag, then the form data will be submitted to the method named in the <netui:form> tag's action attribute.
href
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The URL to go to; if the URL needs parameters, use the parameter tag to get proper encoding of special characters in the parameters.
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.
location
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Location within the URI to visit.
onBlur
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onBlur 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.
popup
Required: No  |   Type: boolean  |   Supports runtime evaluation / JSP Expression Language: Yes

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

The shape.
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.

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.

Example

In this sample, an area tag is written with the shape, coords, href, and alt attributes, for an image map associated with the "someDefaultPic.jpg" image.

The following <netui> tags...

    <netui:image src="someDefaultPic.jpg" alt="a default picture" usemap="#defaultMap"/>
    <map id="defaultMap" name="defaultMap">
        <netui:area shape="rect" coords="0,0,80,80" href="bigPicture.jsp" alt="big picture of the image"/>
    </map>

...output the following HTML:

    <img src="someDefaultPic.jpg" usemap="#defaultMap" alt="a default picture">
    <map id="defaultMap" name="defaultMap">
        <area href="bigPicture.jsp" shape="rect" alt="big picture of the image" coords="0,0,80,80">
    </map>


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

See Also

<netui:attribute> Tag

String