javax.faces.component
Class UIGraphic

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

All Implemented Interfaces:

StateHolder

public class UIGraphic
extends UIComponentBase

Displays a graphical image.

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

Version:

$Revision: 685669 $ $Date: 2008-08-13 15:25:49 -0500 (Wed, 13 Aug 2008) $

Author:

Manfred Geiler (latest modification by $Author: skitching $)

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Constructor Summary

UIGraphic()

Method Summary

String	getFamily()
String	getUrl() An alias for the "value" attribute.
Object	getValue() The URL of the image.
ValueBinding	getValueBinding(String name) Get the named value-binding associated with this component.
void	restoreState(FacesContext context, 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 context) 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	setValueBinding(String name, ValueBinding binding) Put the provided value-binding into a map of value-bindings associated with this component.

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, 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 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()

Method Detail

getUrl

public String getUrl()

An alias for the "value" attribute.

setUrl

public void setUrl(String url)

getValueBinding

public ValueBinding getValueBinding(String name)

Description copied from class: UIComponentBase

Get the named value-binding associated with this component.

Value-bindings are stored in a map associated with the component, though there is commonly a property (setter/getter methods) of the same name defined on the component itself which evaluates the value-binding when called.

Overrides:

getValueBinding in class UIComponentBase

setValueBinding

public void setValueBinding(String name,
                            ValueBinding binding)

Description copied from class: UIComponentBase

Put the provided value-binding into a map of value-bindings associated with this component.

Overrides:

setValueBinding in class UIComponentBase

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

setValue

public void setValue(Object value)

getValue

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.

saveState

public Object saveState(FacesContext context)

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 context,
                         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.