Class UIFigure
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIPanel
-
- org.apache.myfaces.tobago.internal.component.AbstractUIPanelBase
-
- org.apache.myfaces.tobago.internal.component.AbstractUIFigure
-
- org.apache.myfaces.tobago.component.UIFigure
-
- All Implemented Interfaces:
EventListener,javax.faces.component.behavior.ClientBehaviorHolder,javax.faces.component.PartialStateHolder,javax.faces.component.StateHolder,javax.faces.component.TransientStateHolder,javax.faces.event.ComponentSystemEventListener,javax.faces.event.FacesListener,javax.faces.event.SystemEventListenerHolder,Visual
@Generated("component.stg") public class UIFigure extends AbstractUIFigure implements javax.faces.component.behavior.ClientBehaviorHolder
Use figure to show e. g. images or videos inside. UIComponent class, generated from templatecomponent.stgwith classFigureTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIFigure()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CustomClassgetCustomClass()Sets a CSS class in its parent, if the parent supports it.StringgetFamily()StringgetLabel()A localized user presentable label for this component.MarkupgetMarkup()StringgetTip()Text value to display as tooltip.voidrestoreState(javax.faces.context.FacesContext context, Object state)voidsetCustomClass(CustomClass customClass)voidsetLabel(String label)voidsetMarkup(Markup markup)voidsetTip(String tip)-
Methods inherited from class javax.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, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
-
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.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 classjavax.faces.component.UIPanel
-
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
-
getTip
public String getTip()
Text value to display as tooltip.- Specified by:
getTipin classAbstractUIPanelBase
-
setTip
public void setTip(String tip)
-
getLabel
public String getLabel()
A localized user presentable label for this component.- Specified by:
getLabelin classAbstractUIFigure
-
setLabel
public void setLabel(String label)
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIComponentBase
-
-