Class UIBadge
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIOutput
org.apache.myfaces.tobago.internal.component.AbstractUIBadge
org.apache.myfaces.tobago.component.UIBadge
- All Implemented Interfaces:
jakarta.faces.component.behavior.ClientBehaviorHolder, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.ValueHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener, SupportsAutoSpacing, SupportsDecorationPosition, SupportsLabelLayout, Visual
@Generated("component.stg")
public class UIBadge
extends AbstractUIBadge
implements jakarta.faces.component.behavior.ClientBehaviorHolder
Renders a badge element.
UIComponent class, generated from template
component.stg with class
BadgeTagDeclaration.-
Field Summary
FieldsFields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAutomatically add spacing (margins/paddings) to the component for better positioning.Sets a CSS class in its parent, if the parent supports it.Defines the position and the appearance of a help message on a component.getIcon()CSS class to render an icon.getImage()Url to an image to display.getLabel()A localized user presentable label for this component.Defines the position of the label relative to the field.Defines the position and the appearance of additional faces messages (like error message or help message) on a component.Set a CSS class on the component.getTip()Text value to display as tooltip.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetAutoSpacing(Boolean autoSpacing) voidsetCustomClass(CustomClass customClass) voidsetHelpPosition(DecorationPosition helpPosition) voidvoidvoidvoidsetLabelLayout(LabelLayout labelLayout) voidvoidsetMessagePosition(DecorationPosition messagePosition) voidsetStyleClass(CustomClass styleClass) voidMethods inherited from class AbstractUIBadge
getAutoSpacing, hasLabel, isNextToRenderIsLabel, setNextToRenderIsLabelMethods inherited from class jakarta.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, saveState, setConverter, setValueMethods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTreeMethods inherited from class jakarta.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, unsubscribeFromEventMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesMethods inherited from interface Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIBadge
public UIBadge()
-
-
Method Details
-
getFamily
- Overrides:
getFamilyin classjakarta.faces.component.UIOutput
-
getImage
Url to an image to display.- Specified by:
getImagein classAbstractUIBadge
-
setImage
-
getMarkup
-
setMarkup
-
getLabelLayout
Defines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags).- Specified by:
getLabelLayoutin interfaceSupportsLabelLayout
-
setLabelLayout
- Specified by:
setLabelLayoutin interfaceSupportsLabelLayout
-
getMessagePosition
Defines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight.- Specified by:
getMessagePositionin interfaceSupportsDecorationPosition
-
setMessagePosition
-
getIcon
-
setIcon
-
getLabel
A localized user presentable label for this component.- Specified by:
getLabelin classAbstractUIBadge
-
setLabel
-
getStyleClass
Set a CSS class on the component. This attribute is equivalent to<tc:style customClass="..."/>
. -
setStyleClass
-
getAutoSpacing
Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - popover - link group - button group - before facet - after facet - label facet - bar facet- Specified by:
getAutoSpacingin interfaceSupportsAutoSpacing
-
setAutoSpacing
-
getHelpPosition
Defines the position and the appearance of a help message on a component. The default is popoverRight.- Specified by:
getHelpPositionin interfaceSupportsDecorationPosition
-
setHelpPosition
-
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
- Specified by:
setCustomClassin interfaceVisual
-
getTip
Text value to display as tooltip.- Specified by:
getTipin classAbstractUIBadge
-
setTip
-
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIOutput
-