|
BEA NetUI tags and APIs are included for backward compatibility only. For new applications, use the Beehive tags and APIs. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.servlet.jsp.tagext.TagSupport javax.servlet.jsp.tagext.BodyTagSupport com.bea.wlw.netui.tags.AbstractBaseTag com.bea.wlw.netui.tags.html.Image
public class Image
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. |
<netui:image src="friends.jpg" id="Friends" height="150" width="175" />
Field Summary | |
---|---|
static String |
SRC
|
protected String |
tagId
|
Fields inherited from class com.bea.wlw.netui.tags.AbstractBaseTag |
---|
ATTR_GENERAL, ATTR_GENERAL_EXPRESSION, ATTR_JAVASCRIPT, ATTR_STYLE, JAVASCRIPT_STATUS, NETUI_UNIQUE_CNT |
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
---|
bodyContent |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
pageContext |
Fields inherited from interface com.bea.wlw.netui.tags.html.HtmlConstants |
---|
ACCEPT, ACCESSKEY, ACTION, ALIGN, ALINK, ALT, ANCHOR, BACKGROUND, BASE, BGCOLOR, BODY, BORDER, BR, CAPTION, CELLPADDING, CELLSPACING, CHAR, CHAROFF, CHARSET, CHECKED, CLASS, COLS, COORDS, DIR, DISABLED, DIV, ENCTYPE, FOR, FORM, FORM_GET, FORM_POST, FRAME, HEIGHT, HREF, HREFLANG, HSPACE, HTML, ID, IMAGE, INPUT, INPUT_BUTTON, INPUT_CHECKBOX, INPUT_FILE, INPUT_HIDDEN, INPUT_IMAGE, INPUT_PASSWORD, INPUT_RADIO, INPUT_RESET, INPUT_SUBMIT, INPUT_TEXT, ISMAP, LABEL, LANG, LINK, LONGDESC, MAXLENGTH, METHOD, NAME, ONBLUR, ONCHANGE, ONCLICK, ONDBLCLICK, ONFOCUS, ONKEYDOWN, ONKEYPRESS, ONKEYUP, ONLOAD, ONMOUSEDOWN, ONMOUSEMOVE, ONMOUSEOUT, ONMOUSEOVER, ONMOUSEUP, ONRESET, ONSELECT, ONSUBMIT, ONUNLOAD, OPTION, READONLY, REL, REV, ROWS, RULES, SELECT, SHAPE, SIZE, SPAN, STYLE, SUMMARY, TABINDEX, TABLE, TARGET, TD, TEXT, TEXTAREA, TITLE, TR, TYPE, USEMAP, VALIGN, VALUE, VLINK, VSPACE, WIDTH |
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag |
---|
EVAL_BODY_BUFFERED, EVAL_BODY_TAG |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
---|
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
---|---|
Image()
|
Method Summary | |
---|---|
void |
addParameter(String name,
Object value)
Adds a URL parameter to the generated hyperlink. |
int |
doEndTag()
Render the end of the IMG tag. |
int |
doStartTag()
Render the beginning of the IMG tag. |
String |
getAlign()
Gets the property to specify where to align the image. |
String |
getAlt()
Gets the property to specify alt text of the image. |
String |
getBorder()
Gets the border size around the image. |
String |
getHeight()
Gets the image height. |
String |
getHspace()
Gets the horizontal spacing around the image. |
String |
getId()
Gets the image id. |
String |
getIsmap()
Gets the server-side image map declaration. |
String |
getLocation()
Gets the location hash to append to the url. |
String |
getLowsrc()
Gets the low resolution image source URI. |
String |
getOnClick()
Gets the onClick javascript event. |
String |
getOnDblClick()
Gets the onDblClick javascript event. |
String |
getOnKeyDown()
Gets the onKeyDown javascript event. |
String |
getOnKeyPress()
Gets the onKeyPress javascript event. |
String |
getOnKeyUp()
Gets the onKeyUp javascript event. |
String |
getOnMouseDown()
Gets the onMouseDown javascript event. |
String |
getOnMouseMove()
Gets the onMouseMove javascript event. |
String |
getOnMouseOut()
Gets the onMouseOut javascript event. |
String |
getOnMouseOver()
Gets the onMouseOver javascript event. |
String |
getOnMouseUp()
Gets the onMouseUp javascript event. |
String |
getPage()
Gets the module-relative path, starting with a slash character, of the image to be displayed by this rendered tag. |
String |
getSrc()
Gets the image source URI. |
String |
getStyle()
Gets the style of the rendered html tag. |
String |
getStyleClass()
Gets the style class of the rendered html tag. |
String |
getTabindex()
Gets the tabIndex of the rendered html tag. |
String |
getTagId()
Return the ID of the image. |
String |
getTagName()
Return the name of the Tag. |
String |
getUsemap()
Gets the client-side image map declaration. |
String |
getVspace()
Gets the vertical spacing around the image. |
String |
getWidth()
Gets the image width. |
protected void |
localRelease()
Release any acquired resources. |
void |
setAlign(String align)
Sets the property to specify where to align the image. |
void |
setAlt(String alt)
Sets the property to specify the alt text of the image. |
void |
setAttribute(String name,
String value)
Set an attribute value. |
void |
setBorder(String border)
Sets the border size around the image. |
void |
setHeight(String height)
Sets the image height. |
void |
setHspace(String hspace)
Sets the the horizontal spacing around the image. |
void |
setId(String id)
Sets the image id. |
void |
setIsmap(String ismap)
Sets the server-side image map declaration. |
void |
setLocation(String location)
Sets the location hash to append to the url. |
void |
setLowsrc(String lowsrc)
Sets the the low resolution image source URI. |
void |
setOnClick(String onclick)
Sets the onClick javascript event. |
void |
setOnDblClick(String ondblclick)
Sets the onDblClick javascript event. |
void |
setOnKeyDown(String onkeydown)
Sets the onKeyDown javascript event. |
void |
setOnKeyPress(String onkeypress)
Sets the onKeyPress javascript event. |
void |
setOnKeyUp(String onkeyup)
Sets the onKeyUp javascript event. |
void |
setOnMouseDown(String onmousedown)
Sets the onMouseDown javascript event. |
void |
setOnMouseMove(String onmousemove)
Sets the onMouseMove javascript event. |
void |
setOnMouseOut(String onmouseout)
Sets the onMouseOut javascript event. |
void |
setOnMouseOver(String onmouseover)
Sets the onMouseOver javascript event. |
void |
setOnMouseUp(String onmouseup)
Sets the onMouseUp javascript event. |
void |
setPage(String page)
Sets the module-relative path, starting with a slash character, of the image to be displayed by this rendered tag. |
void |
setSrc(String src)
Sets the image source URI. |
void |
setStyle(String style)
Sets the style of the rendered html tag. |
void |
setStyleClass(String styleClass)
Sets the style class of the rendered html tag. |
void |
setTabindex(String tabindex)
Sets the tabIndex of the rendered html tag. |
void |
setTagId(String tagId)
Set the ID of the anchor. |
void |
setUsemap(String usemap)
Sets the client-side image map declaration. |
void |
setVspace(String vspace)
Sets the vertical spacing around the image. |
void |
setWidth(String width)
Sets the image width. |
protected String |
src()
Return the base source URL that will be rendered in the src
property for this generated element, or null if there is
no such URL. |
protected String |
url(String url)
Return the specified src URL, modified as necessary with optional request parameters. |
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
---|
doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
findAncestorWithClass, getParent, getValue, getValues, removeValue, setParent, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.jsp.tagext.Tag |
---|
getParent, setParent |
Field Detail |
---|
public static final String SRC
protected String tagId
Constructor Detail |
---|
public Image()
Method Detail |
---|
public String getTagName()
getTagName
in class AbstractBaseTag
public void setAttribute(String name, String value) throws javax.servlet.jsp.JspException
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.
setAttribute
in interface IAttributeConsumer
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.
javax.servlet.jsp.JspException
- A JspException may be thrown if there is an error setting the attribute.public String getAlign()
public void setAlign(String align)
align
- - the image alignment.public String getAlt()
public void setAlt(String alt)
alt
- - the image alt text.public String getBorder()
public void setBorder(String border)
border
- - the border size.public String getHeight()
public void setHeight(String height)
height
- - the height.public String getHspace()
public void setHspace(String hspace)
hspace
- - the horizontal spacing.public String getId()
getId
in class javax.servlet.jsp.tagext.TagSupport
public void setId(String id)
setId
in class javax.servlet.jsp.tagext.TagSupport
id
- - the image idpublic String getTagId()
netui_names
table written
into the HTML.
public void setTagId(String tagId)
tagId
- - the tagId.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 getNetuiTagName( 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:
getNetuiTagName( "foo", this )
To get a <netui:form> element and all of its children elements in JavaScript, use
the same JavaScript function getNetuiTagName( 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[getNetuiTagName( "bar", this )]
To retreive the value entered into a <netui:textBox> within the <netui:form> tag, use the following JavaScript expression.
document[getNetuiTagName("bar", this)][getNetuiTagName("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.
For detailed information on using the function
getNetuiTagName( tagId, tag )
see
Using JavaScript in Page Flow and Portal Applications.
public String getIsmap()
public void setIsmap(String ismap)
ismap
- - the image map declaration.public String getLocation()
public void setLocation(String location)
location
- - the location hash.public String getLowsrc()
public void setLowsrc(String lowsrc)
lowsrc
- - the low-res image source URI.public String getPage()
public void setPage(String page)
page
- - the module-relative path.public String getSrc()
public void setSrc(String src)
src
- - the source URI.public String getUsemap()
public void setUsemap(String usemap)
usemap
- - the map declaration.public String getVspace()
public void setVspace(String vspace)
vspace
- - the vertical spacing.public String getWidth()
public void setWidth(String width)
width
- - the image width.public void addParameter(String name, Object value) throws javax.servlet.jsp.JspException
addParameter
in interface URLParams
name
- - the name of the parameter to be added.value
- - the value of the parameter to be added (a String or String[]).
javax.servlet.jsp.JspException
public int doStartTag() throws javax.servlet.jsp.JspException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
- if a JSP exception has occurredpublic int doEndTag() throws javax.servlet.jsp.JspException
doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
- if a JSP exception has occurredprotected void localRelease()
localRelease
in class AbstractBaseTag
protected String src() throws javax.servlet.jsp.JspException
src
property for this generated element, or null
if there is
no such URL.
javax.servlet.jsp.JspException
- if an error occursprotected String url(String url) throws javax.servlet.jsp.JspException
url
- The URL to be modified (or null if this url will not be used)
javax.servlet.jsp.JspException
- if an error occurs preparing the URLpublic void setTabindex(String tabindex)
tabindex
- - the tab index.public String getTabindex()
public void setStyle(String style)
style
- - the html style.public String getStyle()
public void setStyleClass(String styleClass)
styleClass
- - the html style class.public String getStyleClass()
public String getOnClick()
public void setOnClick(String onclick)
onclick
- - the onClick event.public String getOnDblClick()
public void setOnDblClick(String ondblclick)
ondblclick
- - the onDblClick event.public String getOnKeyDown()
public void setOnKeyDown(String onkeydown)
onkeydown
- - the onKeyDown event.public String getOnKeyPress()
public void setOnKeyPress(String onkeypress)
onkeypress
- - the onKeyPress event.public String getOnKeyUp()
public void setOnKeyUp(String onkeyup)
onkeyup
- - the onKeyUp event.public String getOnMouseDown()
public void setOnMouseDown(String onmousedown)
onmousedown
- - the onMouseDown event.public String getOnMouseMove()
public void setOnMouseMove(String onmousemove)
onmousemove
- - the onMouseMove event.public String getOnMouseOut()
public void setOnMouseOut(String onmouseout)
onmouseout
- - the onMouseOut event.public String getOnMouseOver()
public void setOnMouseOver(String onmouseover)
onmouseover
- - the onMouseOver event.public String getOnMouseUp()
public void setOnMouseUp(String onmouseup)
onmouseup
- - the onMouseUp event.
|
BEA NetUI tags and APIs are included for backward compatibility only. For new applications, use the Beehive tags and APIs. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |