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

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final String
     

    Fields 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
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Automatically 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.
    CSS class to render an icon.
    Url to an image to display.
    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.
    Text value to display as tooltip.
    void
    restoreState(jakarta.faces.context.FacesContext context, Object state)
     
    void
    setAutoSpacing(Boolean autoSpacing)
     
    void
     
    void
     
    void
     
    void
     
    void
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
     
    void
     
    void
     

    Methods inherited from class jakarta.faces.component.UIOutput

    clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, saveState, setConverter, setValue

    Methods 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, visitTree

    Methods 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, unsubscribeFromEvent

    Methods inherited from class 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 Visual

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UIBadge

      public UIBadge()
  • Method Details

    • getFamily

      public String getFamily()
      Overrides:
      getFamily in class jakarta.faces.component.UIOutput
    • getImage

      public String getImage()
      Url to an image to display.
      Specified by:
      getImage in class AbstractUIBadge
    • setImage

      public void setImage(String image)
    • getMarkup

      public Markup getMarkup()
      Specified by:
      getMarkup in interface Visual
    • setMarkup

      public void setMarkup(Markup markup)
      Specified by:
      setMarkup in interface Visual
    • getLabelLayout

      public LabelLayout 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:
      getLabelLayout in interface SupportsLabelLayout
    • setLabelLayout

      public void setLabelLayout(LabelLayout labelLayout)
      Specified by:
      setLabelLayout in interface SupportsLabelLayout
    • getMessagePosition

      public DecorationPosition 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:
      getMessagePosition in interface SupportsDecorationPosition
    • setMessagePosition

      public void setMessagePosition(DecorationPosition messagePosition)
    • getIcon

      public String getIcon()
      CSS class to render an icon.
      Specified by:
      getIcon in class AbstractUIBadge
    • setIcon

      public void setIcon(String icon)
    • getLabel

      public String getLabel()
      A localized user presentable label for this component.
      Specified by:
      getLabel in class AbstractUIBadge
    • setLabel

      public void setLabel(String label)
    • getStyleClass

      public CustomClass getStyleClass()
      Set a CSS class on the component. This attribute is equivalent to
      <tc:style customClass="..."/>
      .
    • setStyleClass

      public void setStyleClass(CustomClass styleClass)
    • getAutoSpacing

      public Boolean 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:
      getAutoSpacing in interface SupportsAutoSpacing
    • setAutoSpacing

      public void setAutoSpacing(Boolean autoSpacing)
    • getHelpPosition

      public DecorationPosition getHelpPosition()
      Defines the position and the appearance of a help message on a component. The default is popoverRight.
      Specified by:
      getHelpPosition in interface SupportsDecorationPosition
    • setHelpPosition

      public void setHelpPosition(DecorationPosition helpPosition)
    • 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 interface Visual
    • setCustomClass

      public void setCustomClass(CustomClass customClass)
      Specified by:
      setCustomClass in interface Visual
    • getTip

      public String getTip()
      Text value to display as tooltip.
      Specified by:
      getTip in class AbstractUIBadge
    • setTip

      public void setTip(String tip)
    • restoreState

      public void restoreState(jakarta.faces.context.FacesContext context, Object state)
      Specified by:
      restoreState in interface jakarta.faces.component.StateHolder
      Overrides:
      restoreState in class jakarta.faces.component.UIOutput