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

javax.faces.application
Класс StateManager

java.lang.Object
  javax.faces.application.StateManager

Прямые Известные Подклассы:

StateManagerWrapper

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

StateManager направляет процесс сохранения и восстановления представления между запросами. Реализация этого class должна быть ориентирована на многопотоковое исполнение. StateManager экземпляр для приложения получается от Application экземпляр, и таким образом не может знать детали языка разметки, создаваемого RenderKit будучи имевшимся обыкновение представлять представление. StateManager использует объект помощника (ResponseStateManager), это обеспечивается RenderKit реализация и поэтому знает о деталях языка разметки.

Вложенная Сводка Класса

class

StateManager. SerializedView Осуждаемый. Этот class не был отмечен Serializable в 1.0 версиях спецификации. Это был также не статический внутренний class, таким образом, это не может быть сделано быть Serializable. Поэтому, это осуждается в версии 1.2 спецификации. Замена должна использовать зависящее от реализации Object.

Полевая Сводка

static java.lang.String	FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME Время выполнения должно интерпретировать значение этого параметра как список разделенных запятой значений ID представления, у каждого из которых должно быть сохраненное использование их состояния механизма сохранения состояния, определенного в JSF 1.2.
static java.lang.String	IS_BUILDING_INITIAL_STATE Маркер в пределах FacesContext атрибуты отображаются, чтобы указать, что мы отмечаем начальное состояние, таким образом, markInitialState() метод итерации компонентов такой как UIData мог распознать этот факт и сохранить начальное состояние потомков.
static java.lang.String	IS_SAVING_STATE Маркер в пределах FacesContext атрибуты отображаются, чтобы указать, что мы сохраняем состояние.
static java.lang.String	PARTIAL_STATE_SAVING_PARAM_NAME ServletContext параметр init, с которым консультируется время выполнения, чтобы определить, должен ли частичный механизм сохранения состояния использоваться.
static java.lang.String	STATE_SAVING_METHOD_CLIENT Постоянная величина для параметра инициализации, названного STATE_SAVING_METHOD_PARAM_NAME это указывает, что сохранение состояния должно иметь место на клиенте.
static java.lang.String	STATE_SAVING_METHOD_PARAM_NAME ServletContext параметр init, с которым консультируются StateManager сказать, где состояние должно быть сохранено.
static java.lang.String	STATE_SAVING_METHOD_SERVER Постоянная величина для параметра инициализации, названного STATE_SAVING_METHOD_PARAM_NAME это указывает, что сохранение состояния должно иметь место на сервере.

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

StateManager()

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

protected java.lang.Object	getComponentStateToSave(FacesContext context) Осуждаемый. различие между древовидной структурой и компонентным состоянием является теперь деталью реализации. Возвраты реализации по умолчанию null.
protected java.lang.Object	getTreeStructureToSave(FacesContext context) Осуждаемый. различие между древовидной структурой и компонентным состоянием является теперь деталью реализации. Возвраты реализации по умолчанию null.
java.lang.String	getViewState(FacesContext context) Метод удобства, чтобы возвратить состояние отображения как a String без RenderKit определенная разметка.
boolean	isSavingStateInClient(FacesContext context)
protected void	restoreComponentState(FacesContext context, UIViewRoot viewRoot, java.lang.String renderKitId) Осуждаемый. различие между древовидной структурой и компонентным состоянием является теперь деталью реализации. Реализация по умолчанию ничего не делает.
protected UIViewRoot	restoreTreeStructure(FacesContext context, java.lang.String viewId, java.lang.String renderKitId) Осуждаемый. различие между древовидной структурой и компонентным состоянием является теперь деталью реализации. Возвраты реализации по умолчанию null.
abstract UIViewRoot	restoreView(FacesContext context, java.lang.String viewId, java.lang.String renderKitId) Восстановите древовидную структуру и компонентное состояние представления для указанного viewId, зависящим от реализации способом, и возвратом восстановленный UIViewRoot.
StateManager. SerializedView	saveSerializedView(FacesContext context) Осуждаемый. это было заменено saveView(javax.faces.context.FacesContext). Вызовы реализации по умолчанию saveView и осматривает возврат. Если возврат Object [], это бросает результат к Object [] обертывание первых и вторых элементов в экземпляре StateManager.SerializedView, который это тогда возвращает. Иначе, это возвращается null
java.lang.Object	saveView(FacesContext context) Возвратите непрозрачное Object содержа достаточную информацию для этого того же самого экземпляра, чтобы восстановить состояние тока UIViewRoot по последующему запросу.
void	writeState(FacesContext context, java.lang.Object state) Сохраните состояние, представленное в указанном состоянии Object экземпляр, зависящим от реализации способом.
void	writeState(FacesContext context, StateManager.SerializedView state) Осуждаемый. Этот метод был заменен writeState(javax.faces.context.FacesContext,java.lang.Object). Реализация по умолчанию вызывает неосуждаемую разновидность метода, передающего Object [] как второй параметр, где первый элемент массива является возвратом из getStructure() и вторым является возврат из getState() на параметре state.

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

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

Полевая Деталь

STATE_SAVING_METHOD_PARAM_NAME

public static final java.lang.String STATE_SAVING_METHOD_PARAM_NAME

ServletContext параметр init, с которым консультируются StateManager сказать, где состояние должно быть сохранено. Допустимые значения даются как значения констант: STATE_SAVING_METHOD_CLIENT или STATE_SAVING_METHOD_SERVER.

Если этот параметр не определяется, значение по умолчанию является значением константы STATE_SAVING_METHOD_CLIENT.

См. Также:

Постоянные Значения полей

PARTIAL_STATE_SAVING_PARAM_NAME

public static final java.lang.String PARTIAL_STATE_SAVING_PARAM_NAME

ServletContext параметр init, с которым консультируется время выполнения, чтобы определить, должен ли частичный механизм сохранения состояния использоваться.

Если неопределенный, время выполнения должно определить уровень версии приложения.

• Для приложений, имеющих версию в 1.2 и под, время выполнения не должно использовать частичный механизм сохранения состояния.

• Для приложений, имеющих версию в 2.0 и выше, время выполнения должно использовать частичный механизм сохранения состояния.

Если этот параметр определяется, и приложение является имеющим версию в 1.2 и под, время выполнения не должно использовать частичный механизм сохранения состояния. Иначе, Если этот param определяется, и вызов toLowerCase().equals("true") на a String представление его возвратов значения true, время выполнения должно использовать частичный механизм состояния. Иначе частичный механизм сохранения состояния не должен использоваться.

С тех пор:

2.0

См. Также:

Постоянные Значения полей

FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME

public static final java.lang.String FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME

Время выполнения должно интерпретировать значение этого параметра как список разделенных запятой значений ID представления, у каждого из которых должно быть сохраненное использование их состояния механизма сохранения состояния, определенного в JSF 1.2.

См. Также:

Постоянные Значения полей

IS_SAVING_STATE

public static final java.lang.String IS_SAVING_STATE

Маркер в пределах FacesContext атрибуты отображаются, чтобы указать, что мы сохраняем состояние. Реализация должна установить этот маркер в карту прежде, чем запустить обход сохранения состояния, и маркер должен быть очищен, в наконец блок, после того, как обход полон.

См. Также:

Постоянные Значения полей

IS_BUILDING_INITIAL_STATE

public static final java.lang.String IS_BUILDING_INITIAL_STATE

Маркер в пределах FacesContext атрибуты отображаются, чтобы указать, что мы отмечаем начальное состояние, таким образом, markInitialState() метод итерации компонентов такой как UIData мог распознать этот факт и сохранить начальное состояние потомков.

С тех пор:

2.1

См. Также:

Постоянные Значения полей

STATE_SAVING_METHOD_CLIENT

public static final java.lang.String STATE_SAVING_METHOD_CLIENT

Постоянная величина для параметра инициализации, названного STATE_SAVING_METHOD_PARAM_NAME это указывает, что сохранение состояния должно иметь место на клиенте.

См. Также:

Постоянные Значения полей

STATE_SAVING_METHOD_SERVER

public static final java.lang.String STATE_SAVING_METHOD_SERVER

Постоянная величина для параметра инициализации, названного STATE_SAVING_METHOD_PARAM_NAME это указывает, что сохранение состояния должно иметь место на сервере.

См. Также:

Постоянные Значения полей

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

StateManager

public StateManager()

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

saveSerializedView

public StateManager.SerializedView saveSerializedView(FacesContext context)

Осуждаемый. это было заменено saveView(javax.faces.context.FacesContext). Вызовы реализации по умолчанию saveView и осматривает возврат. Если возврат Object [], это бросает результат к Object [] обертывание первых и вторых элементов в экземпляре StateManager.SerializedView, который это тогда возвращает. Иначе, это возвращается null

Возвратите древовидную структуру и компонентную информацию о состоянии для представления, содержавшегося в указанном FacesContext экземпляр как объект типа StateManager.SerializedView. Если нет никакой информации о состоянии, которая будет сохранена, возвратиться null вместо этого.

Компоненты могут выбрать из того, чтобы быть включенным в сериализированное представление, устанавливая их transient свойство к true. Это должно вызвать компонент непосредственно, так же как все дочерние элементы того компонента и фасеты, чтобы быть опущенным от сохраненной древовидной структуры и компонентной информации о состоянии.

