Class UITreeIcon
- 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.internal.component.AbstractUITreeIcon
-
- org.apache.myfaces.tobago.component.UITreeIcon
-
- 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 UITreeIcon extends AbstractUITreeIcon implements jakarta.faces.component.behavior.ClientBehaviorHolderRenders an image beside a tree node. UIComponent class, generated from templatecomponent.stgwith classTreeIconTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UITreeIcon()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetAlt()Alternate textual description of the image rendered by this component.StringgetClosed()Name of the folder icon, if not set "value" will be used.CustomClassgetCustomClass()Sets a CSS class in its parent, if the parent supports it.StringgetFamily()MarkupgetMarkup()StringgetOpen()Name of the open folder icon, if not set "closed" will be used.StringgetTip()Text value to display as tooltip.booleanisDisabled()Flag indicating that this element is disabled.voidrestoreState(jakarta.faces.context.FacesContext context, Object state)voidsetAlt(String alt)voidsetClosed(String closed)voidsetCustomClass(CustomClass customClass)voidsetDisabled(boolean disabled)voidsetMarkup(Markup markup)voidsetOpen(String open)voidsetTip(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:
getFamilyin classjakarta.faces.component.UIGraphic
-
getAlt
public String getAlt()
Alternate textual description of the image rendered by this component.- Specified by:
getAltin 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:
getCustomClassin interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClassin interfaceVisual
-
getClosed
public String getClosed()
Name of the folder icon, if not set "value" will be used.- Specified by:
getClosedin classAbstractUITreeIcon
-
setClosed
public void setClosed(String closed)
-
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:
isDisabledin classAbstractUIImage
-
setDisabled
public void setDisabled(boolean disabled)
-
getOpen
public String getOpen()
Name of the open folder icon, if not set "closed" will be used.- Specified by:
getOpenin classAbstractUITreeIcon
-
setOpen
public void setOpen(String open)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-
-