HtmlGraphicImage (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.faces.component.html
Class HtmlGraphicImage

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIGraphic
              javax.faces.component.html.HtmlGraphicImage

All Implemented Interfaces:: StateHolder

public class HtmlGraphicImage
extends UIGraphic
extends UIGraphic

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.

Field Summary

static String COMPONENT_TYPE
          The standard component type for this component.

Fields inherited from class javax.faces.component.UIGraphic

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

HtmlGraphicImage()


Method Summary

String getAlt()
          Return the value of the alt property.

String getDir()
          Return the value of the dir property.

String getHeight()
          Return the value of the height property.

String getLang()
          Return the value of the lang property.

String getLongdesc()
          Return the value of the longdesc property.

String getOnclick()
          Return the value of the onclick property.

String getOndblclick()
          Return the value of the ondblclick property.

String getOnkeydown()
          Return the value of the onkeydown property.

String getOnkeypress()
          Return the value of the onkeypress property.

String getOnkeyup()
          Return the value of the onkeyup property.

String getOnmousedown()
          Return the value of the onmousedown property.

String getOnmousemove()
          Return the value of the onmousemove property.

String getOnmouseout()
          Return the value of the onmouseout property.

String getOnmouseover()
          Return the value of the onmouseover property.

String getOnmouseup()
          Return the value of the onmouseup property.

String getStyle()
          Return the value of the style property.

String getStyleClass()
          Return the value of the styleClass property.

String getTitle()
          Return the value of the title property.

String getUsemap()
          Return the value of the usemap property.

String getWidth()
          Return the value of the width property.

boolean isIsmap()
          Return the value of the ismap property.

void restoreState(FacesContext _context, Object _state)
           Perform any processing required to restore the state from the entries in the state Object.

Object saveState(FacesContext _context)
           Gets the state of the instance as a Serializable Object.

void setAlt(String alt)
          Set the value of the alt property.

void setDir(String dir)
          Set the value of the dir property.

void setHeight(String height)
          Set the value of the height property.

void setIsmap(boolean ismap)
          Set the value of the ismap property.

void setLang(String lang)
          Set the value of the lang property.

void setLongdesc(String longdesc)
          Set the value of the longdesc property.

void setOnclick(String onclick)
          Set the value of the onclick property.

void setOndblclick(String ondblclick)
          Set the value of the ondblclick property.

void setOnkeydown(String onkeydown)
          Set the value of the onkeydown property.

void setOnkeypress(String onkeypress)
          Set the value of the onkeypress property.

void setOnkeyup(String onkeyup)
          Set the value of the onkeyup property.

void setOnmousedown(String onmousedown)
          Set the value of the onmousedown property.

void setOnmousemove(String onmousemove)
          Set the value of the onmousemove property.

void setOnmouseout(String onmouseout)
          Set the value of the onmouseout property.

void setOnmouseover(String onmouseover)
          Set the value of the onmouseover property.

void setOnmouseup(String onmouseup)
          Set the value of the onmouseup property.

void setStyle(String style)
          Set the value of the style property.

void setStyleClass(String styleClass)
          Set the value of the styleClass property.

void setTitle(String title)
          Set the value of the title property.

void setUsemap(String usemap)
          Set the value of the usemap property.

void setWidth(String width)
          Set the value of the width property.

Methods inherited from class javax.faces.component.UIGraphic

getFamily, getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValue, setValueBinding, setValueExpression

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Summary
`static String`	`COMPONENT_TYPE` The standard component type for this component.

Fields inherited from class javax.faces.component.UIGraphic
`COMPONENT_FAMILY`

Fields inherited from class javax.faces.component.UIComponent
`bindings`

Constructor Summary
`HtmlGraphicImage()`

Method Summary
`String`	`getAlt()` Return the value of the `alt` property.
`String`	`getDir()` Return the value of the `dir` property.
`String`	`getHeight()` Return the value of the `height` property.
`String`	`getLang()` Return the value of the `lang` property.
`String`	`getLongdesc()` Return the value of the `longdesc` property.
`String`	`getOnclick()` Return the value of the `onclick` property.
`String`	`getOndblclick()` Return the value of the `ondblclick` property.
`String`	`getOnkeydown()` Return the value of the `onkeydown` property.
`String`	`getOnkeypress()` Return the value of the `onkeypress` property.
`String`	`getOnkeyup()` Return the value of the `onkeyup` property.
`String`	`getOnmousedown()` Return the value of the `onmousedown` property.
`String`	`getOnmousemove()` Return the value of the `onmousemove` property.
`String`	`getOnmouseout()` Return the value of the `onmouseout` property.
`String`	`getOnmouseover()` Return the value of the `onmouseover` property.
`String`	`getOnmouseup()` Return the value of the `onmouseup` property.
`String`	`getStyle()` Return the value of the `style` property.
`String`	`getStyleClass()` Return the value of the `styleClass` property.
`String`	`getTitle()` Return the value of the `title` property.
`String`	`getUsemap()` Return the value of the `usemap` property.
`String`	`getWidth()` Return the value of the `width` property.
`boolean`	`isIsmap()` Return the value of the `ismap` property.
`void`	`restoreState(FacesContext _context, Object _state)` Perform any processing required to restore the state from the entries in the state Object.
`Object`	`saveState(FacesContext _context)` Gets the state of the instance as a `Serializable` Object.
`void`	`setAlt(String alt)` Set the value of the `alt` property.
`void`	`setDir(String dir)` Set the value of the `dir` property.
`void`	`setHeight(String height)` Set the value of the `height` property.
`void`	`setIsmap(boolean ismap)` Set the value of the `ismap` property.
`void`	`setLang(String lang)` Set the value of the `lang` property.
`void`	`setLongdesc(String longdesc)` Set the value of the `longdesc` property.
`void`	`setOnclick(String onclick)` Set the value of the `onclick` property.
`void`	`setOndblclick(String ondblclick)` Set the value of the `ondblclick` property.
`void`	`setOnkeydown(String onkeydown)` Set the value of the `onkeydown` property.
`void`	`setOnkeypress(String onkeypress)` Set the value of the `onkeypress` property.
`void`	`setOnkeyup(String onkeyup)` Set the value of the `onkeyup` property.
`void`	`setOnmousedown(String onmousedown)` Set the value of the `onmousedown` property.
`void`	`setOnmousemove(String onmousemove)` Set the value of the `onmousemove` property.
`void`	`setOnmouseout(String onmouseout)` Set the value of the `onmouseout` property.
`void`	`setOnmouseover(String onmouseover)` Set the value of the `onmouseover` property.
`void`	`setOnmouseup(String onmouseup)` Set the value of the `onmouseup` property.
`void`	`setStyle(String style)` Set the value of the `style` property.
`void`	`setStyleClass(String styleClass)` Set the value of the `styleClass` property.
`void`	`setTitle(String title)` Set the value of the `title` property.
`void`	`setUsemap(String usemap)` Set the value of the `usemap` property.
`void`	`setWidth(String width)` Set the value of the `width` property.

Methods inherited from class javax.faces.component.UIGraphic
`getFamily, getUrl, getValue, getValueBinding, getValueExpression, setUrl, setValue, setValueBinding, setValueExpression`

Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent
`encodeAll, getContainerClientId`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The standard component type for this component.

See Also:: Constant Field Values

Constructor Detail

HtmlGraphicImage

public HtmlGraphicImage()

Method Detail

getAlt

public String getAlt()

Return the value of the alt property.

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

setAlt

public void setAlt(String alt)

Set the value of the alt property.

getDir

public String getDir()

Return the value of the dir property.

Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).

