# com.bea.wlw.netui.tags.html
Image Class

public class Image
extends `AbstractBaseTag`
implements `IAttributeConsumer`, `URLParams`

Generates an image with the specified attributes. Image ignores its body content.

Attribute Descriptions
Attribute | Required | Runtime Expression Evaluation | Data Bindable
--- | --- | --- | ---
align | No | No | No
Property to specify where to align the image.
alt | No | No | Read Only
Property to specify alt text of an image.
border | No | No | No
The border size around the image.
height | No | No | Read Only
The image height.
hspace | No | No | Read Only
The horizontal spacing around the image.
id | No | No | No
The `id` attribute has been deprecated; instead, use `tagId`. The id attribute of the generated Image. You should use the tagId which will encode the id correctly for containers such as the Portal which needs to rewrite id's to make them unique.
isMap | No | No | No
The server-side image map declaration.
location | No | No | No
The location hash to append to the url.
lowsrc | No | No | No
The low resolution image source URI.
page | No | No | No
The `page` attribute has been deprecated. The module-relative path of the image to be displayed by this rendered tag.
src | No | No | Read Only
The image source URI.
tagId | No | No | No
The id of this image. The real id written to the HTML stream may be changed by the container (Portal), but may be looked up with the `tagId` value through the JavaScript method `getNetuiTagName( tagId, tag )` method written by the <netui:html> tag.
useMap | No | No | No
The client-side image map declaration.
vspace | No | No | Read Only
The vertical spacing around the image.
width | No | No | Read Only
The image width.

Hierarchy
  `Object`
  `TagSupport`
  `BodyTagSupport`
  `AbstractBaseTag`
  `Image`

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

## Field Summary

`public static final `String`` | `SRC` String
`protected `String`` | `tagId` 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

Image()

## Method Summary

`public void` | `addParameter`(`String` name, `Object` value) Adds a URL parameter to the generated hyperlink.
`public int` | `doEndTag`() Render the end of the IMG tag.
`public int` | `doStartTag`() Render the beginning of the IMG tag.
`public `String`` | `getAlign`() Gets the property to specify where to align the image.
`public `String`` | `getAlt`() Gets the property to specify alt text of the image.
`public `String`` | `getBorder`() Gets the border size around the image.
`public `String`` | `getHeight`() Gets the image height.
`public `String`` | `getHspace`() Gets the horizontal spacing around the image.
`public `String`` | `getId`() Gets the image id.
`public `String`` | `getIsmap`() Gets the server-side image map declaration.
`public `String`` | `getLocation`() Gets the location hash to append to the url.
`public `String`` | `getLowsrc`() Gets the low resolution image source URI.
`public `String`` | `getOnClick`() Gets the onClick javascript event.
`public `String`` | `getOnDblClick`() Gets the onDblClick 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`` | `getPage`() Gets the module-relative path, starting with a slash character, of the image to be displayed by this rendered tag.
`public `String`` | `getSrc`() Gets the image source URI.
`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 image.
`public `String`` | `getTagName`() Return the name of the Tag.
`public `String`` | `getUsemap`() Gets the client-side image map declaration.
`public `String`` | `getVspace`() Gets the vertical spacing around the image.
`public `String`` | `getWidth`() Gets the image width.
`protected void` | `localRelease`() Release any acquired resources.
`public void` | `setAlign`(`String` align) Sets the property to specify where to align the image.
`public void` | `setAlt`(`String` alt) Sets the property to specify the alt text of the image.
`public void` | `setAttribute`(`String` name, `String` value) Set an attribute value.
`public void` | `setBorder`(`String` border) Sets the border size around the image.
`public void` | `setHeight`(`String` height) Sets the image height.
`public void` | `setHspace`(`String` hspace) Sets the the horizontal spacing around the image.
`public void` | `setId`(`String` id) Sets the image id.
`public void` | `setIsmap`(`String` ismap) Sets the server-side image map declaration.
`public void` | `setLocation`(`String` location) Sets the location hash to append to the url.
`public void` | `setLowsrc`(`String` lowsrc) Sets the the low resolution image source URI.
`public void` | `setOnClick`(`String` onclick) Sets the onClick javascript event.
`public void` | `setOnDblClick`(`String` ondblclick) Sets the onDblClick 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` | `setPage`(`String` page) Sets the module-relative path, starting with a slash character, of the image to be displayed by this rendered tag.
`public void` | `setSrc`(`String` src) Sets the image source URI.
`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 anchor.
`public void` | `setUsemap`(`String` usemap) Sets the client-side image map declaration.
`public void` | `setVspace`(`String` vspace) Sets the vertical spacing around the image.
`public void` | `setWidth`(`String` width) Sets the image width.

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``
`doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

