Top Description Inners Fields Constructors Methods
javax.faces.component.html

public Class HtmlGraphicImage

extends UIGraphic
implements ClientBehaviorHolder
Class Inheritance
All Implemented Interfaces
javax.faces.component.behavior.ClientBehaviorHolder
Imports
java.io.IOException, java.util.ArrayList, .Arrays, .Collection, .Collections, .List, javax.faces.context.FacesContext, javax.faces.component.behavior.ClientBehaviorHolder, javax.el.MethodExpression, .ValueExpression

Represents an HTML img element, used to retrieve and render a graphical image.

By default, the rendererType property must be set to "javax.faces.Image". This value can be changed by calling the setRendererType() method.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static enum

Field Summary

Modifier and TypeField and Description
public static final String
COMPONENT_TYPE

Hides javax.faces.component.UIGraphic.COMPONENT_TYPE.

The standard component type for this component.

private static final Collection<String>
private static final String
Inherited from javax.faces.component.UIGraphic:
COMPONENT_FAMILY

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the property value

Contents: Alternate textual description of the element rendered by this component.

getAlt
()

Return the value of the alt property.

public String
getDefaultEventName()

Overrides javax.faces.component.UIComponentBase.getDefaultEventName.

Implements javax.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Returns the default event name for this ClientBehaviorHolder implementation.

public String

Returns:

the property value

Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.

getDir
()

Return the value of the dir property.

public Collection<String>
getEventNames()

Overrides javax.faces.component.UIComponentBase.getEventNames.

Implements javax.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface.

public String

Returns:

the property value

Contents: Override for the height of this image.

getHeight
()

Return the value of the height property.

public String

Returns:

the property value

Contents: Code describing the language used in the generated markup for this component.

getLang
()

Return the value of the lang property.

public String

Returns:

the property value

Contents: URI to a long description of the image represented by this element.

getLongdesc
()

Return the value of the longdesc property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is clicked over this element.

getOnclick
()

Return the value of the onclick property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is double clicked over this element.

getOndblclick
()

Return the value of the ondblclick property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is pressed down over this element.

getOnkeydown
()

Return the value of the onkeydown property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is pressed and released over this element.

getOnkeypress
()

Return the value of the onkeypress property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is released over this element.

getOnkeyup
()

Return the value of the onkeyup property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is pressed down over this element.

getOnmousedown
()

Return the value of the onmousedown property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved within this element.

getOnmousemove
()

Return the value of the onmousemove property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved away from this element.

getOnmouseout
()

Return the value of the onmouseout property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved onto this element.

getOnmouseover
()

Return the value of the onmouseover property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is released over this element.

getOnmouseup
()

Return the value of the onmouseup property.

public String

Returns:

the property value

Contents:

Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to.

It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

getRole
()

Return the value of the role property.

public String

Returns:

the property value

Contents: CSS style(s) to be applied when this component is rendered.

getStyle
()

Return the value of the style property.

public String

Returns:

the property value

Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

getStyleClass
()

Return the value of the styleClass property.

public String

Returns:

the property value

Contents: Advisory title information about markup elements generated for this component.

getTitle
()

Return the value of the title property.

public String

Returns:

the property value

Contents: The name of a client side image map (an HTML "map" element) for which this element provides the image.

getUsemap
()

Return the value of the usemap property.

public String

Returns:

the property value

Contents: Override for the width of this image.

getWidth
()

Return the value of the width property.

private void
public boolean

Returns:

the property value

Contents: Flag indicating that this image is to be used as a server side image map. Such an image must be enclosed within a hyperlink ("a"). A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as ismap="ismap".

isIsmap
()

Return the value of the ismap property.

public void
setAlt(String
the new property value
alt
)

Set the value of the alt property.

public void
setDir(String
the new property value
dir
)

Set the value of the dir property.

public void
setHeight(String
the new property value
height
)

Set the value of the height property.

public void
setIsmap(boolean
the new property value
ismap
)

Set the value of the ismap property.