Этот метод должен также осуществить правило что для компонентов с ненулем ids, все компоненты, которые являются потомками самого близкого того же самого NamingContainer должен иметь уникальные идентификаторы.

Параметры:

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

Броски:

IllegalStateException - если больше чем один компонент или фасет в пределах того же самого NamingContainer в этом представлении имеет то же самое не -null компонентный идентификатор

saveView

public java.lang.Object saveView(FacesContext context)

Возвратите непрозрачное Object содержа достаточную информацию для этого того же самого экземпляра, чтобы восстановить состояние тока UIViewRoot по последующему запросу. Возвращенный объект должен реализовать java.io.Serializable. Если нет никакой информации о состоянии, которая будет сохранена, возвратиться null вместо этого.

Компоненты могут выбрать из того, чтобы быть включенным в сериализированное представление, устанавливая их transient свойство к true. Это должно вызвать компонент непосредственно, так же как все дочерние элементы того компонента и фасеты, чтобы быть опущенным от сохраненной древовидной структуры и компонентной информации о состоянии.

Этот метод должен также осуществить правило что для компонентов с ненулем ids, все компоненты, которые являются потомками самого близкого того же самого NamingContainer должен иметь уникальные идентификаторы.

Для назад compatability с существующим StateManager реализации, реализация по умолчанию этого вызовы метода saveSerializedView(javax.faces.context.FacesContext) и создает и возвращает два элемента Object массив с нулем элемента, содержащим structure свойство и элемент один содержащий state свойство SerializedView.

Параметры:

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

Броски:

IllegalStateException - если больше чем один компонент или фасет в пределах того же самого NamingContainer в этом представлении имеет то же самое не -null компонентный идентификатор

С тех пор:

1.2

getTreeStructureToSave

protected java.lang.Object getTreeStructureToSave(FacesContext context)

Осуждаемый. различие между древовидной структурой и компонентным состоянием является теперь деталью реализации. Возвраты реализации по умолчанию null.

Метод удобства, которым нужно вызвать saveSerializedView(), создать и возвратить a Serializable объект, который представляет структуру всего компонентного дерева (включая дочерние элементы и фасеты) этого представления.

Компоненты могут уклонение того, чтобы быть включенным в древовидную структуру, устанавливая их transient свойство к true. Это должно вызвать компонент непосредственно, так же как все дочерние элементы того компонента и фасеты, чтобы быть опущенным от сохраненной информации о древовидной структуре.

Параметры:

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

getComponentStateToSave

protected java.lang.Object getComponentStateToSave(FacesContext context)

Осуждаемый. различие между древовидной структурой и компонентным состоянием является теперь деталью реализации. Возвраты реализации по умолчанию null.

Метод удобства, которым нужно вызвать saveSerializedView(), создать и возвратить a Serializable объект, который представляет состояние всех компонентных свойств, атрибутов, и присоединенных объектов, для всего компонентного дерева (включая дочерние элементы и фасеты) этого представления.

Компоненты могут уклонение того, чтобы быть включенным в компонентное состояние, устанавливая их transient свойство к true. Это должно вызвать компонент непосредственно, так же как все дочерние элементы того компонента и фасеты, чтобы быть опущенным от сохраненной компонентной информации о состоянии.

Параметры:

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

состояние записи

public void writeState(FacesContext context,
                       java.lang.Object state)
                throws java.io.IOException

Сохраните состояние, представленное в указанном состоянии Object экземпляр, зависящим от реализации способом.

Этот метод будет обычно просто делегировать фактическую запись в writeState() метод ResponseStateManager экземпляр, обеспеченный RenderKit будучи имевшимся обыкновение представлять это представление. Этот метод предполагает, что вызывающая сторона расположила ResponseWriter в корректной позиции для сохраненного состояния, которое будет записано.

Для назад compatability с существующим StateManager реализации, реализация по умолчанию этого метода проверяет, является ли параметром экземпляр Object [] из длины, больше чем или равный два. Если так, это создает a SerializedView экземпляр с древовидной структурой, прибывающей из нуля элемента и компонентного состояния, прибывающего из элемента один и вызовы через к writeState(javax.faces.context.FacesContext,javax.faces.application.StateManager.SerializedView). В противном случае ничего не делает.

Параметры:

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

state - Сериализуемое состояние, которое будет записано, как возвращено saveSerializedView(javax.faces.context.FacesContext)

Броски:

java.io.IOException

С тех пор:

1.2

состояние записи

public void writeState(FacesContext context,
                       StateManager.SerializedView state)
                throws java.io.IOException

