Class UIGraphic
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIGraphic
-
- All Implemented Interfaces:
PartialStateHolder
,StateHolder
,TransientStateHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
- Direct Known Subclasses:
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 "jakarta.faces.Image
". This value can be changed by calling thesetRendererType()
method.
-
-
Field Summary
Fields Modifier and Type Field Description 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 jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getFamily()
Return the identifier of the component family to which this component belongs.String
getUrl()
Return the image URL for thisUIGraphic
.Object
getValue()
Returns thevalue
property of theUIGraphic
.ValueExpression
getValueExpression(String name)
Return anyValueExpression
set forvalue
if aValueExpression
forurl
is requested; otherwise, perform the default superclass processing for this method.void
setUrl(String url)
Set the image URL for thisUIGraphic
.void
setValue(Object value)
Sets thevalue
property of theUIGraphic
.void
setValueExpression(String name, ValueExpression binding)
Store anyValueExpression
specified forurl
undervalue
instead; otherwise, perform the default superclass processing for this method.-
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class jakarta.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
The standard component family for this component.
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UIGraphic
public UIGraphic()
Create a new
UIGraphic
instance with default property values.
-
-
Method Detail
-
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 appropriateRenderer
for this component instance. Note this method should NOT returnnull
- Specified by:
getFamily
in classUIComponent
- Returns:
- the component family (not null).
-
getUrl
public String getUrl()
Return the image URL for this
UIGraphic
. This method is a typesafe alias forgetValue()
.- Returns:
- the url.
-
setUrl
public void setUrl(String url)
Set the image URL for this
UIGraphic
. This method is a typesafe alias forsetValue()
.- Parameters:
url
- The new image URL
-
getValue
public Object getValue()
Returns the
value
property of theUIGraphic
. This will typically be rendered as an URL.- Returns:
- the value.
-
setValue
public void setValue(Object value)
Sets the
value
property of theUIGraphic
. This will typically be rendered as an URL.- Parameters:
value
- the new value
-
getValueExpression
public ValueExpression getValueExpression(String name)
Return any
ValueExpression
set forvalue
if aValueExpression
forurl
is requested; otherwise, perform the default superclass processing for this method.- Overrides:
getValueExpression
in classUIComponent
- Parameters:
name
- Name of the attribute or property for which to retrieve aValueExpression
- Returns:
- the value expression, or
null
. - Throws:
NullPointerException
- ifname
isnull
- Since:
- 1.2
-
setValueExpression
public void setValueExpression(String name, ValueExpression binding)
Store any
ValueExpression
specified forurl
undervalue
instead; otherwise, perform the default superclass processing for this method.- Overrides:
setValueExpression
in classUIComponent
- Parameters:
name
- Name of the attribute or property for which to set aValueExpression
binding
- TheValueExpression
to set, ornull
to remove any currently setValueExpression
- Throws:
NullPointerException
- ifname
isnull
- Since:
- 1.2
-
-