|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.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 java.lang.String |
COMPONENT_FAMILY
The standard component family for this component. |
static java.lang.String |
COMPONENT_TYPE
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 | |
---|---|
UIGraphic()
Create a new UIGraphic instance with default property
values. |
Method Summary | |
---|---|
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
java.lang.String |
getUrl()
Return the image URL for this UIGraphic . |
java.lang.Object |
getValue()
Returns the value property of the
UIGraphic . |
ValueBinding |
getValueBinding(java.lang.String name)
Deprecated. This has been replaced by getValueExpression(java.lang.String) . |
ValueExpression |
getValueExpression(java.lang.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 |
setUrl(java.lang.String url)
Set the image URL for this UIGraphic . |
void |
setValue(java.lang.Object value)
Sets the value property of the UIGraphic . |
void |
setValueBinding(java.lang.String name,
ValueBinding binding)
Deprecated. This has been replaced by setValueExpression(java.lang.String, javax.el.ValueExpression) . |
void |
setValueExpression(java.lang.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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public static final java.lang.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 java.lang.String getFamily()
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
public java.lang.String getUrl()
Return the image URL for this UIGraphic
. This method is a
typesafe alias for getValue()
.
public void setUrl(java.lang.String url)
Set the image URL for this UIGraphic
. This method is a
typesafe alias for setValue()
.
url
- The new image URLpublic java.lang.Object getValue()
Returns the value
property of the
UIGraphic
. This will typically be rendered as an URL.
public void setValue(java.lang.Object value)
Sets the value
property of the UIGraphic
.
This will typically be rendered as an URL.
value
- the new valuepublic ValueBinding getValueBinding(java.lang.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 UIComponentBase
name
- Name of the attribute or property for which to retrieve
a ValueBinding
java.lang.NullPointerException
- if name
is null
public void setValueBinding(java.lang.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 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
java.lang.NullPointerException
- if name
is null
public ValueExpression getValueExpression(java.lang.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
java.lang.NullPointerException
- if name
is null
public void setValueExpression(java.lang.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
java.lang.NullPointerException
- if name
is null
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.
Generated on 10-February-2011 12:41