com.ibm.xsp.component.xp
Class XspGraphicImage

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIGraphic
              extended by com.ibm.xsp.component.UIGraphicEx
                  extended by com.ibm.xsp.component.xp.XspGraphicImage
All Implemented Interfaces:
FacesAttrsObject, ThemeControl, javax.faces.component.StateHolder

public class XspGraphicImage
extends UIGraphicEx

A control that displays a graphic on a page. Images are usually stored as GIF or JPEG files.

XPages Core Controls - Image

Represents an HTML img element


Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponent
javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry
 
Field Summary
static java.lang.String COMPONENT_TYPE
           
static java.lang.String RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIGraphic
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponentBase
EMPTY_ITERATOR
 
Fields inherited from class javax.faces.component.UIComponent
_xspStateId
 
Constructor Summary
XspGraphicImage()
           
 
Method Summary
 java.lang.String getAlt()
           Return the value of the alt property.
 java.lang.String getDir()
           Return the value of the dir property.
 java.lang.String getHeight()
           Return the value of the height property.
 java.lang.String getLang()
           Return the value of the lang property.
 java.lang.String getLongdesc()
           Return the value of the longdesc property.
 java.lang.String getOnblur()
           Return the value of the onblur property.
 java.lang.String getOnclick()
           Return the value of the onclick property.
 java.lang.String getOndblclick()
           Return the value of the ondblclick property.
 java.lang.String getOnfocus()
           Return the value of the onfocus property.
 java.lang.String getOnkeydown()
           Return the value of the onkeydown property.
 java.lang.String getOnkeypress()
           Return the value of the onkeypress property.
 java.lang.String getOnkeyup()
           Return the value of the onkeyup property.
 java.lang.String getOnmousedown()
           Return the value of the onmousedown property.
 java.lang.String getOnmousemove()
           Return the value of the onmousemove property.
 java.lang.String getOnmouseout()
           Return the value of the onmouseout property.
 java.lang.String getOnmouseover()
           Return the value of the onmouseover property.
 java.lang.String getOnmouseup()
           Return the value of the onmouseup property.
 java.lang.String getRole()
           Return the value of the role property.
 java.lang.String getStyle()
           Return the value of the style property.
 java.lang.String getStyleClass()
           Return the value of the styleClass property.
 java.lang.String getTitle()
           Return the value of the title property.
 java.lang.String getUsemap()
           Return the value of the usemap property.
 java.lang.String getWidth()
           Return the value of the width property.
 boolean isIsmap()
           Return the value of the ismap property.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
           
 void setAlt(java.lang.String alt)
           Set the value of the alt property.
 void setDir(java.lang.String dir)
           Set the value of the dir property.
 void setHeight(java.lang.String height)
           Set the value of the height property.
 void setIsmap(boolean ismap)
           Set the value of the ismap property.
 void setLang(java.lang.String lang)
           Set the value of the lang property.
 void setLongdesc(java.lang.String longdesc)
           Set the value of the longdesc property.
 void setOnblur(java.lang.String onblur)
           Set the value of the onblur property.
 void setOnclick(java.lang.String onclick)
           Set the value of the onclick property.
 void setOndblclick(java.lang.String ondblclick)
           Set the value of the ondblclick property.
 void setOnfocus(java.lang.String onfocus)
           Set the value of the onfocus property.
 void setOnkeydown(java.lang.String onkeydown)
           Set the value of the onkeydown property.
 void setOnkeypress(java.lang.String onkeypress)
           Set the value of the onkeypress property.
 void setOnkeyup(java.lang.String onkeyup)
           Set the value of the onkeyup property.
 void setOnmousedown(java.lang.String onmousedown)
           Set the value of the onmousedown property.
 void setOnmousemove(java.lang.String onmousemove)
           Set the value of the onmousemove property.
 void setOnmouseout(java.lang.String onmouseout)
           Set the value of the onmouseout property.
 void setOnmouseover(java.lang.String onmouseover)
           Set the value of the onmouseover property.
 void setOnmouseup(java.lang.String onmouseup)
           Set the value of the onmouseup property.
 void setRole(java.lang.String role)
           Set the value of the role property.
 void setStyle(java.lang.String style)
           Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
           Set the value of the styleClass property.
 void setTitle(java.lang.String title)
           Set the value of the title property.
 void setUsemap(java.lang.String usemap)
           Set the value of the usemap property.
 void setWidth(java.lang.String width)
           Set the value of the width property.
 
