|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIGraphic
public class UIGraphic
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 Summary | |
|---|---|
static String |
COMPONENT_FAMILY
The standard component family for this component. |
static String |
COMPONENT_TYPE
The standard component type for this component. |
| Fields inherited from class javax.faces.component.UIComponent |
|---|
bindings |
| Constructor Summary | |
|---|---|
UIGraphic()
Create a new UIGraphic instance with default property
values. |
|
| Method Summary | |
|---|---|
String |
getFamily()
Return the identifier of the component family to which this component belongs. |
String |
getUrl()
Return the image URL for this UIGraphic. |
Object |
getValue()
Returns the value property of the
UIGraphic. |
ValueBinding |
getValueBinding(String name)
Deprecated. This has been replaced by getValueExpression(java.lang.String). |
ValueExpression |
getValueExpression(String name)
Return any ValueExpression set for value if a
ValueExpression for url is requested; otherwise,
perform the default superclass processing for this method. |
void |
restoreState(FacesContext context,
Object state)
Perform any processing required to restore the state from the entries in the state Object. |
Object |
saveState(FacesContext context)
Gets the state of the instance as a Serializable Object. |
void |
setUrl(String url)
Set the image URL for this UIGraphic. |
void |
setValue(Object value)
Sets the value property of the UIGraphic. |
void |
setValueBinding(String name,
ValueBinding binding)
Deprecated. This has been replaced by setValueExpression(java.lang.String, javax.el.ValueExpression). |
void |
setValueExpression(String name,
ValueExpression binding)
Store any ValueExpression specified for url under
value instead; otherwise, perform the default superclass
processing for this method. |
| 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 |
|---|
public static final String COMPONENT_TYPE
The standard component type for this component.
public static final String COMPONENT_FAMILY
The standard component family for this component.
| Constructor Detail |
|---|
public UIGraphic()
Create a new UIGraphic instance with default property
values.
| Method Detail |
|---|
public String getFamily()
UIComponentReturn the identifier of the component family to which this
component belongs. This identifier, in conjunction with the value
of the rendererType property, may be used to select
the appropriate Renderer for this component instance.
getFamily in class UIComponentpublic String getUrl()
Return the image URL for this UIGraphic. This method is a
typesafe alias for getValue().
public void setUrl(String url)
Set the image URL for this UIGraphic. This method is a
typesafe alias for setValue().
url - The new image URLpublic Object getValue()
Returns the value property of the
UIGraphic. This will typically be rendered as an URL.
public void setValue(Object value)
Sets the value property of the UIGraphic.
This will typically be rendered as an URL.
value - the new valuepublic ValueBinding getValueBinding(String name)
getValueExpression(java.lang.String).
Return any ValueBinding set for value if a
ValueBinding for url is requested; otherwise,
perform the default superclass processing for this method.
getValueBinding in class UIComponentBasename - Name of the attribute or property for which to retrieve
a ValueBinding
NullPointerException - if name
is null
public void setValueBinding(String name,
ValueBinding binding)
setValueExpression(java.lang.String, javax.el.ValueExpression).
Store any ValueBinding specified for url
under value instead; otherwise, perform the default
superclass processing for this method. In all cases, the
superclass is relied on to convert the ValueBinding
to a ValueExpression.
setValueBinding in class UIComponentBasename - Name of the attribute or property for which to set
a ValueBindingbinding - The ValueBinding to set, or null
to remove any currently set ValueBinding
NullPointerException - if name
is nullpublic ValueExpression getValueExpression(String name)
Return any ValueExpression set for value if a
ValueExpression for url is requested; otherwise,
perform the default superclass processing for this method.
getValueExpression in class UIComponentBasename - Name of the attribute or property for which to retrieve
a ValueExpression
NullPointerException - if name
is null
public void setValueExpression(String name,
ValueExpression binding)
Store any ValueExpression specified for url under
value instead; otherwise, perform the default superclass
processing for this method.
setValueExpression in class UIComponentBasename - Name of the attribute or property for which to set
a ValueExpressionbinding - The ValueExpression to set, or null
to remove any currently set ValueExpression
NullPointerException - if name
is nullpublic Object saveState(FacesContext context)
StateHolder Gets the state of the instance as a
Serializable Object.
If the class that implements this interface has references to
instances that implement StateHolder (such as a
UIComponent with event handlers, validators, etc.)
this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those
instances as well. This method must not save the state
of children and facets. That is done via the StateManager
This method must not alter the state of the implementing object. In other words, after executing this code:
Object state = component.saveState(facesContext);
component should be the same as before executing
it.
The return from this method must be Serializable
saveState in interface StateHoldersaveState in class UIComponentBase
public void restoreState(FacesContext context,
Object state)
StateHolderPerform any processing required to restore the state from the entries in the state Object.
If the class that implements this interface has references to
instances that also implement StateHolder (such as a
UIComponent with event handlers, validators, etc.)
this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those
instances as well.
restoreState in interface StateHolderrestoreState in class UIComponentBase
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.