public void
setLang(String
the new property value
lang
)

Set the value of the lang property.

public void
setLongdesc(String
the new property value
longdesc
)

Set the value of the longdesc property.

public void
setOnclick(String
the new property value
onclick
)

Set the value of the onclick property.

public void
setOndblclick(String
the new property value
ondblclick
)

Set the value of the ondblclick property.

public void
setOnkeydown(String
the new property value
onkeydown
)

Set the value of the onkeydown property.

public void
setOnkeypress(String
the new property value
onkeypress
)

Set the value of the onkeypress property.

public void
setOnkeyup(String
the new property value
onkeyup
)

Set the value of the onkeyup property.

public void
setOnmousedown(String
the new property value
onmousedown
)

Set the value of the onmousedown property.

public void
setOnmousemove(String
the new property value
onmousemove
)

Set the value of the onmousemove property.

public void
setOnmouseout(String
the new property value
onmouseout
)

Set the value of the onmouseout property.

public void
setOnmouseover(String
the new property value
onmouseover
)

Set the value of the onmouseover property.

public void
setOnmouseup(String
the new property value
onmouseup
)

Set the value of the onmouseup property.

public void
setRole(String
the new property value
role
)

Set the value of the role property.

public void
setStyle(String
the new property value
style
)

Set the value of the style property.

public void
setStyleClass(String
the new property value
styleClass
)

Set the value of the styleClass property.

public void
setTitle(String
the new property value
title
)

Set the value of the title property.

public void
setUsemap(String
the new property value
usemap
)

Set the value of the usemap property.

public void
setWidth(String
the new property value
width
)

Set the value of the width property.

Inherited from javax.faces.component.UIGraphic:
getFamilygetUrlgetValuegetValueBindinggetValueExpressionsetUrlsetValuesetValueBindingsetValueExpression

Field Detail

COMPONENT_TYPEback to summary
public static final String COMPONENT_TYPE

Hides javax.faces.component.UIGraphic.COMPONENT_TYPE.

The standard component type for this component.

EVENT_NAMESback to summary
private static final Collection<String> EVENT_NAMES
OPTIMIZED_PACKAGEback to summary
private static final String OPTIMIZED_PACKAGE

Constructor Detail

HtmlGraphicImageback to summary
public HtmlGraphicImage()

Method Detail

getAltback to summary
public String getAlt()

Return the value of the alt property.

Returns:String

the property value

Contents: Alternate textual description of the element rendered by this component.

getDefaultEventNameback to summary
public String getDefaultEventName()

Overrides javax.faces.component.UIComponentBase.getDefaultEventName.

Implements javax.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Doc from javax.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Returns the default event name for this ClientBehaviorHolder implementation. This must be one of the event names returned by getEventNames or null if the component does not have a default event.

Returns:String

the default event name.

getDirback to summary
public String getDir()

Return the value of the dir property.

Returns:String

the property value

Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.

getEventNamesback to summary
public Collection<String> getEventNames()

Overrides javax.faces.component.UIComponentBase.getEventNames.

Implements javax.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Doc from javax.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface.

Returns:Collection<String>

an unmodifiable collection of event names.

getHeightback to summary
public String getHeight()

Return the value of the height property.

Returns:String

the property value

Contents: Override for the height of this image.

getLangback to summary
public String getLang()

Return the value of the lang property.

Returns:String

the property value

Contents: Code describing the language used in the generated markup for this component.

getLongdescback to summary
public String getLongdesc()

Return the value of the longdesc property.

Returns:String

the property value

Contents: URI to a long description of the image represented by this element.

getOnclickback to summary
public String getOnclick()

Return the value of the onclick property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is clicked over this element.

getOndblclickback to summary
public String getOndblclick()

Return the value of the ondblclick property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is double clicked over this element.

getOnkeydownback to summary
public String getOnkeydown()

Return the value of the onkeydown property.

Returns:String

the property value

Contents: Javascript code executed when a key is pressed down over this element.