Methods from `javax.servlet.jsp.tagext.`TagSupport``
`doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, 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

### SRC

    public static final String SRC

### tagId

    protected String tagId

## Constructor Detail

### Image

    public Image()

## 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``

### doEndTag() Method

    public int doEndTag()
         throws JspException

Render the end of the IMG tag.

Overrides
  `BodyTagSupport.doEndTag()`

#### Exceptions

``JspException``
  if a JSP exception has occurred

### doStartTag() Method

    public int doStartTag()
         throws JspException

Render the beginning of the IMG tag.

Overrides
  `BodyTagSupport.doStartTag()`

#### Exceptions

``JspException``
  if a JSP exception has occurred

### getAlign() Method

    public String getAlign()

Gets the property to specify where to align the image.

#### Returns

the image alignment.

### getAlt() Method

    public String getAlt()

Gets the property to specify alt text of the image.

#### Returns

the alt string.

### getBorder() Method

    public String getBorder()

Gets the border size around the image.

#### Returns

the border size.

### getHeight() Method

    public String getHeight()

Gets the image height.

#### Returns

the height.

### getHspace() Method

    public String getHspace()

Gets the horizontal spacing around the image.

#### Returns

the horizontal spacing.

### getId() Method

    public String getId()

Gets the image id.

Overrides
  `TagSupport.getId()`

#### Returns

the image id.

### getIsmap() Method

    public String getIsmap()

Gets the server-side image map declaration.

#### Returns

the image map declaration.

### getLocation() Method

    public String getLocation()

Gets the location hash to append to the url.

#### Returns

the location hash.

### getLowsrc() Method

    public String getLowsrc()

Gets the low resolution image source URI.

#### Returns

the low-res image source URI.

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

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

### getPage() Method

    public String getPage()

Gets the module-relative path, starting with a slash character, of the image to be displayed by this rendered tag.

#### Returns

the module-relative path.

### getSrc() Method

    public String getSrc()

Gets the image source URI.

#### Returns

the source URI.

### 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 image. The id may be rewritten by the container (such as a portal) to make sure it is unique. JavaScript my lookup the actual id of the element by looking it up in the `netui_names` table written into the HTML.

#### Returns

the tagId.

### getTagName() Method

    public String getTagName()

Return the name of the Tag.

Overrides
  `AbstractBaseTag.getTagName()`

### getUsemap() Method

    public String getUsemap()

Gets the client-side image map declaration.

#### Returns

the map declaration.

### getVspace() Method

    public String getVspace()

Gets the vertical spacing around the image.

#### Returns

the vertical spacing.

### getWidth() Method

    public String getWidth()

Gets the image width.

#### Returns

the image width.

### localRelease() Method

    protected void localRelease()

Release any acquired resources.

Overrides
  `AbstractBaseTag.localRelease()`

### setAlign(String) Method

    public void setAlign(String align)

Sets the property to specify where to align the image.

#### Parameters

align
  - the image alignment.

### setAlt(String) Method

    public void setAlt(String alt)

Sets the property to specify the alt text of the image.

#### Parameters

alt
  - the image alignment.

### 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 image tag it is not legal to set the `id`, `name`, or `src` 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.

### setBorder(String) Method

    public void setBorder(String border)

Sets the border size around the image.

#### Parameters

border
  - the border size.

### setHeight(String) Method

    public void setHeight(String height)

Sets the image height.

#### Parameters

height
  - the height.

### setHspace(String) Method

    public void setHspace(String hspace)

Sets the the horizontal spacing around the image.

#### Parameters

hspace
  - the horizontal spacing.

### setId(String) Method

    public void setId(String id)

Sets the image id.

Overrides
  `TagSupport.setId(String)`

#### Parameters

id
  - the image id

### setIsmap(String) Method

    public void setIsmap(String ismap)

Sets the server-side image map declaration.

#### Parameters

ismap
  - the image map declaration.

### setLocation(String) Method

    public void setLocation(String location)

Sets the location hash to append to the url.

#### Parameters

location
  - the location hash.

### setLowsrc(String) Method

    public void setLowsrc(String lowsrc)

Sets the the low resolution image source URI.

#### Parameters

lowsrc
  - the low-res image source URI.

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

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

### setPage(String) Method

    public void setPage(String page)

Sets the module-relative path, starting with a slash character, of the image to be displayed by this rendered tag.

#### Parameters

page
  - the module-relative path.

### setSrc(String) Method

    public void setSrc(String src)

Sets the image source URI.

#### Parameters

src
  - the source URI.

### 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 anchor.

#### Parameters

tagId
  - the tagId.

### setUsemap(String) Method

    public void setUsemap(String usemap)

Sets the client-side image map declaration.

#### Parameters

usemap
  - the map declaration.

### setVspace(String) Method

    public void setVspace(String vspace)

Sets the vertical spacing around the image.

#### Parameters

vspace
  - the vertical spacing.

### setWidth(String) Method

    public void setWidth(String width)

Sets the image width.

#### Parameters

width
  - the image width.