setDir

public void setDir(String dir)

Set the value of the dir property.

getHeight

public String getHeight()

Return the value of the height property.

Contents: Override for the height of this image.

setHeight

public void setHeight(String height)

Set the value of the height property.

isIsmap

public boolean isIsmap()

Return the value of the ismap property.

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

setIsmap

public void setIsmap(boolean ismap)

Set the value of the ismap property.

getLang

public String getLang()

Return the value of the lang property.

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

setLang

public void setLang(String lang)

Set the value of the lang property.

getLongdesc

public String getLongdesc()

Return the value of the longdesc property.

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

setLongdesc

public void setLongdesc(String longdesc)

Set the value of the longdesc property.

getOnclick

public String getOnclick()

Return the value of the onclick property.

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

setOnclick

public void setOnclick(String onclick)

Set the value of the onclick property.

getOndblclick

public String getOndblclick()

Return the value of the ondblclick property.

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

setOndblclick

public void setOndblclick(String ondblclick)

Set the value of the ondblclick property.

getOnkeydown

public String getOnkeydown()

Return the value of the onkeydown property.

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

setOnkeydown

public void setOnkeydown(String onkeydown)

Set the value of the onkeydown property.

getOnkeypress

public String getOnkeypress()

Return the value of the onkeypress property.

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

setOnkeypress

public void setOnkeypress(String onkeypress)

Set the value of the onkeypress property.

getOnkeyup

public String getOnkeyup()

Return the value of the onkeyup property.

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

setOnkeyup

public void setOnkeyup(String onkeyup)

Set the value of the onkeyup property.

getOnmousedown

public String getOnmousedown()

Return the value of the onmousedown property.

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

setOnmousedown

public void setOnmousedown(String onmousedown)

Set the value of the onmousedown property.

getOnmousemove

public String getOnmousemove()

Return the value of the onmousemove property.

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

setOnmousemove

public void setOnmousemove(String onmousemove)

Set the value of the onmousemove property.

getOnmouseout

public String getOnmouseout()

Return the value of the onmouseout property.

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

setOnmouseout

public void setOnmouseout(String onmouseout)

Set the value of the onmouseout property.

getOnmouseover

public String getOnmouseover()

Return the value of the onmouseover property.

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

setOnmouseover

public void setOnmouseover(String onmouseover)

Set the value of the onmouseover property.

getOnmouseup

public String getOnmouseup()

Return the value of the onmouseup property.

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

setOnmouseup

public void setOnmouseup(String onmouseup)

Set the value of the onmouseup property.

getStyle

public String getStyle()

Return the value of the style property.

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

setStyle

public void setStyle(String style)

Set the value of the style property.

getStyleClass

public String getStyleClass()

Return the value of the styleClass property.

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.

setStyleClass

public void setStyleClass(String styleClass)

Set the value of the styleClass property.

getTitle

public String getTitle()

Return the value of the title property.

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

setTitle

public void setTitle(String title)

Set the value of the title property.

getUsemap

public String getUsemap()

Return the value of the usemap property.

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

setUsemap

public void setUsemap(String usemap)

Set the value of the usemap property.

getWidth

public String getWidth()

Return the value of the width property.

Contents: Override for the width of this image.

setWidth

public void setWidth(String width)

Set the value of the width property.

saveState

public Object saveState(FacesContext _context)

Description copied from interface: StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:: saveState in interface StateHolder
Overrides:: saveState in class UIGraphic

restoreState

public void restoreState(FacesContext _context,
                         Object _state)