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 template 
component.stg with class
 ImageTagDeclaration.- 
Field SummaryFieldsFields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptiongetAlt()Alternate textual description of the image rendered by this component.Sets a CSS class in its parent, if the parent supports it.getTip()Text value to display as tooltip.booleanFlag indicating that this element is disabled.booleanisPlain()Use with caution: Only for special cases!voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidvoidsetCustomClass(CustomClass customClass) voidsetDisabled(boolean disabled) voidvoidsetPlain(boolean plain) voidMethods inherited from class jakarta.faces.component.UIGraphicgetUrl, getValue, getValueExpression, setUrl, setValue, setValueExpressionMethods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, 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, visitTreeMethods inherited from class jakarta.faces.component.UIComponentgetClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetRendererType
- 
Field Details- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UIImagepublic UIImage()
 
- 
- 
Method Details- 
getFamily- Overrides:
- getFamilyin class- jakarta.faces.component.UIGraphic
 
- 
getMarkup
- 
setMarkup
- 
isPlainpublic boolean isPlain()Use with caution: Only for special cases! This attribute is useful for tc:out if labelLayout=skip is set. Use true, if you want to only render the text (no surrounding tag). Use false, if you enable the possibility to apply styles to the output. For tc:image there will be no <i> or <tobago-image> element rendered only the <img> element. For tc:form there will no div tag be rendered. So, the content can be used freely from layout managers. But, no AJAX is possible for components with "plain" set, because there is no client element with an "id" in the DOM. 
 Default:false
- 
setPlainpublic void setPlain(boolean plain) 
- 
getAltAlternate textual description of the image rendered by this component.- Specified by:
- getAltin class- AbstractUIImage
 
- 
setAlt
- 
getCustomClassSets 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:
- getCustomClassin interface- Visual
 
- 
setCustomClass- Specified by:
- setCustomClassin interface- Visual
 
- 
getTipText value to display as tooltip.
- 
setTip
- 
isDisabledpublic boolean isDisabled()Flag indicating that this element is disabled.
 Default:false- Specified by:
- isDisabledin class- AbstractUIImage
 
- 
setDisabledpublic void setDisabled(boolean disabled) 
- 
restoreState- Specified by:
- restoreStatein interface- jakarta.faces.component.StateHolder
- Overrides:
- restoreStatein class- jakarta.faces.component.UIComponentBase
 
 
-