Spec-Zone .ru
спецификации, руководства, описания, API
|
|
Spec-Zone .ru
спецификации, руководства, описания, API
|
|
|||||||||
| ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
| СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД | ||||||||
java.lang.Objectjavax.faces.application.ViewHandler
public abstract class ViewHandler
ViewHandler является pluggablity механизмом для того, чтобы позволить реализациям или приложениям, используя спецификацию Поверхностей JavaServer обеспечивать свою собственную обработку действий в Представлять фазах Представления Ответа и Восстановления жизненного цикла обработки запросов. Это учитывает реализации, чтобы поддерживать различные технологии генерации ответа, так же как альтернативные стратегии сохранения и восстановления состояния каждого представления. Реализация этого class должна быть ориентирована на многопотоковое исполнение.
Пожалуйста, см. StateManager для информации, на как ViewHandler взаимодействует StateManager.
Версия 2 спецификации, формально представленной понятие Языка Объявления Представления. Язык Объявления Представления (VDL) является синтаксисом, используемым, чтобы объявить пользовательские интерфейсы, состоявшие из экземпляров JSF UIComponents. Любые из обязанностей ViewHandler это определенно имеет дело с подсистемой VDL, теперь домен реализации VDL. Эти обязанности определяются на ViewDeclarationLanguage class. ViewHandler обеспечивает getViewDeclarationLanguage(javax.faces.context.FacesContext, java.lang.String) как метод удобства, чтобы получить доступ к реализации VDL, данной a viewId.
| Полевая Сводка | |
|---|---|
static java.lang.String |
CHARACTER_ENCODING_KEY
Ключ, в наборе атрибута сеанса, под которым кодировка символов ответа может быть сохранена и получена. |
static java.lang.String |
DEFAULT_FACELETS_SUFFIX
Значение, чтобы использовать для расширения по умолчанию для Facelet базируемые страницы XHTML, если веб-приложение использует отображение расширения url. |
static java.lang.String |
DEFAULT_SUFFIX
Значение, чтобы использовать для расширения по умолчанию, если веб-приложение использует отображение расширения url. |
static java.lang.String |
DEFAULT_SUFFIX_PARAM_NAME
Позвольте веб-приложению определять список альтернативных суффиксов для страниц, содержащих контент JSF. |
static java.lang.String |
FACELETS_SUFFIX_PARAM_NAME
Позвольте веб-приложению определять альтернативный суффикс для Facelet базируемые страницы XHTML, содержащие контент JSF. |
static java.lang.String |
FACELETS_VIEW_MAPPINGS_PARAM_NAME
Позвольте веб-приложению определять точку с запятой (;) разделенный список строк, который используется, чтобы насильственно объявить, что определенные страницы в приложении должны быть интерпретированы как использование Facelets, независимо от их расширения. |
| Сводка конструктора | |
|---|---|
ViewHandler()
|
|
| Сводка метода | |
|---|---|
java.lang.String |
calculateCharacterEncoding(FacesContext context)
Возвращает корректную кодировку символов, которая будет использоваться для этого запроса. |
abstract java.util.Locale |
calculateLocale(FacesContext context)
Возвращает соответствующее Locale использовать для этого и последующих запросов на текущий клиент. |
abstract java.lang.String |
calculateRenderKitId(FacesContext context)
Возвратите соответствующее renderKitId для этого и последующих запросов от текущего клиента. |
abstract UIViewRoot |
createView(FacesContext context, java.lang.String viewId)
Создайте и возвратите новое UIViewRoot экземпляр инициализируется с информацией от параметра FacesContext и viewId. |
java.lang.String |
deriveLogicalViewId(FacesContext context, java.lang.String rawViewId)
Получите и возвратите viewId из текущего запроса, или параметр, введенный следующим алгоритм, определенный в разделе спецификации JSF.7.5.2. |
java.lang.String |
deriveViewId(FacesContext context, java.lang.String rawViewId)
Получите и возвратите viewId из текущего запроса, или параметр, введенный следующим алгоритм, определенный в разделе спецификации JSF.7.5.2. |
abstract java.lang.String |
getActionURL(FacesContext context, java.lang.String viewId)
Если значение, возвращенное из этого метода, используется в качестве |
java.lang.String |
getBookmarkableURL(FacesContext context, java.lang.String viewId, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters, boolean includeViewParams)
Возвратите действие JSF URL, полученный из viewId параметра, который является подходящим, чтобы использоваться в качестве цели ссылки в ответе JSF. |
java.lang.String |
getRedirectURL(FacesContext context, java.lang.String viewId, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters, boolean includeViewParams)
Возвратите действие JSF URL, полученный из |
abstract java.lang.String |
getResourceURL(FacesContext context, java.lang.String path)
Если значение, возвращенное из этого метода, используется в качестве |
ViewDeclarationLanguage |
getViewDeclarationLanguage(FacesContext context, java.lang.String viewId)
Возвратитесь |
void |
initView(FacesContext context)
Инициализируйте представление для жизненного цикла обработки запросов. |
abstract void |
renderView(FacesContext context, UIViewRoot viewToRender)
Выполните любые действия, обязаны представлять представление ответа к объекту ответа, связанному с током FacesContext. |
abstract UIViewRoot |
restoreView(FacesContext context, java.lang.String viewId)
Выполните любые действия, обязаны восстанавливать представление, связанное с указанным FacesContext и viewId. |
abstract void |
writeState(FacesContext context)
Примите любые соответствующие меры любому, сразу выписывают информацию о текущем состоянии (вызывая StateManager#writeState, или отмечая, где информация о состоянии должна позже быть записана. |
| Методы, наследованные от class java.lang. Объект |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Полевая Деталь |
|---|
public static final java.lang.String CHARACTER_ENCODING_KEY
Ключ, в наборе атрибута сеанса, под которым кодировка символов ответа может быть сохранена и получена.
public static final java.lang.String DEFAULT_SUFFIX_PARAM_NAME
Позвольте веб-приложению определять список альтернативных суффиксов для страниц, содержащих контент JSF. Этот список является пространством разделенный список значений формы .<extension>. Первый физический ресурс, расширение которого соответствует одно из сконфигурированных расширений, будет суффиксом, используемым, чтобы создать ID представления. Если этот init параметр не определяется, значение по умолчанию берется от значения константы DEFAULT_SUFFIX.
public static final java.lang.String DEFAULT_SUFFIX
Значение, чтобы использовать для расширения по умолчанию, если веб-приложение использует отображение расширения url.
public static final java.lang.String FACELETS_SUFFIX_PARAM_NAME
Позвольте веб-приложению определять альтернативный суффикс для Facelet базируемые страницы XHTML, содержащие контент JSF. Если этот init параметр не определяется, значение по умолчанию берется от значения константы DEFAULT_FACELETS_SUFFIX
public static final java.lang.String DEFAULT_FACELETS_SUFFIX
Значение, чтобы использовать для расширения по умолчанию для Facelet базируемые страницы XHTML, если веб-приложение использует отображение расширения url.
public static final java.lang.String FACELETS_VIEW_MAPPINGS_PARAM_NAME
Позвольте веб-приложению определять точку с запятой (;) разделенный список строк, который используется, чтобы насильственно объявить, что определенные страницы в приложении должны быть интерпретированы как использование Facelets, независимо от их расширения. Каждая запись в точке с запятой (;) разделенный список строк является любой расширением файла, как в *.xhtml, или префикс ресурса (запускающийся с '/' и интерпретируемый как относительно корня веб-приложения), как в /user/*. Последний class записи может также принять форму /<filename>.<extension>* такой как /login.jsp*. Время выполнения должно также рассмотреть facelets.VIEW_MAPPINGS param называют как псевдоним к этому имени param для назад совместимости с существующими приложениями Facelets.
| Деталь конструктора |
|---|
public ViewHandler()
| Деталь метода |
|---|
public abstract java.util.Locale calculateLocale(FacesContext context)
Возвращает соответствующее Locale использовать для этого и последующих запросов на текущий клиент.
context - FacesContext для текущего запроса java.lang.NullPointerException - если context nullpublic java.lang.String calculateCharacterEncoding(FacesContext context)
Возвращает корректную кодировку символов, которая будет использоваться для этого запроса.
Следующий алгоритм используется.
Исследуйте Content-Type заголовок запроса. Если у этого есть a charset параметр, извлеките это и возврат что как кодирование.
Если нет charset параметр был найден, проверьте на существование сеанса, вызывая ExternalContext#getSession(boolean) передача false как параметр. Если тот метод возвращается true, получите Карту сеанса, вызывая ExternalContext#getSessionMap и ищите значение под ключом, данным значением символьной константы ViewHandler#CHARACTER_ENCODING_KEY. Если существующий, возвратите значение, преобразованное в Строку.
Иначе, возвратиться null
public abstract java.lang.String calculateRenderKitId(FacesContext context)
Возвратите соответствующее renderKitId для этого и последующих запросов от текущего клиента. Это - ошибка для этого метода, чтобы возвратиться null.
Возвращаемое значение значения по умолчанию RenderKitFactory.HTML_BASIC_RENDER_KIT.
context - FacesContext для текущего запроса java.lang.NullPointerException - если context null
public abstract UIViewRoot createView(FacesContext context,
java.lang.String viewId)
Создайте и возвратите новое UIViewRoot экземпляр инициализируется с информацией от параметра FacesContext и viewId. Расположитесь ViewDeclarationLanguage реализация для VDL используется в представлении. Параметр viewId должен быть преобразован в медосмотр viewId это может обратиться к фактическому ресурсу, подходящему для использования ViewDeclarationLanguage ViewDeclarationLanguage#createView, который должен вызвать этот метод.
java.lang.NullPointerException - если context null
public java.lang.String deriveViewId(FacesContext context,
java.lang.String rawViewId)
Получите и возвратите viewId из текущего запроса, или параметр, введенный следующим алгоритм, определенный в разделе спецификации JSF.7.5.2.
Реализация по умолчанию этого метода просто возвращается rawViewId неизменный.
context - FacesContext для этого запросаrawViewId - viewId произойти,
public java.lang.String deriveLogicalViewId(FacesContext context,
java.lang.String rawViewId)
Получите и возвратите viewId из текущего запроса, или параметр, введенный следующим алгоритм, определенный в разделе спецификации JSF.7.5.2. Отметьте это в отличие от этого deriveViewId(), этот метод не требует, чтобы присутствовало физическое представление.
Реализация по умолчанию этого метода просто возвращается rawViewId неизменный.
context - FacesContext для этого запросаrawViewId - viewId произойти,
public abstract java.lang.String getActionURL(FacesContext context,
java.lang.String viewId)
Если значение, возвращенное из этого метода, используется в качестве file параметр конструктору с четырьмя параметрами для java.net.URL (принимающий соответствующие значения используются для первых трех параметров), затем клиент, обращающийся с просьбой к toExternalForm() из этого URL выберет параметр viewId для того, чтобы пересечь жизненный цикл JSF. Пожалуйста, см. раздел JSF.7.5.2 для полной спецификации.
context - FacesContext для этого запросаviewId - Идентификатор представления требуемого представления IllegalArgumentException - если viewId не допустимо для этого ViewHandler, или не запускается с "/". java.lang.NullPointerException - если context или viewId null.
public abstract java.lang.String getResourceURL(FacesContext context,
java.lang.String path)
Если значение, возвращенное из этого метода, используется в качестве file параметр конструктору с четырьмя параметрами для java.net.URL (принимающий соответствующие значения используются для первых трех параметров), затем клиент, обращающийся с просьбой к toExternalForm() из этого URL выберет параметр path для прямого рендеринга. Если указанный путь запускается с наклонной черты, он должен быть обработан как контекстно-зависимое; иначе, это должно быть обработано как относительно действия URL текущего представления.
context - FacesContext для текущего запросаpath - Путь ресурса, чтобы преобразовать в URL IllegalArgumentException - если viewId не допустимо для этого ViewHandler. java.lang.NullPointerException - если context или path null.
public java.lang.String getRedirectURL(FacesContext context,
java.lang.String viewId,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters,
boolean includeViewParams)
Возвратите действие JSF URL, полученный из viewId параметр, который является подходящим, чтобы использоваться NavigationHandler выпустить запрос перенаправления к URL, используя запрос NonFaces. Реализации Compiliant должны реализовать этот метод как определено в разделе JSF.7.5.2. Реализация по умолчанию просто вызывает через к getActionURL(javax.faces.context.FacesContext, java.lang.String), передача параметров context и viewId.
context - FacesContext, обрабатывающий этот запросviewId - Идентификатор представления целевой страницыparameters - Отображение названий параметра к одному или более значениямincludeViewParams - Флаг, указывающий, должны ли параметры представления быть закодированы в этот URL
public java.lang.String getBookmarkableURL(FacesContext context,
java.lang.String viewId,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters,
boolean includeViewParams)
Возвратите действие JSF URL, полученный из viewId параметра, который является подходящим, чтобы использоваться в качестве цели ссылки в ответе JSF. Реализации Compiliant должны реализовать этот метод как определено в разделе JSF.7.5.2. Реализация по умолчанию просто вызывает через к getActionURL(javax.faces.context.FacesContext, java.lang.String), передача параметров context и viewId.
context - FacesContext, обрабатывающий этот запросviewId - Идентификатор представления целевой страницыparameters - Отображение названий параметра к одному или более значениямincludeViewParams - Флаг, указывающий, должны ли параметры представления быть закодированы в этот URL
public ViewDeclarationLanguage getViewDeclarationLanguage(FacesContext context,
java.lang.String viewId)
Возвратитесь ViewDeclarationLanguage экземпляр используется для этого ViewHandler экземпляр.
Реализация по умолчанию должна использовать ViewDeclarationLanguageFactory.getViewDeclarationLanguage(java.lang.String) получить соответствующее ViewDeclarationLanguage реализация для параметра viewId. Любые исключения, выданные в результате вызова того метода, нельзя глотать.
Реализация по умолчанию этого метода возвращает нуль.
context - FacesContext для этого запроса.viewId - идентификатор логического представления, как возвращено из deriveLogicalViewId(javax.faces.context.FacesContext, java.lang.String) для которого ViewDeclarationLanguage должен быть возвращен.
public void initView(FacesContext context)
throws FacesException
Инициализируйте представление для жизненного цикла обработки запросов.
Этот метод нужно вызвать в начале Фазы Представления Восстановления Жизненного цикла Обработки запросов. Это ответственно за выполнение любой инициализации на запрос, необходимой для работы lifycecle.
Реализация по умолчанию должна выполнить следующие действия. Если ExternalContext#getRequestCharacterEncoding возвраты null, вызвать calculateCharacterEncoding(javax.faces.context.FacesContext) и передайте результат, если не -null, в ExternalContext#setRequestCharacterEncoding метод. Если ExternalContext#getRequestCharacterEncoding возвраты не -null не предпримите меры.
FacesException - если проблема происходит, устанавливая кодирование, такой как UnsupportedEncodingException брошенный базовой технологией Сервлета или Портлета, когда кодирование не поддерживается.
public abstract void renderView(FacesContext context,
UIViewRoot viewToRender)
throws java.io.IOException,
FacesException
Выполните любые действия, обязаны представлять представление ответа к объекту ответа, связанному с током FacesContext.
Иначе, реализация по умолчанию должна получить ссылку на ViewDeclarationLanguage для viewId из параметра viewToRender и вызовите ViewDeclarationLanguage#renderView метод, возвращая результат и не глотая любые исключения, выданные тем методом.
context - FacesContext для текущего запросаviewToRender - представление, чтобы представить java.io.IOException - если ввод/ошибка на выходе происходит java.lang.NullPointerException - если context или viewToRender null
FacesException - если ошибка сервлета происходит
public abstract UIViewRoot restoreView(FacesContext context,
java.lang.String viewId)
Выполните любые действия, обязаны восстанавливать представление, связанное с указанным FacesContext и viewId. Это может делегировать к restoreView из связанного StateManager сделать фактическую работу восстановления представления. Если нет никакого доступного состояния для указанного viewId, возвратиться null.
Иначе, реализация по умолчанию должна получить ссылку на ViewDeclarationLanguage для этого viewId и вызовите ViewDeclarationLanguage#restoreView метод, возвращая результат и не глотая любые исключения, выданные тем методом.
context - FacesContext для текущего запросаviewId - идентификатор представления для текущего запроса java.lang.NullPointerException - если context null
FacesException - если ошибка сервлета происходит
public abstract void writeState(FacesContext context)
throws java.io.IOException
Примите любые соответствующие меры любому, сразу выписывают информацию о текущем состоянии (вызывая StateManager#writeState, или отмечая, где информация о состоянии должна позже быть записана.
Этот метод ничего не должен сделать, если текущий запрос Ajax запрос. Отвечая на Ajax запросы, состояние получается, вызывая StateManager#getViewState и затем вписанный Ajax ответ во время кодирования финала (UIViewRoot.encodeEnd(javax.faces.context.FacesContext).
context - FacesContext для текущего запроса java.io.IOException - если ввод/ошибка на выходе происходит java.lang.NullPointerException - если context null
|
|||||||||
| ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
| СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД | ||||||||
Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается
Сгенерированный на 10-February-2011 12:41