javax.faces.component.html
Class HtmlGraphicImage

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIGraphic
              extended by javax.faces.component.html.HtmlGraphicImage
All Implemented Interfaces:
StateHolder

public class HtmlGraphicImage
extends UIGraphic


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
HtmlGraphicImage()
          Construct an instance of the HtmlGraphicImage.
 
Method Summary
 java.lang.String getAlt()
          Gets Specifies alternative text that can be used by a browser that can't show this element.
 java.lang.String getDir()
          Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 java.lang.String getFamily()
           
 java.lang.String getHeight()
          Gets Overrides the natural height of this image, by specifying height in pixels.
 java.lang.String getLang()
          Gets The base language of this document.
 java.lang.String getLongdesc()
          Gets A link to a long description of the image.
 java.lang.String getOnclick()
          Gets Script to be invoked when the element is clicked.
 java.lang.String getOndblclick()
          Gets Script to be invoked when the element is double-clicked.
 java.lang.String getOnkeydown()
          Gets Script to be invoked when a key is pressed down over this element.
 java.lang.String getOnkeypress()
          Gets Script to be invoked when a key is pressed over this element.
 java.lang.String getOnkeyup()
          Gets Script to be invoked when a key is released over this element.
 java.lang.String getOnmousedown()
          Gets Script to be invoked when the pointing device is pressed over this element.
 java.lang.String getOnmousemove()
          Gets Script to be invoked when the pointing device is moved while it is in this element.
 java.lang.String getOnmouseout()
          Gets Script to be invoked when the pointing device is moves out of this element.
 java.lang.String getOnmouseover()
          Gets Script to be invoked when the pointing device is moved into this element.
 java.lang.String getOnmouseup()
          Gets Script to be invoked when the pointing device is released over this element.
 java.lang.String getStyle()
          Gets CSS styling instructions.
 java.lang.String getStyleClass()
          Gets The CSS class for this element.
 java.lang.String getTitle()
          Gets An advisory title for this element.
 java.lang.String getUsemap()
          Gets Specifies an image map to use with this image.
 java.lang.String getWidth()
          Gets Overrides the natural width of this image, by specifying width in pixels.
 boolean isIsmap()
          Gets Specifies server-side image map handling for this image.
 void restoreState(FacesContext facesContext, java.lang.Object state)
          Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
 java.lang.Object saveState(FacesContext facesContext)
          Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.
 void setAlt(java.lang.String alt)
          Sets Specifies alternative text that can be used by a browser that can't show this element.
 void setDir(java.lang.String dir)
          Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 void setHeight(java.lang.String height)
          Sets Overrides the natural height of this image, by specifying height in pixels.
 void setIsmap(boolean ismap)
          Sets Specifies server-side image map handling for this image.
 void setLang(java.lang.String lang)
          Sets The base language of this document.
 void setLongdesc(java.lang.String longdesc)
          Sets A link to a long description of the image.
 void setOnclick(java.lang.String onclick)
          Sets Script to be invoked when the element is clicked.
 void setOndblclick(java.lang.String ondblclick)
          Sets Script to be invoked when the element is double-clicked.
 void setOnkeydown(java.lang.String onkeydown)
          Sets Script to be invoked when a key is pressed down over this element.
 void setOnkeypress(java.lang.String onkeypress)
          Sets Script to be invoked when a key is pressed over this element.
 void setOnkeyup(java.lang.String onkeyup)
          Sets Script to be invoked when a key is released over this element.
 void setOnmousedown(java.lang.String onmousedown)
          Sets Script to be invoked when the pointing device is pressed over this element.
 void setOnmousemove(java.lang.String onmousemove)
          Sets Script to be invoked when the pointing device is moved while it is in this element.
 void setOnmouseout(java.lang.String onmouseout)
          Sets Script to be invoked when the pointing device is moves out of this element.
 void setOnmouseover(java.lang.String onmouseover)
          Sets Script to be invoked when the pointing device is moved into this element.
 void setOnmouseup(java.lang.String onmouseup)
          Sets Script to be invoked when the pointing device is released over this element.
 void setStyle(java.lang.String style)
          Sets CSS styling instructions.
 void setStyleClass(java.lang.String styleClass)
          Sets The CSS class for this element.
 void setTitle(java.lang.String title)
          Sets An advisory title for this element.
 void setUsemap(java.lang.String usemap)
          Sets Specifies an image map to use with this image.
 void setWidth(java.lang.String width)
          Sets Overrides the natural width of this image, by specifying width in pixels.
 
Methods inherited from class javax.faces.component.UIGraphic
getUrl, getValue, getValueExpression, setUrl, setValue, 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, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
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_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlGraphicImage

public HtmlGraphicImage()
Construct an instance of the HtmlGraphicImage.

Method Detail

getStyle

public java.lang.String getStyle()
Gets CSS styling instructions.

Returns:
the new style value

setStyle

public void setStyle(java.lang.String style)
Sets CSS styling instructions.

Parameters:
style - the new style value

getStyleClass

public java.lang.String getStyleClass()
Gets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Returns:
the new styleClass value

setStyleClass

