javax.faces.component
Class UIGraphic

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

All Implemented Interfaces:

StateHolder

@JSFComponent(defaultRendererType="javax.faces.Image")
public class UIGraphic
extends UIComponentBase

Displays a graphical image.

See the javadoc for this class in the JSF Specification for further details.

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UIGraphic()
Construct an instance of the UIGraphic.

Method Summary

String	getFamily()
String	getUrl() An alias for the "value" attribute.
Object	getValue() The URL of the image.
javax.el.ValueExpression	getValueExpression(String name)
void	restoreState(FacesContext facesContext, Object state) Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
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	setUrl(String url)
void	setValue(Object value)
void	setValueExpression(String name, javax.el.ValueExpression binding)

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_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIGraphic

public UIGraphic()

Construct an instance of the UIGraphic.

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

getUrl

@JSFProperty
public String getUrl()

An alias for the "value" attribute.

setUrl

public void setUrl(String url)

getValueExpression

public javax.el.ValueExpression getValueExpression(String name)

Overrides:

getValueExpression in class UIComponent

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression binding)

Overrides:

setValueExpression in class UIComponent

getValue

@JSFProperty
public Object getValue()

The URL of the image.

If the URL starts with a '/', it is relative to the context path of the web application.

setValue

public void setValue(Object value)

saveState

public 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 UIComponentBase

restoreState

public void restoreState(FacesContext facesContext,
                         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 UIComponentBase

state - is an object previously returned by the saveState method of this class.