getOnkeypressback to summary
public String getOnkeypress()

Return the value of the onkeypress property.

Returns:String

the property value

Contents: Javascript code executed when a key is pressed and released over this element.

getOnkeyupback to summary
public String getOnkeyup()

Return the value of the onkeyup property.

Returns:String

the property value

Contents: Javascript code executed when a key is released over this element.

getOnmousedownback to summary
public String getOnmousedown()

Return the value of the onmousedown property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is pressed down over this element.

getOnmousemoveback to summary
public String getOnmousemove()

Return the value of the onmousemove property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is moved within this element.

getOnmouseoutback to summary
public String getOnmouseout()

Return the value of the onmouseout property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is moved away from this element.

getOnmouseoverback to summary
public String getOnmouseover()

Return the value of the onmouseover property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is moved onto this element.

getOnmouseupback to summary
public String getOnmouseup()

Return the value of the onmouseup property.

Returns:String

the property value

Contents: Javascript code executed when a pointer button is released over this element.

getRoleback to summary
public String getRole()

Return the value of the role property.

Returns:String

the property value

Contents:

Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to.

It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

getStyleback to summary
public String getStyle()

Return the value of the style property.

Returns:String

the property value

Contents: CSS style(s) to be applied when this component is rendered.

getStyleClassback to summary
public String getStyleClass()

Return the value of the styleClass property.

Returns:String

the property value

Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

getTitleback to summary
public String getTitle()

Return the value of the title property.

Returns:String

the property value

Contents: Advisory title information about markup elements generated for this component.

getUsemapback to summary
public String getUsemap()

Return the value of the usemap property.

Returns:String

the property value

Contents: The name of a client side image map (an HTML "map" element) for which this element provides the image.

getWidthback to summary
public String getWidth()

Return the value of the width property.

Returns:String

the property value

Contents: Override for the width of this image.

handleAttributeback to summary
private void handleAttribute(String name, Object value)
isIsmapback to summary
public boolean isIsmap()

Return the value of the ismap property.

Returns:boolean

the property value

Contents: Flag indicating that this image is to be used as a server side image map. Such an image must be enclosed within a hyperlink ("a"). A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as ismap="ismap".

setAltback to summary
public void setAlt(String alt)

Set the value of the alt property.

Parameters
alt:String

the new property value

setDirback to summary
public void setDir(String dir)

Set the value of the dir property.

Parameters
dir:String

the new property value

setHeightback to summary
public void setHeight(String height)

Set the value of the height property.

Parameters
height:String

the new property value

setIsmapback to summary
public void setIsmap(boolean ismap)

Set the value of the ismap property.

Parameters
ismap:boolean

the new property value

setLangback to summary
public void setLang(String lang)

Set the value of the lang property.

Parameters
lang:String

the new property value

setLongdescback to summary
public void setLongdesc(String longdesc)

Set the value of the longdesc property.

Parameters
longdesc:String

the new property value

setOnclickback to summary
public void setOnclick(String onclick)

Set the value of the onclick property.

Parameters
onclick:String

the new property value

setOndblclickback to summary
public void setOndblclick(String ondblclick)

Set the value of the ondblclick property.

Parameters
ondblclick:String

the new property value

setOnkeydownback to summary
public void setOnkeydown(String onkeydown)

Set the value of the onkeydown property.

Parameters
onkeydown:String

the new property value

setOnkeypressback to summary
public void setOnkeypress(String onkeypress)

Set the value of the onkeypress property.

Parameters
onkeypress:String

the new property value

setOnkeyupback to summary
public void setOnkeyup(String onkeyup)

Set the value of the onkeyup property.

Parameters
onkeyup:String

the new property value

setOnmousedownback to summary
public void setOnmousedown(String onmousedown)

Set the value of the onmousedown property.

Parameters
onmousedown:String

the new property value

setOnmousemoveback to summary
public void setOnmousemove(String onmousemove)

Set the value of the onmousemove property.

Parameters
onmousemove:String

