Class UIImage
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIGraphic
-
- org.apache.myfaces.tobago.internal.component.AbstractUIImage
-
- org.apache.myfaces.tobago.component.UIImage
-
- All Implemented Interfaces:
jakarta.faces.component.behavior.ClientBehaviorHolder
,jakarta.faces.component.PartialStateHolder
,jakarta.faces.component.StateHolder
,jakarta.faces.component.TransientStateHolder
,jakarta.faces.event.ComponentSystemEventListener
,jakarta.faces.event.FacesListener
,jakarta.faces.event.SystemEventListenerHolder
,EventListener
,Visual
@Generated("component.stg") public class UIImage extends AbstractUIImage implements jakarta.faces.component.behavior.ClientBehaviorHolder
Renders an image. UIComponent class, generated from templatecomponent.stg
with classImageTagDeclaration
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIImage()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAlt()
Alternate textual description of the image rendered by this component.CustomClass
getCustomClass()
Sets a CSS class in its parent, if the parent supports it.String
getFamily()
Markup
getMarkup()
String
getTip()
Text value to display as tooltip.boolean
isDisabled()
Flag indicating that this element is disabled.void
restoreState(jakarta.faces.context.FacesContext context, Object state)
void
setAlt(String alt)
void
setCustomClass(CustomClass customClass)
void
setDisabled(boolean disabled)
void
setMarkup(Markup markup)
void
setTip(String tip)
-
Methods inherited from class jakarta.faces.component.UIGraphic
getUrl, getValue, getValueExpression, setUrl, setValue, setValueExpression
-
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
-
Methods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
-
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamily
in classjakarta.faces.component.UIGraphic
-
getAlt
public String getAlt()
Alternate textual description of the image rendered by this component.- Specified by:
getAlt
in classAbstractUIImage
-
setAlt
public void setAlt(String alt)
-
getCustomClass
public CustomClass getCustomClass()
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>
One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.- Specified by:
getCustomClass
in interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClass
in interfaceVisual
-
getTip
public String getTip()
Text value to display as tooltip.
-
setTip
public void setTip(String tip)
-
isDisabled
public boolean isDisabled()
Flag indicating that this element is disabled.
Default:false
- Specified by:
isDisabled
in classAbstractUIImage
-
setDisabled
public void setDisabled(boolean disabled)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classjakarta.faces.component.UIComponentBase
-
-