Class UIGraphic
- All Implemented Interfaces:
EventListener
,PartialStateHolder
,StateHolder
,TransientStateHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
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
Modifier and TypeFieldDescriptionstatic final String
The standard component family for this component.static final String
The standard component type for this component.Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturn the identifier of the component family to which this component belongs.getUrl()
Return the image URL for thisUIGraphic
.getValue()
Returns thevalue
property of theUIGraphic
.getValueBinding
(String name) Deprecated.getValueExpression
(String name) Return anyValueExpression
set forvalue
if aValueExpression
forurl
is requested; otherwise, perform the default superclass processing for this method.void
Set the image URL for thisUIGraphic
.void
Sets thevalue
property of theUIGraphic
.void
setValueBinding
(String name, ValueBinding binding) Deprecated.This has been replaced bysetValueExpression(java.lang.String, javax.el.ValueExpression)
.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 javax.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 javax.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 Details
-
COMPONENT_TYPE
The standard component type for this component.
- See Also:
-
COMPONENT_FAMILY
The standard component family for this component.
- See Also:
-
-
Constructor Details
-
UIGraphic
public UIGraphic()Create a new
UIGraphic
instance with default property values.
-
-
Method Details
-
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.- Specified by:
getFamily
in classUIComponent
-
getUrl
Return the image URL for this
UIGraphic
. This method is a typesafe alias forgetValue()
. -
setUrl
Set the image URL for this
UIGraphic
. This method is a typesafe alias forsetValue()
.- Parameters:
url
- The new image URL
-
getValue
Returns the
value
property of theUIGraphic
. This will typically be rendered as an URL. -
setValue
Sets the
value
property of theUIGraphic
. This will typically be rendered as an URL.- Parameters:
value
- the new value
-
getValueBinding
Deprecated.This has been replaced bygetValueExpression(java.lang.String)
.Return any
ValueBinding
set forvalue
if aValueBinding
forurl
is requested; otherwise, perform the default superclass processing for this method.- Overrides:
getValueBinding
in classUIComponentBase
- Parameters:
name
- Name of the attribute or property for which to retrieve aValueBinding
- Throws:
NullPointerException
- ifname
isnull
-
setValueBinding
Deprecated.This has been replaced bysetValueExpression(java.lang.String, javax.el.ValueExpression)
.Store any
ValueBinding
specified forurl
undervalue
instead; otherwise, perform the default superclass processing for this method. In all cases, the superclass is relied on to convert theValueBinding
to aValueExpression
.- Overrides:
setValueBinding
in classUIComponentBase
- Parameters:
name
- Name of the attribute or property for which to set aValueBinding
binding
- TheValueBinding
to set, ornull
to remove any currently setValueBinding
- Throws:
NullPointerException
- ifname
isnull
-
getValueExpression
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
- Throws:
NullPointerException
- ifname
isnull
- Since:
- 1.2
-
setValueExpression
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
-
getValueExpression(java.lang.String)
.