public void setStyleClass(java.lang.String styleClass)
Sets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Parameters:
styleClass - the new styleClass value

getDir

public java.lang.String getDir()
Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Returns:
the new dir value

setDir

public void setDir(java.lang.String dir)
Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Parameters:
dir - the new dir value

getLang

public java.lang.String getLang()
Gets The base language of this document.

Returns:
the new lang value

setLang

public void setLang(java.lang.String lang)
Sets The base language of this document.

Parameters:
lang - the new lang value

getTitle

public java.lang.String getTitle()
Gets An advisory title for this element. Often used by the user agent as a tooltip.

Returns:
the new title value

setTitle

public void setTitle(java.lang.String title)
Sets An advisory title for this element. Often used by the user agent as a tooltip.

Parameters:
title - the new title value

getOnclick

public java.lang.String getOnclick()
Gets Script to be invoked when the element is clicked.

Returns:
the new onclick value

setOnclick

public void setOnclick(java.lang.String onclick)
Sets Script to be invoked when the element is clicked.

Parameters:
onclick - the new onclick value

getOndblclick

public java.lang.String getOndblclick()
Gets Script to be invoked when the element is double-clicked.

Returns:
the new ondblclick value

setOndblclick

public void setOndblclick(java.lang.String ondblclick)
Sets Script to be invoked when the element is double-clicked.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public java.lang.String getOnmousedown()
Gets Script to be invoked when the pointing device is pressed over this element.

Returns:
the new onmousedown value

setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)
Sets Script to be invoked when the pointing device is pressed over this element.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public java.lang.String getOnmouseup()
Gets Script to be invoked when the pointing device is released over this element.

Returns:
the new onmouseup value

setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)
Sets Script to be invoked when the pointing device is released over this element.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public java.lang.String getOnmouseover()
Gets Script to be invoked when the pointing device is moved into this element.

Returns:
the new onmouseover value

setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)
Sets Script to be invoked when the pointing device is moved into this element.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public java.lang.String getOnmousemove()
Gets Script to be invoked when the pointing device is moved while it is in this element.

Returns:
the new onmousemove value

setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)
Sets Script to be invoked when the pointing device is moved while it is in this element.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public java.lang.String getOnmouseout()
Gets Script to be invoked when the pointing device is moves out of this element.

Returns:
the new onmouseout value

setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)
Sets Script to be invoked when the pointing device is moves out of this element.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public java.lang.String getOnkeypress()
Gets Script to be invoked when a key is pressed over this element.

Returns:
the new onkeypress value

setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)
Sets Script to be invoked when a key is pressed over this element.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public java.lang.String getOnkeydown()
Gets Script to be invoked when a key is pressed down over this element.

Returns:
the new onkeydown value

setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)
Sets Script to be invoked when a key is pressed down over this element.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public java.lang.String getOnkeyup()
Gets Script to be invoked when a key is released over this element.

Returns:
the new onkeyup value

setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)
Sets Script to be invoked when a key is released over this element.

Parameters:
onkeyup - the new onkeyup value

getAlt

public java.lang.String getAlt()
Gets Specifies alternative text that can be used by a browser that can't show this element.

Returns:
the new alt value

setAlt

public void setAlt(java.lang.String alt)
Sets Specifies alternative text that can be used by a browser that can't show this element.

Parameters:
alt - the new alt value

getHeight

public java.lang.String getHeight()
Gets Overrides the natural height of this image, by specifying height in pixels.

Returns:
the new height value

setHeight

public void setHeight(java.lang.String height)
Sets Overrides the natural height of this image, by specifying height in pixels.

Parameters:
height - the new height value

getWidth

public java.lang.String getWidth()
Gets Overrides the natural width of this image, by specifying width in pixels.

Returns:
the new width value

setWidth

public void setWidth(java.lang.String width)
Sets Overrides the natural width of this image, by specifying width in pixels.

Parameters:
width - the new width value

getLongdesc

public java.lang.String getLongdesc()
Gets A link to a long description of the image.

Returns:
the new longdesc value

setLongdesc

public void setLongdesc(java.lang.String longdesc)
Sets A link to a long description of the image.

Parameters:
longdesc - the new longdesc value

getUsemap

public java.lang.String getUsemap()
Gets Specifies an image map to use with this image.

Returns:
the new usemap value

setUsemap

public void setUsemap(java.lang.String usemap)
Sets Specifies an image map to use with this image.

Parameters:
usemap - the new usemap value

isIsmap

public boolean isIsmap()
Gets Specifies server-side image map handling for this image.

Returns:
the new ismap value

setIsmap

public void setIsmap(boolean ismap)
Sets Specifies server-side image map handling for this image.

Parameters:
ismap - the new ismap value

saveState

public java.lang.Object saveState(FacesContext facesContext)
Description copied from class: UIComponentBase
Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.

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

restoreState

public void restoreState(FacesContext facesContext,
                         java.lang.Object state)
Description copied from class: UIComponentBase
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIGraphic
state - is an object previously returned by the saveState method of this class.

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIGraphic


Copyright © 2010 Apache Software Foundation. All Rights Reserved.