Осуждаемый. Этот метод был заменен writeState(javax.faces.context.FacesContext,java.lang.Object). Реализация по умолчанию вызывает неосуждаемую разновидность метода, передающего Object [] как второй параметр, где первый элемент массива является возвратом из getStructure() и вторым является возврат из getState() на параметре state.

Сохраните состояние, представленное в указанном SerializedView isntance, зависящим от реализации способом.

Этот метод должен консультироваться с параметром инициализации контекста, названным символьной константой StateManager.STATE_SAVING_METHOD_PARAM_NAME определить, должно ли состояние быть сохранено на клиенте или сервере. Если не существующее клиентское сохранение состояния принимается.

Если init параметр указывает, что клиентское сохранение состояния должно использоваться, этот метод должен делегировать фактическую запись в writeState() метод ResponseStateManager экземпляр, обеспеченный RenderKit будучи имевшимся обыкновение представлять это представление. Этот метод предполагает, что вызывающая сторона расположила ResponseWriter в корректной позиции для сохраненного состояния, которое будет записано.

Параметры:

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

state - сериализированное состояние, которое будет записано

Броски:

java.io.IOException

restoreView

public abstract UIViewRoot restoreView(FacesContext context,
                                       java.lang.String viewId,
                                       java.lang.String renderKitId)

Восстановите древовидную структуру и компонентное состояние представления для указанного viewId, зависящим от реализации способом, и возвратом восстановленный UIViewRoot. Если нет никакой сохраненной информации о состоянии, доступной для этого viewId, возвратиться null вместо этого.

Этот метод должен консультироваться с параметром инициализации контекста, названным символьной константой StateManager.STATE_SAVING_METHOD_PARAM_NAME определить, должно ли состояние быть сохранено на клиенте или сервере. Если не существующее клиентское сохранение состояния принимается.

Если init параметр указывает, что клиентское сохранение состояния должно использоваться, этот метод должен вызвать getTreeStructureToRestore() и (если предыдущий вызов метода, возвращенный ненулевое значение) getComponentStateToRestore() методы ResponseStateManager экземпляр, обеспеченный RenderKit ответственный за это представление.

Параметры:

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

viewId - Идентификатор представления представления, которое будет восстановлено

renderKitId - renderKitId, используемый, чтобы представить этот ответ. Не должен быть null.

Броски:

IllegalArgumentException - если renderKitId null.

restoreTreeStructure

protected UIViewRoot restoreTreeStructure(FacesContext context,
                                          java.lang.String viewId,
                                          java.lang.String renderKitId)

Осуждаемый. различие между древовидной структурой и компонентным состоянием является теперь деталью реализации. Возвраты реализации по умолчанию null.

Метод удобства, которым нужно вызвать restoreView(), создать и возвратить a UIViewRoot экземпляр (заполненный с дочерними элементами и фасетами) представление древовидной структуры компонентного восстанавливаемого дерева. Если никакая сохраненная информация о состоянии не доступна, возвратиться null вместо этого.

Параметры:

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

viewId - Идентификатор представления представления, которое будет восстановлено

renderKitId - renderKitId, используемый, чтобы представить этот ответ. Не должен быть null.

Броски:

IllegalArgumentException - если renderKitId null.

restoreComponentState

protected void restoreComponentState(FacesContext context,
                                     UIViewRoot viewRoot,
                                     java.lang.String renderKitId)

Осуждаемый. различие между древовидной структурой и компонентным состоянием является теперь деталью реализации. Реализация по умолчанию ничего не делает.

Метод удобства, которым нужно вызвать restoreView(), восстановить атрибуты, свойства, и присоединенные объекты всех компонентов в восстановленном компонентном дереве.

Параметры:

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

viewRoot - UIViewRoot возвращенный предыдущим звонком restoreTreeStructure()

renderKitId - renderKitId, используемый, чтобы представить этот ответ. Не должен быть null.

Броски:

IllegalArgumentException - если renderKitId null.

isSavingStateInClient

public boolean isSavingStateInClient(FacesContext context)

Возвраты:

true если и только если значение ServletContext параметр init называет значение константы STATE_SAVING_METHOD_PARAM_NAME равно значению константы STATE_SAVING_METHOD_CLIENT. false иначе.

Броски:

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

getViewState

public java.lang.String getViewState(FacesContext context)

Метод удобства, чтобы возвратить состояние отображения как a String без RenderKit определенная разметка. Эта реализация по умолчанию этого метода вызовет saveView(javax.faces.context.FacesContext) и передача результата к и возврат получающегося значения от ResponseStateManager#getViewState(javax.faces.context.FacesContext, Object).

Параметры:

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

С тех пор:

2.0