Methods inherited from class com.ibm.xsp.component.UIGraphicEx
addAttr, getAttrs, getStyleKitFamily, setAttrs
 
Methods inherited from class javax.faces.component.UIGraphic
getFamily, getUrl, getValue, getValueBinding, setUrl, setValue, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponentBase
_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
Methods inherited from class javax.faces.component.UIComponent
_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree
 
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 java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

RENDERER_TYPE

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

XspGraphicImage

public XspGraphicImage()
Method Detail

getAlt

public java.lang.String getAlt()

Return the value of the alt property. Contents:

An alternative descriptive text that will be shown if the image cannot be displayed.


getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).


getHeight

public java.lang.String getHeight()

Return the value of the height property. Contents:

Override for the height of this image


getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.


getLongdesc

public java.lang.String getLongdesc()

Return the value of the longdesc property. Contents:

Specifies a URI to provide a more detailed description of the image.


getOnblur

public java.lang.String getOnblur()

Return the value of the onblur property. Contents:

JavaScript code executed when this control loses focus


getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer control is clicked over this control


getOndblclick

public java.lang.String getOndblclick()

Return the value of the ondblclick property. Contents:

JavaScript code executed when a pointer control is double clicked over this control


getOnfocus

public java.lang.String getOnfocus()

Return the value of the onfocus property. Contents:

JavaScript code executed when this control receives focus


getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property. Contents:

JavaScript code executed when a key is pressed down over this control


getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property. Contents:

JavaScript code executed when a key is pressed and released over this control.


getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property. Contents:

JavaScript code executed when a key is released over this control


getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property. Contents:

JavaScript code executed when a pointer control is pressed down over this control


getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property. Contents:

JavaScript code executed when a pointer control is moved within this control


getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property. Contents:

JavaScript code executed when a pointer control is moved away from this control


getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property. Contents:

JavaScript code executed when a pointer control is moved onto this control


getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property. Contents:

JavaScript code executed when a pointer control is released over this control


getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.


getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

%/com.ibm.xsp.group.core/style/descr%


getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

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


getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.


getUsemap

public java.lang.String getUsemap()

Return the value of the usemap property. Contents:

Specifies the name of the client-side image map to use for the control.


getWidth

public java.lang.String getWidth()

Return the value of the width property. Contents:

Override for the width of this image.


isIsmap

public boolean isIsmap()

Return the value of the ismap property. Contents:

Indicates that the image should be used as a server-side image map. The image must be enclosed inside an A element that contains an HREF.


restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class UIGraphicEx

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class UIGraphicEx

setAlt

public void setAlt(java.lang.String alt)

Set the value of the alt property.


setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.


setHeight

public void setHeight(java.lang.String height)

Set the value of the height property.


setIsmap

public void setIsmap(boolean ismap)

Set the value of the ismap property.


setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.


setLongdesc

public void setLongdesc(java.lang.String longdesc)

Set the value of the longdesc property.


setOnblur

public void setOnblur(java.lang.String onblur)

Set the value of the onblur property.


setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.


setOndblclick

public void setOndblclick(java.lang.String ondblclick)

Set the value of the ondblclick property.


setOnfocus

public void setOnfocus(java.lang.String onfocus)

Set the value of the onfocus property.


setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.


setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.


setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.


setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Set the value of the onmousedown property.


setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Set the value of the onmousemove property.


setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Set the value of the onmouseout property.


setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Set the value of the onmouseover property.


setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Set the value of the onmouseup property.


setRole

public void setRole(java.lang.String role)

Set the value of the role property.


setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.


setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.


setUsemap

public void setUsemap(java.lang.String usemap)

Set the value of the usemap property.


setWidth

public void setWidth(java.lang.String width)

Set the value of the width property.