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 "jakarta.faces.Image". This value can be changed by calling the setRendererType() method.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static enum	UIGraphic.PropertyKeys Properties that are tracked by state saving.

Field Summary

Modifier and Type	Field and Description
public static final String	COMPONENT_FAMILY The standard component family for this component.
public static final String	COMPONENT_TYPE The standard component type for this component.

Constructor Summary

Access	Constructor and Description
public	UIGraphic() Create a new `UIGraphic` instance with default property values.

Method Summary

Modifier and Type	Method and Description
public String	getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Return the identifier of the component family to which this component belongs.
public String	Returns: the url. getUrl() Return the image URL for this `UIGraphic`.
public Object	Returns: the value. getValue() Returns the `value` property of the `UIGraphic`.
public ValueExpression	Returns: the value expression, or `null`. getValueExpression(String Name of the attribute or property for which to retrieve a `ValueExpression` name) Overrides jakarta.faces.component.UIComponent.getValueExpression. Return any `ValueExpression` set for `value` if a `ValueExpression` for `url` is requested; otherwise, perform the default superclass processing for this method.
public void	setUrl(String The new image URL url) Set the image URL for this `UIGraphic`.
public void	setValue(Object the new value value) Sets the `value` property of the `UIGraphic`.
public void	setValueExpression(String Name of the attribute or property for which to set a `ValueExpression` name, ValueExpression The `ValueExpression` to set, or `null` to remove any currently set `ValueExpression` binding) Overrides jakarta.faces.component.UIComponent.setValueExpression. Store any `ValueExpression` specified for `url` under `value` instead; otherwise, perform the default superclass processing for this method.

Modifier and Type

Method and Description

public String

getFamily()

Implements abstract jakarta.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs.

public String

Returns:

the url.

getUrl()

Return the image URL for this UIGraphic.

public Object

Returns:

the value.

getValue()

Returns the value property of the UIGraphic.

public ValueExpression

Returns:

the value expression, or null.

getValueExpression(String

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

name)

Overrides jakarta.faces.component.UIComponent.getValueExpression.

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

public void

setUrl(String

The new image URL

url)

Set the image URL for this UIGraphic.

public void

setValue(Object

the new value

value)

Sets the value property of the UIGraphic.

public void

setValueExpression(String

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

name, ValueExpression

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

binding)

Overrides jakarta.faces.component.UIComponent.setValueExpression.

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

Field Detail

COMPONENT_FAMILY	back to summary
public static final String COMPONENT_FAMILY The standard component family for this component.

COMPONENT_TYPE	back to summary
public static final String COMPONENT_TYPE The standard component type for this component.

Constructor Detail

UIGraphic	back to summary
public UIGraphic() Create a new `UIGraphic` instance with default property values.

Method Detail

getFamily back to summary

getFamily	back to summary
public String getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Doc from jakarta.faces.component.UIComponent.getFamily. 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. Note this method should NOT return `null` Returns:String the component family (not null). Annotations @Override

public String getFamily()

Implements abstract jakarta.faces.component.UIComponent.getFamily.

Doc from jakarta.faces.component.UIComponent.getFamily.

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. Note this method should NOT return null

Returns:String

the component family (not null).

Annotations

@Override

getUrl back to summary

getUrl	back to summary
public String getUrl() Return the image URL for this `UIGraphic`. This method is a typesafe alias for `getValue()`. Returns:String the url.

public String getUrl()

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

Returns:String: the url.

getValue back to summary

getValue	back to summary
public Object getValue() Returns the `value` property of the `UIGraphic`. This will typically be rendered as an URL. Returns:Object the value.

public Object getValue()

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

Returns:Object: the value.

getValueExpression back to summary

getValueExpression	back to summary
public ValueExpression getValueExpression(String name) Overrides jakarta.faces.component.UIComponent.getValueExpression. Return any `ValueExpression` set for `value` if a `ValueExpression` for `url` is requested; otherwise, perform the default superclass processing for this method. Parameters name:String Name of the attribute or property for which to retrieve a `ValueExpression` Returns:ValueExpression the value expression, or `null`. Annotations @Override Exceptions NullPointerException: if `name` is `null` Since 1.2

public ValueExpression getValueExpression(String name)

Overrides jakarta.faces.component.UIComponent.getValueExpression.

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

Parameters

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

Returns:ValueExpression

the value expression, or null.

Annotations

@Override

Exceptions

NullPointerException:: if name is null

Since

1.2

setUrl back to summary

setUrl	back to summary
public void setUrl(String url) Set the image URL for this `UIGraphic`. This method is a typesafe alias for `setValue()`. Parameters url:String The new image URL

public void setUrl(String url)

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

Parameters

url:String: The new image URL

setValue back to summary

setValue	back to summary
public void setValue(Object value) Sets the `value` property of the `UIGraphic`. This will typically be rendered as an URL. Parameters value:Object the new value

public void setValue(Object value)

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

Parameters

value:Object: the new value

setValueExpression back to summary

setValueExpression	back to summary
public void setValueExpression(String name, ValueExpression binding) Overrides jakarta.faces.component.UIComponent.setValueExpression. Store any `ValueExpression` specified for `url` under `value` instead; otherwise, perform the default superclass processing for this method. Parameters name:String Name of the attribute or property for which to set a `ValueExpression` binding:ValueExpression The `ValueExpression` to set, or `null` to remove any currently set `ValueExpression` Annotations @Override Exceptions NullPointerException: if `name` is `null` Since 1.2

public void setValueExpression(String name, ValueExpression binding)

Overrides jakarta.faces.component.UIComponent.setValueExpression.

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

Parameters

name:String: Name of the attribute or property for which to set a ValueExpression
binding:ValueExpression: The ValueExpression to set, or null to remove any currently set ValueExpression

Annotations

@Override

Exceptions

NullPointerException:: if name is null

Since

1.2

jakarta.faces.component back to summary

pack-priv final Enum UIGraphic.PropertyKeys

Class Inheritance

extends Enum<UIGraphic.PropertyKeys>

java.lang.Object
java.lang.Enum
jakarta.faces.component.UIGraphic.PropertyKeys

Properties that are tracked by state saving.

Field Summary

Modifier and Type	Field and Description
public static final UIGraphic.PropertyKeys	value The local value of this `UIComponent`.

Constructor Summary

Access	Constructor and Description
private	PropertyKeys()

Method Summary

Modifier and Type	Method and Description
public static UIGraphic.PropertyKeys	valueOf(String name)
public static UIGraphic.PropertyKeys[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

value	back to summary
public static final UIGraphic.PropertyKeys value The local value of this `UIComponent`.

Constructor Detail

PropertyKeys	back to summary
private PropertyKeys()

Method Detail

valueOf	back to summary
public static UIGraphic.PropertyKeys valueOf(String name)

values	back to summary
public static UIGraphic.PropertyKeys[] values()