the new property value

setOnmouseoutback to summary
public void setOnmouseout(String onmouseout)

Set the value of the onmouseout property.

Parameters
onmouseout:String

the new property value

setOnmouseoverback to summary
public void setOnmouseover(String onmouseover)

Set the value of the onmouseover property.

Parameters
onmouseover:String

the new property value

setOnmouseupback to summary
public void setOnmouseup(String onmouseup)

Set the value of the onmouseup property.

Parameters
onmouseup:String

the new property value

setRoleback to summary
public void setRole(String role)

Set the value of the role property.

Parameters
role:String

the new property value

setStyleback to summary
public void setStyle(String style)

Set the value of the style property.

Parameters
style:String

the new property value

setStyleClassback to summary
public void setStyleClass(String styleClass)

Set the value of the styleClass property.

Parameters
styleClass:String

the new property value

setTitleback to summary
public void setTitle(String title)

Set the value of the title property.

Parameters
title:String

the new property value

setUsemapback to summary
public void setUsemap(String usemap)

Set the value of the usemap property.

Parameters
usemap:String

the new property value

setWidthback to summary
public void setWidth(String width)

Set the value of the width property.

Parameters
width:String

the new property value

javax.faces.component.html back to summary

protected final Enum HtmlGraphicImage.PropertyKeys

extends Enum<HtmlGraphicImage.PropertyKeys>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys
pack-priv String
public static final HtmlGraphicImage.PropertyKeys
public static final HtmlGraphicImage.PropertyKeys

Constructor Summary

AccessConstructor and Description
private
PropertyKeys(String toString)

private

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.
public static HtmlGraphicImage.PropertyKeys
public static HtmlGraphicImage.PropertyKeys[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

altback to summary
public static final HtmlGraphicImage.PropertyKeys alt
dirback to summary
public static final HtmlGraphicImage.PropertyKeys dir
heightback to summary
public static final HtmlGraphicImage.PropertyKeys height
ismapback to summary
public static final HtmlGraphicImage.PropertyKeys ismap
langback to summary
public static final HtmlGraphicImage.PropertyKeys lang
longdescback to summary
public static final HtmlGraphicImage.PropertyKeys longdesc
onclickback to summary
public static final HtmlGraphicImage.PropertyKeys onclick
ondblclickback to summary
public static final HtmlGraphicImage.PropertyKeys ondblclick
onkeydownback to summary
public static final HtmlGraphicImage.PropertyKeys onkeydown
onkeypressback to summary
public static final HtmlGraphicImage.PropertyKeys onkeypress
onkeyupback to summary
public static final HtmlGraphicImage.PropertyKeys onkeyup
onmousedownback to summary
public static final HtmlGraphicImage.PropertyKeys onmousedown
onmousemoveback to summary
public static final HtmlGraphicImage.PropertyKeys onmousemove
onmouseoutback to summary
public static final HtmlGraphicImage.PropertyKeys onmouseout
onmouseoverback to summary
public static final HtmlGraphicImage.PropertyKeys onmouseover
onmouseupback to summary
public static final HtmlGraphicImage.PropertyKeys onmouseup
roleback to summary
public static final HtmlGraphicImage.PropertyKeys role
styleback to summary
public static final HtmlGraphicImage.PropertyKeys style
styleClassback to summary
public static final HtmlGraphicImage.PropertyKeys styleClass
titleback to summary
public static final HtmlGraphicImage.PropertyKeys title
toStringback to summary
pack-priv String toString
usemapback to summary
public static final HtmlGraphicImage.PropertyKeys usemap
widthback to summary
public static final HtmlGraphicImage.PropertyKeys width

Constructor Detail

PropertyKeysback to summary
private PropertyKeys(String toString)
PropertyKeysback to summary
private PropertyKeys()

Method Detail

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

valueOfback to summary
public static HtmlGraphicImage.PropertyKeys valueOf(String name)
valuesback to summary
public static HtmlGraphicImage.PropertyKeys[] values()