javax.faces.render

Class Renderer

Inhoudsopgave
  • Direct Known Subclasses:
    RendererWrapper

    public abstract class Renderer
extends Object

    A Renderer converts the internal representation of UIComponents into the output stream (or writer) associated with the response we are creating for a particular request. Each Renderer knows how to render one or more UIComponent types (or classes), and advertises a set of render-dependent attributes that it recognizes for each supported UIComponent.

    Families of Renderers are packaged as a RenderKit, and together support the rendering of all of the UIComponents in a view associated with a FacesContext. Within the set of Renderers for a particular RenderKit, each must be uniquely identified by the rendererType property.

    Individual Renderer instances will be instantiated as requested during the rendering process, and will remain in existence for the remainder of the lifetime of a web application. Because each instance may be invoked from more than one request processing thread simultaneously, they MUST be programmed in a thread-safe manner.

    If the ListenerFor annotation is attached to the class definition of a Renderer, that class must also implement ComponentSystemEventListener, and the action pertaining to the processing of ResourceDependency on a Renderer described in ListenerFor must be taken.

    If the ResourceDependency annotation is attached to the class definition of a Renderer, the action pertaining to the processing of ResourceDependency on a Renderer described in UIComponent.getChildren() must be taken.

    • Field Detail

      • PASSTHROUGH_RENDERER_LOCALNAME_KEY

        public static final String PASSTHROUGH_RENDERER_LOCALNAME_KEY

        The key in the component passthrough attributes Map for the localName of the element corresponding to the component.

        Since:
        2.2
        See Also:
        Constant Field Values

    • Constructor Detail

      • Renderer

        public Renderer()

    • Method Detail

      • decode

        public void decode(FacesContext context,
                   UIComponent component)

        Decode any new state of the specified UIComponent from the request contained in the specified FacesContext, and store that state on the UIComponent.

        During decoding, events may be enqueued for later processing (by event listeners that have registered an interest), by calling queueEvent() on the associated UIComponent.

        Parameters:
        context - FacesContext for the request we are processing
        component - UIComponent to be decoded.
        Throws:
        NullPointerException - if context or component is null

      • encodeBegin

        public void encodeBegin(FacesContext context,
                        UIComponent component)
                 throws IOException

        Render the beginning specified UIComponent to the output stream or writer associated with the response we are creating. If the conversion attempted in a previous call to getConvertedValue() for this component failed, the state information saved during execution of decode() should be used to reproduce the incorrect input.

        Parameters:
        context - FacesContext for the request we are processing
        component - UIComponent to be rendered
        Throws:
        IOException - if an input/output error occurs while rendering
        NullPointerException - if context or component is null

      • encodeChildren

        public void encodeChildren(FacesContext context,
                           UIComponent component)
                    throws IOException

        Render the child components of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property of this component is true.

        Parameters:
        context - FacesContext for the response we are creating
        component - UIComponent whose children are to be rendered
        Throws:
        IOException - if an input/output error occurs while rendering
        NullPointerException - if context or component is null

      • encodeEnd

        public void encodeEnd(FacesContext context,
                      UIComponent component)
               throws IOException

        Render the ending of the current state of the specified UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered.

        Parameters:
        context - FacesContext for the response we are creating
        component - UIComponent to be rendered
        Throws:
        IOException - if an input/output error occurs while rendering
        NullPointerException - if context or component is null

      • convertClientId

        public String convertClientId(FacesContext context,
                              String clientId)

        Convert the component generated client id to a form suitable for transmission to the client.

        The default implementation returns the argument clientId unchanged.

        Parameters:
        context - FacesContext for the current request
        clientId - the client identifier to be converted to client a specific format.
        Throws:
        NullPointerException - if context or clientId is null

      • getRendersChildren

        public boolean getRendersChildren()

        Return a flag indicating whether this Renderer is responsible for rendering the children the component it is asked to render. The default implementation returns false.

      • getConvertedValue

        public Object getConvertedValue(FacesContext context,
                                UIComponent component,
                                Object submittedValue)
                         throws ConverterException

        Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registered Converter for this component, if there is one). If conversion is successful, the new value should be returned from this method; if not, a ConverterException should be thrown.

        Parameters:
        context - FacesContext for the request we are processing
        component - UIComponent to be decoded.
        submittedValue - a value stored on the component during decode.
        Throws:
        ConverterException - if the submitted value cannot be converted successfully.
        NullPointerException - if context or component is null

Nederlandse vertaling

U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.

Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.

Bij voorbaat dank.

Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/faces/render/renderer.html

De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.

Referenties

  1. Bekijk - html-document Taal van het document:fr Manuel PHP : https://docs.oracle.com

Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.