Class Hierarchy All Classes All Fields and Methods

 

Class javax.faces.component.UIGraphic

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

public class UIGraphic
extends UIComponentBase

UIGraphic is a UIComponent that displays a graphical image to the user. The user cannot manipulate this component; it is for display purposes only.

By default, the rendererType property must be set to "javax.faces.Image". This value can be changed by calling the setRendererType() method.

Field Index

Field	Description
COMPONENT_FAMILY	The standard component family for this component.
COMPONENT_TYPE	The standard component type for this component.

Constructor Index

Constructor	Description
UIGraphic()	Create a new UIGraphic instance with default property values.

Method Index

Method	Description
String getFamily()
String getUrl()	Return the image URL for this UIGraphic.
Object getValue()	Returns the value property of the UIGraphic.
ValueBinding getValueBinding(String)	Return any ValueBinding set for value if a ValueBinding for url is requested; otherwise, perform the default superclass processing for this method.
void restoreState(FacesContext, Object)
Object saveState(FacesContext)
void setUrl(String)	Set the image URL for this UIGraphic.
void setValue(Object)	Sets the value property of the UIGraphic.
void setValueBinding(String, ValueBinding)	Store any ValueBinding specified for url under value instead; otherwise, perform the default superclass processing for this method.

 

Fields

 

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

 

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

 

Constructors

 

UIGraphic

public UIGraphic() 

Create a new UIGraphic instance with default property values.

 

Methods

 

getFamily

public String getFamily() 

 

getUrl

public String getUrl() 

Return the image URL for this UIGraphic. This method is a typesafe alias for getValue().

 

getValue

public Object getValue() 

Returns the value property of the UIGraphic. This will typically be rendered as an URL.

 

getValueBinding

public ValueBinding getValueBinding(String name) 

Return any ValueBinding set for value if a ValueBinding for url is requested; otherwise, perform the default superclass processing for this method.

• Parameters

  • name - Name of the attribute or property for which to retrieve a ValueBinding

• Throws

  • NullPointerException if name is null

• Overrides

  • getValueBinding in class UIComponentBase

 

restoreState

public void restoreState(FacesContext context,
                         Object state) 

 

saveState

public Object saveState(FacesContext context) 

 

setUrl

public void setUrl(String url) 

Set the image URL for this UIGraphic. This method is a typesafe alias for setValue().

• Parameters

  • url - The new image URL

 

setValue

public void setValue(Object value) 

Sets the value property of the UIGraphic. This will typically be rendered as an URL.

• Parameters

  • value - the new value

 

setValueBinding

public void setValueBinding(String name,
                            ValueBinding binding) 

Store any ValueBinding specified for url under value instead; otherwise, perform the default superclass processing for this method.

• Parameters

  • name - Name of the attribute or property for which to set a ValueBinding

  • binding - The ValueBinding to set, or null to remove any currently set ValueBinding

• Throws

  • NullPointerException if name is null

• Overrides

  • setValueBinding in class UIComponentBase

Class Hierarchy All Classes All Fields and Methods