Spec-Zone .ru спецификации, руководства, описания, API

javax.faces.render
Средство рендеринга класса

java.lang.Object
  javax.faces.render.Renderer

public abstract class Renderer
расширяет java.lang. Объект

Средство рендеринга преобразовывает внутреннее представление UIComponents в поток вывода (или писатель) связанный с ответом мы создаем для определенного запроса. Каждый Renderer знает, как представить один или больше UIComponent типы (или классы), и дают объявление, ряд представляют - зависимые атрибуты, которые он распознает для каждого поддерживаемого UIComponent.

Семейства Renderers упаковываются как a RenderKit, и вместе поддерживайте рендеринг всего из UIComponents в представлении связался с a FacesContext. В пределах набора Renderers для детали RenderKit, каждый должен быть однозначно определен rendererType свойство.

Человек Renderer экземпляры инстанцируют согласно просьбе во время процесса рендеринга, и останутся существующими для остатка от времени жизни веб-приложения. Поскольку каждый экземпляр может быть вызван больше чем от одного потока обработки запросов одновременно, они ДОЛЖНЫ быть запрограммированы ориентированным на многопотоковое исполнение способом.

Если ListenerFor аннотация присоединена к определению class a Renderer, тот class должен также реализовать ComponentSystemEventListener, и действие, имеющее отношение к обработке ResourceDependency на a Renderer описанный в ListenerFor должен быть взят.

Если ResourceDependency аннотация присоединена к определению class a Renderer, действие, имеющее отношение к обработке ResourceDependency на a Renderer описанный в UIComponent#getChildren должен быть взят.

Сводка конструктора

Renderer()

Сводка метода

java.lang.String	convertClientId(FacesContext context, java.lang.String clientId) Преобразуйте компонент сгенерированный клиентский идентификатор в форму, подходящую для передачи клиенту.
void	decode(FacesContext context, UIComponent component) Декодируйте любое новое состояние указанного UIComponent от запроса, содержавшегося в указанном FacesContext, и хранилище то состояние на UIComponent.
void	encodeBegin(FacesContext context, UIComponent component) Представьте определенное начало UIComponent к потоку вывода или писателю, связанному с ответом, мы создаем.
void	encodeChildren(FacesContext context, UIComponent component) Представьте дочерние компоненты этого UIComponent, после правил, описанных для encodeBegin() получать соответствующее значение, которое будет представлено.
void	encodeEnd(FacesContext context, UIComponent component) Представьте окончание текущего состояния указанного UIComponent, после правил, описанных для encodeBegin() получать соответствующее значение, которое будет представлено.
java.lang.Object	getConvertedValue(FacesContext context, UIComponent component, java.lang.Object submittedValue) Попытайтесь преобразовать ранее хранившую информацию состояния в объект типа, требуемого для этого компонента (дополнительно использующий зарегистрированный Converter для этого компонента, если есть один).
boolean	getRendersChildren() Возвратите флаг, указывающий ли это Renderer ответственно за рендеринг дочерних элементов компонент, который просят представить.

Методы, наследованные от class java.lang. Объект

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

Деталь конструктора

Средство рендеринга

public Renderer()

Деталь метода

декодировать

public void decode(FacesContext context,
                   UIComponent component)

Декодируйте любое новое состояние указанного UIComponent от запроса, содержавшегося в указанном FacesContext, и хранилище то состояние на UIComponent.

Во время декодирования события могут ставиться в очередь для дальнейшей обработки (слушателями события, которые зарегистрировали интерес), вызывая queueEvent() на связанном UIComponent.

Параметры:

context - FacesContext для запроса мы обрабатываем

component - UIComponent декодироваться.

Броски:

java.lang.NullPointerException - если context или component null

encodeBegin

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

Представьте определенное начало UIComponent к потоку вывода или писателю, связанному с ответом, мы создаем. Если преобразование попыталось в предыдущем звонке getConvertedValue() для этого отказавшего компонента, информация о состоянии, сохраненная во время выполнения decode() должен использоваться, чтобы воспроизвести неправильный ввод.

Параметры:

context - FacesContext для запроса мы обрабатываем

component - UIComponent быть представленным

Броски:

java.io.IOException - если ввод/ошибка на выходе происходит, представляя

java.lang.NullPointerException - если context или component нуль

encodeChildren

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

Представьте дочерние компоненты этого UIComponent, после правил, описанных для encodeBegin() получать соответствующее значение, которое будет представлено. Этот метод только вызовут если rendersChildren свойство этого компонента true.

Параметры:

context - FacesContext для ответа мы создаем

component - UIComponent чьи дочерние элементы должны быть представлены

Броски:

java.io.IOException - если ввод/ошибка на выходе происходит, представляя

java.lang.NullPointerException - если context или component null

encodeEnd

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

Представьте окончание текущего состояния указанного UIComponent, после правил, описанных для encodeBegin() получать соответствующее значение, которое будет представлено.

Параметры:

context - FacesContext для ответа мы создаем

component - UIComponent быть представленным

Броски:

java.io.IOException - если ввод/ошибка на выходе происходит, представляя

java.lang.NullPointerException - если context или component null

convertClientId

public java.lang.String convertClientId(FacesContext context,
                                        java.lang.String clientId)

Преобразуйте компонент сгенерированный клиентский идентификатор в форму, подходящую для передачи клиенту.

Реализация по умолчанию возвращает параметр clientId неизменный.

Параметры:

context - FacesContext для текущего запроса

clientId - клиентский идентификатор, который будет преобразован в клиент определенный формат.

Броски:

java.lang.NullPointerException - если context или clientId null

getRendersChildren

public boolean getRendersChildren()

Возвратите флаг, указывающий ли это Renderer ответственно за рендеринг дочерних элементов компонент, который просят представить. Возвраты реализации по умолчанию false.

getConvertedValue

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

Попытайтесь преобразовать ранее хранившую информацию состояния в объект типа, требуемого для этого компонента (дополнительно использующий зарегистрированный Converter для этого компонента, если есть один). Если преобразование успешно, новое значение должно быть возвращено из этого метода; в противном случае a ConverterException должен быть брошен.

Параметры:

context - FacesContext для запроса мы обрабатываем

component - UIComponent декодироваться.

submittedValue - значение, сохраненное на компоненте во время decode.

Броски:

ConverterException - если представленное значение не может быть преобразовано успешно.

java.lang.NullPointerException - если context или component null