Package org.apache.myfaces.tobago.component

Klasse UIMessages

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIMessages
org.apache.myfaces.tobago.internal.component.AbstractUIMessages
org.apache.myfaces.tobago.component.UIMessages
Alle implementierten Schnittstellen:
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 UIMessages extends AbstractUIMessages implements javax.faces.component.behavior.ClientBehaviorHolder
Renders error/validation messages. UIComponent class, generated from template component.stg with class MessagesTagDeclaration.

  • Verschachtelte Klassen - Übersicht

    Von Klasse geerbte verschachtelte Klassen/Schnittstellen org.apache.myfaces.tobago.internal.component.AbstractUIMessages

    AbstractUIMessages.Item

  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static final String
    COMPONENT_FAMILY
     
    static final String
    COMPONENT_TYPE
     

    Von Klasse geerbte Felder javax.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    UIMessages()
     

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    CustomClass
    getCustomClass()
    Sets a CSS class in its parent, if the parent supports it.
    String
    getFamily()
     
    Markup
    getMarkup()
     
    Integer
    getMaxNumber()
    Sets the maximum number of messages to show.
    javax.faces.application.FacesMessage.Severity
    getMaxSeverity()
    Sets the maximum severity to be shown.
    javax.faces.application.FacesMessage.Severity
    getMinSeverity()
    Sets the mininum severity to be shown.
    OrderBy
    getOrderBy()
    Sets the order of the messages.
    boolean
    isConfirmation()
    Has the user to confirm this message?
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
    setConfirmation(boolean confirmation)
     
    void
    setCustomClass(CustomClass customClass)
     
    void
    setMarkup(Markup markup)
     
    void
    setMaxNumber(Integer maxNumber)
     
    void
    setMaxSeverity(javax.faces.application.FacesMessage.Severity maxSeverity)
     
    void
    setMinSeverity(javax.faces.application.FacesMessage.Severity minSeverity)
     
    void
    setOrderBy(OrderBy orderBy)
     

    Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUIMessages

    createMessageList

    Von Klasse geerbte Methoden javax.faces.component.UIMessages

    getFor, isGlobalOnly, isRedisplay, isShowDetail, isShowSummary, setFor, setGlobalOnly, setRedisplay, setShowDetail, setShowSummary

    Von Klasse geerbte Methoden 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

    Von Klasse geerbte Methoden 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

    Von Klasse geerbte Methoden java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Von Schnittstelle geerbte Methoden javax.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

    Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.Visual

    getRendererType, isPlain

  • Felddetails

    • COMPONENT_TYPE

      public static final String COMPONENT_TYPE

    • COMPONENT_FAMILY

      public static final String COMPONENT_FAMILY
      Siehe auch:

  • Konstruktordetails

    • UIMessages

      public UIMessages()

  • Methodendetails

    • getFamily

      public String getFamily()
      Setzt außer Kraft:
      getFamily in Klasse javax.faces.component.UIMessages

    • getMinSeverity

      public javax.faces.application.FacesMessage.Severity getMinSeverity()
      Sets the mininum severity to be shown. E. g. "warn" shows only "warn", "error" and "fatal".
      Default: info
      Angegeben von:
      getMinSeverity in Klasse AbstractUIMessages

    • setMinSeverity

      public void setMinSeverity(javax.faces.application.FacesMessage.Severity minSeverity)

    • getMaxNumber

      public Integer getMaxNumber()
      Sets the maximum number of messages to show.
      Default: 2147483647
      Angegeben von:
      getMaxNumber in Klasse AbstractUIMessages

    • setMaxNumber

      public void setMaxNumber(Integer maxNumber)

    • getMarkup

      public Markup getMarkup()
      Angegeben von:
      getMarkup in Schnittstelle Visual

    • setMarkup

      public void setMarkup(Markup markup)
      Angegeben von:
      setMarkup in Schnittstelle Visual

    • 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.
      Angegeben von:
      getCustomClass in Schnittstelle Visual

    • setCustomClass

      public void setCustomClass(CustomClass customClass)
      Angegeben von:
      setCustomClass in Schnittstelle Visual

    • getOrderBy

      public OrderBy getOrderBy()
      Sets the order of the messages.
      Default: occurrence
      Allowed Values: occurrence,severity
      Angegeben von:
      getOrderBy in Klasse AbstractUIMessages

    • setOrderBy

      public void setOrderBy(OrderBy orderBy)

    • isConfirmation

      public boolean isConfirmation()
      Has the user to confirm this message? This attributes handles the case, if the application wants to warn the user about a problem, and the user has to confirm the message before he/she can continue.
      Default: false
      Angegeben von:
      isConfirmation in Klasse AbstractUIMessages

    • setConfirmation

      public void setConfirmation(boolean confirmation)

    • getMaxSeverity

      public javax.faces.application.FacesMessage.Severity getMaxSeverity()
      Sets the maximum severity to be shown. E. g. "warn" shows only "warn" and "info". When setting this attribute you usually shoud take care, that you have a second message tag to show the higher severity levels.
      Default: fatal
      Angegeben von:
      getMaxSeverity in Klasse AbstractUIMessages

    • setMaxSeverity

      public void setMaxSeverity(javax.faces.application.FacesMessage.Severity maxSeverity)

    • restoreState

      public void restoreState(javax.faces.context.FacesContext context, Object state)
      Angegeben von:
      restoreState in Schnittstelle javax.faces.component.StateHolder
      Setzt außer Kraft:
      restoreState in Klasse javax.faces.component.UIComponentBase