UIGraphic (Java EE 5 SDK)

javax.faces.component Class UIGraphic

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

所有已实现的接口:

StateHolder

直接已知子类:

HtmlGraphicImage

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.

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The standard component type for this component.

另请参见:

常量字段

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

The standard component family for this component.

另请参见:

常量字段

UIGraphic

public UIGraphic()

Create a new UIGraphic instance with default property values.

getFamily

public String getFamily()

Description copied from class: UIComponent

Return 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 UIComponent

getUrl

public String getUrl()

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

setUrl

public void setUrl(String url)

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

参数:

url - The new image URL

getValue

public Object getValue()

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

setValue

public void setValue(Object value)

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

参数:

value - the new value

getValueBinding

public ValueBinding getValueBinding(String name)

Deprecated. This has been replaced by 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 UIComponentBase

参数:

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

抛出异常:

NullPointerException - if name is null

setValueBinding

public void setValueBinding(String name,
                            ValueBinding binding)

Deprecated. This has been replaced by 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 UIComponentBase

参数:

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

抛出异常:

NullPointerException - if name is null

getValueExpression

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

参数:

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

抛出异常:

NullPointerException - if name is null

从以下版本开始:

1.2

setValueExpression

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 UIComponent

参数:

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

binding - The ValueExpression to set, or null to remove any currently set ValueExpression

抛出异常:

NullPointerException - if name is null

从以下版本开始:

1.2

saveState

public Object saveState(FacesContext context)

Description copied from interface: 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 StateHolder

重写:

saveState in class UIComponentBase

public void restoreState(FacesContext context,
                         Object state)