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


javax.faces.component
Класс UIComponentBase

java.lang.Object
  расширенный javax.faces.component.UIComponent
      расширенный javax.faces.component.UIComponentBase
Все Реализованные Интерфейсы:
java.util. EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder
Прямые Известные Подклассы:
UIColumn, UICommand, UIData, UIForm, UIGraphic, UIMessage, UIMessages, UINamingContainer, UIOutput, UIPanel, UIParameter, UISelectItem, UISelectItems, UIViewRoot

public abstract class UIComponentBase
расширяет UIComponent

UIComponentBase является основой удобства class, который реализует поведение бетона значения по умолчанию всех методов, определенных UIComponent.

По умолчанию этот class определяет getRendersChildren() найти средство рендеринга для этого компонента и вызвать getRendersChildren() метод. Реализация по умолчанию на Renderer возвраты false. С версии 1.2 Спецификации Поверхностей JavaServer компонентные авторы поощряются возвратиться true от этого метода и полагаются на реализацию encodeChildren(javax.faces.context.FacesContext) в этом class и в Средстве рендеринга (Renderer#encodeChildren). Подклассы, которые хотят управлять рендерингом их дочерних элементов, должны переопределить этот метод, чтобы возвратиться true вместо этого.


Полевая Сводка
 
Поля, наследованные от class 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
 
Сводка конструктора
UIComponentBase()
           
 
Сводка метода
 void addClientBehavior(java.lang.String eventName, ClientBehavior behavior)
          

Это - реализация по умолчанию ClientBehaviorHolder.addClientBehavior(java.lang.String, javax.faces.component.behavior.ClientBehavior).

protected  void addFacesListener(FacesListener listener)
          Добавьте указанное FacesListener к группе слушателей, зарегистрированных, чтобы получить уведомления о событии от этого UIComponent.
 void broadcast(FacesEvent event)
          Широковещательно передайте указанное FacesEvent всем зарегистрированным слушателям события, которые выразили интерес к событиям этого типа.
 void clearInitialState()
          

Для каждого из присоединенных объектов на этом экземпляре та реализация PartialStateHolder, вызвать PartialStateHolder#clearInitialState на присоединенном объекте.

 void decode(FacesContext context)
          Декодируйте любое новое состояние этого UIComponent от запроса, содержавшегося в указанном FacesContext, и сохраните это состояние как необходимый.
 void encodeBegin(FacesContext context)
          Если наш rendered свойство true, представьте начало текущего состояния этого UIComponent к ответу, содержавшемуся в указанном FacesContext.
 void encodeChildren(FacesContext context)
          Если наш rendered свойство true, представьте дочерний элемент UIComponents этого UIComponent.
 void encodeEnd(FacesContext context)
          Если наш rendered свойство true, представьте окончание текущего состояния этого UIComponent.
 UIComponent findComponent(java.lang.String expr)
          Ищите и возвратитесь UIComponent с id это соответствует указанное выражение поиска (если любой) согласно алгоритму, описанному ниже.
 java.util.Map<java.lang.String,java.lang.Object> getAttributes()
          Возвратите изменчивое Map представляя атрибуты (и свойства, см. ниже), связал wth это UIComponent, включенный названием атрибута (который должен быть Строкой).
 int getChildCount()
          Возвратите число дочернего элемента UIComponents, которые связываются с этим UIComponent.
 java.util.List<UIComponent> getChildren()
          Возвратите изменчивое List представление дочернего элемента UIComponents связанный с этим компонентом.
 java.util.Map<java.lang.String,java.util.List<ClientBehavior>> getClientBehaviors()
          

Это - реализация по умолчанию ClientBehaviorHolder.getClientBehaviors().

 java.lang.String getClientId(FacesContext context)
          Возвратите клиентский идентификатор для этого компонента, генерируя один в случае необходимости.
 java.lang.String getDefaultEventName()
          

Это - реализация по умолчанию ClientBehaviorHolder.getDefaultEventName().

 java.util.Collection<java.lang.String> getEventNames()
          

Это - реализация по умолчанию ClientBehaviorHolder.getEventNames().

protected  FacesContext getFacesContext()
          Метод удобства, чтобы возвратиться FacesContext экземпляр для текущего запроса.
protected  FacesListener[] getFacesListeners(java.lang.Class clazz)
          Возвратите массив зарегистрированных FacesListeners, которые являются экземплярами указанного class.
 UIComponent getFacet(java.lang.String name)
          Метод удобства, чтобы возвратить именованный фасет, если это существует, или null иначе.
 int getFacetCount()
          Возвратите число фасета UIComponents, которые связываются с этим UIComponent.
 java.util.Map<java.lang.String,UIComponent> getFacets()
          Возвратите изменчивое Map представление фасета UIComponents связанный с этим UIComponent, включенный фасетным именем (который должен быть Строкой).
 java.util.Iterator<UIComponent> getFacetsAndChildren()
          Возвратитесь Iterator по фасету, сопровождаемому дочерним элементом UIComponents этого UIComponent.
 java.lang.String getId()
          Возвратите компонентный идентификатор этого UIComponent.
 java.util.List<SystemEventListener> getListenersForEventClass(java.lang.Class<? extends SystemEvent> eventClass)
          

Возвратитесь SystemEventListener экземпляры зарегистрировались на этом UIComponent экземпляр, которые интересуются событиями типа eventClass.

 UIComponent getParent()
          Возвратите родителя UIComponent из этого UIComponent, если любой.
protected  Renderer getRenderer(FacesContext context)
          Метод удобства, чтобы возвратиться Renderer экземпляр, связанный с этим компонентом, если любой; иначе, возвратиться null.
 java.lang.String getRendererType()
          Возвратитесь Renderer введите для этого UIComponent (если любой).
 boolean getRendersChildren()
          Возвратите флаг, указывающий, ответственен ли этот компонент за рендеринг его дочерних компонентов.
 ValueBinding getValueBinding(java.lang.String name)
          Осуждаемый. Это было заменено UIComponent.getValueExpression(java.lang.String).
 boolean invokeOnComponent(FacesContext context, java.lang.String clientId, ContextCallback callback)
          Запускаясь в этом компоненте в иерархии Представления, ищите компонент с a clientId равный параметру clientId и, если найдено, вызовите ContextCallback#invokeContextCallback метод на параметре callback, передача тока FacesContext и найденный компонент как параметры.
 boolean isRendered()
          Возвратиться true если этот компонент (и его дочерние элементы) должен быть представлен во время Представлять фазы Ответа жизненного цикла обработки запросов.
 boolean isTransient()
          Если это правда, Объект, реализовывая этот интерфейс не должен участвовать в сохранении состояния или восстановлении.
 void markInitialState()
          

Для каждого из присоединенных объектов на этом экземпляре та реализация PartialStateHolder, вызвать PartialStateHolder#markInitialState на присоединенном объекте.

 void processDecodes(FacesContext context)
          Выполните компонентное дерево обработка необходимого Применять фазой Значений Запроса жизненного цикла обработки запросов для всех фасетов этого компонента, всех дочерних элементов этого компонента, и этого компонента непосредственно, следующим образом.
 void processRestoreState(FacesContext context, java.lang.Object state)
          Выполните компонентное дерево обработка необходимого фазой Представления Восстановления жизненного цикла обработки запросов для всех фасетов этого компонента, всех дочерних элементов этого компонента, и этого компонента непосредственно, следующим образом.
 java.lang.Object processSaveState(FacesContext context)
          Выполните компонентное дерево обработка необходимого частью сохранения состояния Представлять фазы Ответа жизненного цикла обработки запросов для всех фасетов этого компонента, всех дочерних элементов этого компонента, и этого компонента непосредственно, следующим образом.
 void processUpdates(FacesContext context)
          Выполните компонентное дерево обработка необходимого фазой Значений Модели Обновления жизненного цикла обработки запросов для всех фасетов этого компонента, всех дочерних элементов этого компонента, и этого компонента непосредственно, следующим образом.
 void processValidators(FacesContext context)
          Выполните компонентное дерево обработка необходимого фазой Проверок допустимости Процесса жизненного цикла обработки запросов для всех фасетов этого компонента, всех дочерних элементов этого компонента, и этого компонента непосредственно, следующим образом.
 void queueEvent(FacesEvent event)
          Поставьте событие в очередь для широковещательной передачи в конце текущей фазы жизненного цикла обработки запросов.
protected  void removeFacesListener(FacesListener listener)
          Удалите указанное FacesListener от группы слушателей, зарегистрированных, чтобы получить уведомления о событии от этого UIComponent.
static java.lang.Object restoreAttachedState(FacesContext context, java.lang.Object stateObj)
          Этим методом вызывают UIComponent подклассы, которые должны восстановить объекты, они сохранили использование saveAttachedState(javax.faces.context.FacesContext, java.lang.Object).
 void restoreState(FacesContext context, java.lang.Object state)
          Выполните любую обработку, требуемую восстановить состояние от записей в Объекте состояния.
static java.lang.Object saveAttachedState(FacesContext context, java.lang.Object attachedObject)
          

Этим методом вызывают UIComponent подклассы, которые хотят сохранить один или более присоединенные объекты.

 java.lang.Object saveState(FacesContext context)
          Получает состояние экземпляра как a Serializable Объект.
 void setId(java.lang.String id)
          Установите компонентный идентификатор этого UIComponent (если любой).
 void setParent(UIComponent parent)
          

Установите родителя UIComponent из этого UIComponent.

 void setRendered(boolean rendered)
          Установите rendered свойство этого UIComponent.
 void setRendererType(java.lang.String rendererType)
          Установите Renderer введите для этого UIComponent, или null для компонентов, которые представляют себя.
 void setTransient(boolean transientFlag)
          Обозначает, должен ли Объект, реализовывая этот интерфейс или не должен участвовать в сохранении состояния или восстановлении.
 void setValueBinding(java.lang.String name, ValueBinding binding)
          Осуждаемый. Это было заменено UIComponent.setValueExpression(java.lang.String, javax.el.ValueExpression).
 void subscribeToEvent(java.lang.Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener)
          

Установите экземпляр слушателя, на который ссылается параметр componentListener как слушатель для событий типа eventClass возникновение из этого определенного экземпляра UIComponent.

 void unsubscribeFromEvent(java.lang.Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener)
          

Удалите экземпляр слушателя, на который ссылается параметр componentListener как слушатель для событий типа eventClass возникновение из этого определенного экземпляра UIComponent.

 
Методы, наследованные от class javax.faces.component. UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFamily, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
 
Методы, наследованные от class java.lang. Объект
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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

UIComponentBase

public UIComponentBase()
Деталь метода

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
Описание скопировало с class: UIComponent

Возвратите изменчивое Map представляя атрибуты (и свойства, см. ниже), связал wth это UIComponent, включенный названием атрибута (который должен быть Строкой). Возвращенная реализация должна поддерживать все стандартные и дополнительные Map методы, плюс поддержка следующие дополнительные требования:

Определенный:
getAttributes в class UIComponent

getValueBinding

public ValueBinding getValueBinding(java.lang.String name)
Осуждаемый. Это было заменено UIComponent.getValueExpression(java.lang.String).

Вызовите через к UIComponent.getValueExpression(java.lang.String) и исследуйте результат. Если результатом является экземпляр обертки class, переданный под мандат в UIComponent.setValueBinding(java.lang.String, javax.faces.el.ValueBinding), извлеките ValueBinding экземпляр и возврат это. Иначе, оберните результат в реализацию ValueBinding, и возвратите это.

Определенный:
getValueBinding в class UIComponent
Параметры:
name - Имя атрибута или свойства, для которого можно получить a ValueBinding
Броски:
java.lang.NullPointerException - если name null

setValueBinding

public void setValueBinding(java.lang.String name,
                            ValueBinding binding)
Осуждаемый. Это было заменено UIComponent.setValueExpression(java.lang.String, javax.el.ValueExpression).

Оберните параметр binding в реализации ValueExpression и вызовите через к UIComponent.setValueExpression(java.lang.String, javax.el.ValueExpression).

Определенный:
setValueBinding в class UIComponent
Параметры:
name - Имя атрибута или свойства, для которого можно установить a ValueBinding
binding - ValueBinding установить, или null удалить любого в настоящий момент набор ValueBinding
Броски:
IllegalArgumentException - если name один из id или parent
java.lang.NullPointerException - если name null

getClientId

public java.lang.String getClientId(FacesContext context)
Описание скопировало с class: UIComponent

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

Возврат из этого метода не должен быть тем же самым значением всюду по времени жизни экземпляра, если id свойство компонента изменяется, или компонент помещается в a NamingContainer чей клиентский ID изменяется (например, UIData). Однако, даже в этих случаях, последовательные звонки в этот метод должны всегда возвращать то же самое значение. Реализация должна следовать за этими шагами в определении clientId:

Найдите самого близкого предка к этому компоненту в иерархии представления, которая реализует NamingContainer. Вызвать getContainerClientId() на этом и сохраняют результат как parentId локальная переменная. Вызвать UIComponent.getId() на этом компоненте и сохраняют результат как myId локальная переменная. Если myId null, вызвать context.getViewRoot().createUniqueId() и присвойте результат myId. Если parentId не -null, позволить myId равный parentId + UINamingContainer#getSeparatorChar + myId. Вызвать Renderer#convertClientId, передача myId, и возвратите результат.

Определенный:
getClientId в class UIComponent
Параметры:
context - FacesContext для текущего запроса
Броски:
java.lang.NullPointerException - если context null

getId

public java.lang.String getId()
Описание скопировало с class: UIComponent

Возвратите компонентный идентификатор этого UIComponent.

Определенный:
getId в class UIComponent

setId

public void setId(java.lang.String id)
Описание скопировало с class: UIComponent

Установите компонентный идентификатор этого UIComponent (если любой). Компонентные идентификаторы должны повиноваться следующим ограничениям синтаксиса:

Компонентные идентификаторы должны также повиноваться, следующие семантические ограничения (отметьте, что это ограничение НЕ осуществляется setId() реализация):

Определенный:
setId в class UIComponent
Параметры:
id - Новый компонентный идентификатор, или null указать что это UIComponent не имеет компонентного идентификатора
Броски:
IllegalArgumentException - если id не синтаксически допустимо
IllegalStateException

getParent

public UIComponent getParent()
Описание скопировало с class: UIComponent

Возвратите родителя UIComponent из этого UIComponent, если любой. Компонент должен позволить дочерним компонентам быть добавленными к и удаленными из списка дочерних элементов этого компонента, даже при том, что дочерний компонент возвращает нуль из getParent( ).

Определенный:
getParent в class UIComponent

setParent

public void setParent(UIComponent parent)
Описание скопировало с class: UIComponent

Установите родителя UIComponent из этого UIComponent. Если parent.isInView() возвраты true, вызов этого метода сначала вызовет a PreRemoveFromViewEvent быть опубликованным, для этого узла, и затем дочерних элементов этого узла. Затем, как только перепорождение произошло, a PostAddToViewEvent будет опубликован также, сначала для этого узла, и затем для дочерних элементов узла, но только если любое из следующих условий является истиной.

Этот метод никогда не должны вызывать разработчики; a UIComponent's внутренняя реализация вызовет это, поскольку компоненты добавляются к или удаляются от дочернего элемента родителя List или фасет Map.

Определенный:
setParent в class UIComponent
Параметры:
parent - Новый родитель, или null для корневого узла компонентного дерева

isRendered

public boolean isRendered()
Описание скопировало с class: UIComponent

Возвратиться true если этот компонент (и его дочерние элементы) должен быть представлен во время Представлять фазы Ответа жизненного цикла обработки запросов.

Определенный:
isRendered в class UIComponent

setRendered

public void setRendered(boolean rendered)
Описание скопировало с class: UIComponent

Установите rendered свойство этого UIComponent.

Определенный:
setRendered в class UIComponent
Параметры:
rendered - Если true представьте этот компонент; иначе, не представляйте этот компонент

getRendererType

public java.lang.String getRendererType()
Описание скопировало с class: UIComponent

Возвратитесь Renderer введите для этого UIComponent (если любой).

Определенный:
getRendererType в class UIComponent

setRendererType

public void setRendererType(java.lang.String rendererType)
Описание скопировало с class: UIComponent

Установите Renderer введите для этого UIComponent, или null для компонентов, которые представляют себя.

Определенный:
setRendererType в class UIComponent
Параметры:
rendererType - Логический идентификатор типа Renderer использовать, или null для компонентов, которые представляют себя

getRendersChildren

public boolean getRendersChildren()
Описание скопировало с class: UIComponent

Возвратите флаг, указывающий, ответственен ли этот компонент за рендеринг его дочерних компонентов. Реализация по умолчанию в UIComponentBase#getRendersChildren попытки найти средство рендеринга для этого компонента. Если это делает, это вызывает Renderer#getRendersChildren и возвращает результат. Если это не делает, это возвращает false. С версии 1.2 Спецификации Поверхностей JavaServer компонентные авторы поощряются возвратиться true от этого метода и полагаются UIComponentBase#encodeChildren.

Определенный:
getRendersChildren в class UIComponent

getChildren

public java.util.List<UIComponent> getChildren()
Описание скопировало с class: UIComponent

Возвратите изменчивое List представление дочернего элемента UIComponents связанный с этим компонентом. Возвращенная реализация должна поддерживать все стандартные и дополнительные List методы, плюс поддержка следующие дополнительные требования:

Определенный:
getChildren в class UIComponent

getChildCount

public int getChildCount()
Описание скопировало с class: UIComponent

Возвратите число дочернего элемента UIComponents, которые связываются с этим UIComponent. Если нет никаких дочерних элементов, этот метод должен возвратиться 0. Метод не должен вызвать создание дочернего компонентного списка.

Определенный:
getChildCount в class UIComponent

findComponent

public UIComponent findComponent(java.lang.String expr)
Описание скопировало с class: UIComponent

Ищите и возвратитесь UIComponent с id это соответствует указанное выражение поиска (если любой) согласно алгоритму, описанному ниже.

Для метода, чтобы найти компонент, данный простое clientId, см. UIComponent.invokeOnComponent(javax.faces.context.FacesContext, java.lang.String, javax.faces.component.ContextCallback).

Компонентные идентификаторы обязаны быть уникальными в рамках самого близкого предка NamingContainer это включает этот компонент (который мог бы быть этим компонентом непосредственно). Если есть нет NamingContainer компоненты в родословной этого компонента, корневой компонент в дереве обрабатывается, как будто это был a NamingContainer, реализует ли его class фактически NamingContainer интерфейс.

Выражение поиска состоит из любого идентификатор (который является соответствующим точно против id свойство a UIComponent, или серия таких идентификаторов, соединенных UINamingContainer#getSeparatorChar символьное значение. Алгоритм поиска должен работать следующим образом, хотя альтернатива alogrithms может использоваться, пока конечный результат является тем же самым:

Определенный:
findComponent в class UIComponent
Параметры:
expr - Выражение поиска, идентифицирующее UIComponent быть возвращенным
Возвраты:
найденный UIComponent, или null если компонент не был найден.
Броски:
java.lang.NullPointerException - если expr null

invokeOnComponent

public boolean invokeOnComponent(FacesContext context,
                                 java.lang.String clientId,
                                 ContextCallback callback)
                          throws FacesException

Запускаясь в этом компоненте в иерархии Представления, ищите компонент с a clientId равный параметру clientId и, если найдено, вызовите ContextCallback#invokeContextCallback метод на параметре callback, передача тока FacesContext и найденный компонент как параметры. Этот метод подобен UIComponent.findComponent(java.lang.String) но это не поддерживает продвижение UINamingContainer#getSeparatorChar синтаксис для того, чтобы искать от корня Представления.

Реализация по умолчанию сначала проверит если this.getClientId() равно параметру clientId. Если так, сначала вызовите UIComponent.pushComponentToEL(javax.faces.context.FacesContext, javax.faces.component.UIComponent), тогда вызовите ContextCallback#invokeContextCallback метод на обратном вызове параметра, проходя FacesContext параметр и передающий это как компонентный параметр. Затем вызовите UIComponent.popComponentFromEL(javax.faces.context.FacesContext). Если Exception бросается обратным вызовом, оберните его в a FacesException и повторно бросьте это. Иначе, возвратиться true.

Иначе, для каждого компонента, возвращенного UIComponent.getFacetsAndChildren(), вызвать invokeOnComponent() передача параметров этому методу, в порядке. В первый раз invokeOnComponent() возвращает true, прервите пересекающую остальную часть Iterator и возвратитесь true.

Вызывая ContextCallback#invokeContextCallback реализация этого метода должна гарантировать, что состояние компонента, который передают к обратному вызову правильно, отражает позицию компонента в иерархии Представления относительно любого состояния, найденного в параметре clientId. Например, компонент итерации такой как UIData должен будет установить его строку, индексируют, чтобы правильно отразить параметр clientId прежде, чем найти соответствующий дочерний компонент отступало корректной строкой. Когда обратный вызов возвращается, или обычно или бросая Exception реализация этого метода должна восстановить состояние представления к способу, которым это прежде вызывало обратный вызов.

Если ни один из элементов от UIComponent.getFacetsAndChildren() возвращенный true от invokeOnComponent(), возвратиться false.

Простой пример использования, чтобы найти компонент clientId.


private UIComponent found = null;

private void doFind(FacesContext context, String clientId) {
  context.getViewRoot().invokeOnComponent(context, clientId,
      new ContextCallback() {
         public void invokeContextCallback(FacesContext context,
                                       UIComponent component) {
           found = component;
         }
      });
}
 

Переопределения:
invokeOnComponent в class UIComponent
Параметры:
context - FacesContext для текущего запроса
clientId - клиентский идентификатор компонента, который передадут к обратному вызову параметра.
callback - реализация интерфейса Обратного вызова.
Возвраты:
true если компонент с данным clientId находится, метод обратного вызова был успешно вызван, передавая тот компонент как параметр, и никакое Исключение не было выдано. Возвраты false если никакой компонент с данным clientId находится.
Броски:
java.lang.NullPointerException - если каким-либо из параметров является нуль
FacesException - если Обратный вызов параметра выдает Исключение, он обертывается в a FacesException и повторно брошенный.
С тех пор:
1.2

getFacets

public java.util.Map<java.lang.String,UIComponent> getFacets()
Описание скопировало с class: UIComponent

Возвратите изменчивое Map представление фасета UIComponents связанный с этим UIComponent, включенный фасетным именем (который должен быть Строкой). Возвращенная реализация должна поддерживать все стандартные и дополнительные Map методы, плюс поддержка следующие дополнительные требования:

Определенный:
getFacets в class UIComponent

getFacetCount

public int getFacetCount()
Описание скопировало с class: UIComponent

Возвратите число фасета UIComponents, которые связываются с этим UIComponent. Если нет никаких фасетов, этот метод должен возвратиться 0. Метод не должен вызвать создание фасетной компонентной карты.

Для назад compatability с классами, которые расширяют UIComponent непосредственно, реализация по умолчанию - то, при условии, что просто вызывает UIComponent.getFacets() и затем вызовы size() метод на возвращенном Map. В более оптимизированной версии этого метода обеспечивают UIComponentBase#getFacetCount.

Переопределения:
getFacetCount в class UIComponent

getFacet

public UIComponent getFacet(java.lang.String name)
Описание скопировало с class: UIComponent

Метод удобства, чтобы возвратить именованный фасет, если это существует, или null иначе. Если требуемый фасет не существует, Карта фасетов не должна быть создана.

Определенный:
getFacet в class UIComponent
Параметры:
name - Имя требуемого фасета

getFacetsAndChildren

public java.util.Iterator<UIComponent> getFacetsAndChildren()
Описание скопировало с class: UIComponent

Возвратитесь Iterator по фасету, сопровождаемому дочерним элементом UIComponents этого UIComponent. Фасеты возвращаются в неопределенном порядке, сопровождаемом всеми дочерними элементами в порядке, они сохранены в дочернем списке. Если у этого компонента нет никаких фасетов или дочерних элементов, пустого Iterator возвращается.

Возвращенный Iterator не должен поддерживать remove() работа.

Определенный:
getFacetsAndChildren в class UIComponent

широковещательная передача

public void broadcast(FacesEvent event)
               throws AbortProcessingException
Описание скопировало с class: UIComponent

Широковещательно передайте указанное FacesEvent всем зарегистрированным слушателям события, которые выразили интерес к событиям этого типа. Слушателей вызывают в порядке, в котором они были добавлены.

Если event экземпляр BehaviorEvent и ток component источник event вызвать BehaviorEvent.getBehavior() добраться Behavior для события. Вызвать Behavior.broadcast(javax.faces.event.BehaviorEvent) на Behavior экземпляр.

Определенный:
broadcast в class UIComponent
Параметры:
event - FacesEvent быть широковещательно переданным
Броски:
AbortProcessingException - Сигнализируйте реализацию Поверхностей JavaServer, что никакая дальнейшая обработка на текущем событии не должна быть выполнена
IllegalStateException
java.lang.NullPointerException - если event null

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

public void decode(FacesContext context)
Описание скопировало с class: UIComponent

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

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

Определенный:
decode в class UIComponent
Параметры:
context - FacesContext для запроса мы обрабатываем
Броски:
java.lang.NullPointerException - если context null

encodeBegin

public void encodeBegin(FacesContext context)
                 throws java.io.IOException
Описание скопировало с class: UIComponent

Если наш rendered свойство true, представьте начало текущего состояния этого UIComponent к ответу, содержавшемуся в указанном FacesContext. Вызвать UIComponent.pushComponentToEL(javax.faces.context.FacesContext,javax.faces.component.UIComponent). Вызвать Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object), передача PreRenderComponentEvent.class как первый параметр и компонентный экземпляр, который будет представлен как второй параметр.

Если a Renderer связывается с этим UIComponent, фактическое кодирование будет делегировано к Renderer#encodeBegin(FacesContext, UIComponent).

Если наш rendered свойство false, вызвать UIComponent.pushComponentToEL(javax.faces.context.FacesContext,javax.faces.component.UIComponent) и возвратитесь сразу.

Определенный:
encodeBegin в class UIComponent
Параметры:
context - FacesContext для ответа мы создаем
Броски:
java.lang.NullPointerException - если context null
java.io.IOException - если ввод/ошибка на выходе происходит, представляя

encodeChildren

public void encodeChildren(FacesContext context)
                    throws java.io.IOException
Описание скопировало с class: UIComponent

Если наш rendered свойство true, представьте дочерний элемент UIComponents этого UIComponent. Этот метод только вызовут если rendersChildren свойство true.

Если a Renderer связывается с этим UIComponent, фактическое кодирование будет делегировано к Renderer#encodeChildren(FacesContext, UIComponent). Если нет Renderer связывается с этим UIComponent, выполните итерации по каждому из дочерних элементов этого компонента и вызова UIComponent.encodeAll(javax.faces.context.FacesContext).

Определенный:
encodeChildren в class UIComponent
Параметры:
context - FacesContext для ответа мы создаем
Броски:
java.lang.NullPointerException - если context null
java.io.IOException - если ввод/ошибка на выходе происходит, представляя

encodeEnd

public void encodeEnd(FacesContext context)
               throws java.io.IOException
Описание скопировало с class: UIComponent

Если наш rendered свойство true, представьте окончание текущего состояния этого UIComponent.

Если a Renderer связывается с этим UIComponent, фактическое кодирование будет делегировано к Renderer#encodeEnd(FacesContext, UIComponent).

Вызвать UIComponent#popComponentFromEL. прежде, чем возвратиться независимо от значения rendered свойство.

Определенный:
encodeEnd в class UIComponent
Параметры:
context - FacesContext для ответа мы создаем
Броски:
java.io.IOException - если ввод/ошибка на выходе происходит, представляя
java.lang.NullPointerException - если context null

addFacesListener

protected void addFacesListener(FacesListener listener)

Добавьте указанное FacesListener к группе слушателей, зарегистрированных, чтобы получить уведомления о событии от этого UIComponent. Это ожидается это UIComponent у классов, действующих как источники событий, будут соответствующие безопасные с точки зрения типов API для того, чтобы зарегистрировать слушателей необходимого типа, и реализация тех регистрационных методов делегирует к этому методу. Например:

 public class FooEvent extends FacesEvent {
   ...
   protected boolean isAppropriateListener(FacesListener listener) {
     return (listener instanceof FooListener);
   }
   protected void processListener(FacesListener listener) {
     ((FooListener) listener).processFoo(this);
   }
   ...
 }
 

public interface FooListener extends FacesListener { public void processFoo(FooEvent event); }

public class FooComponent extends UIComponentBase { ... public void addFooListener(FooListener listener) { addFacesListener(listener); } public void removeFooListener(FooListener listener) { removeFacesListener(listener); } ... }

Определенный:
addFacesListener в class UIComponent
Параметры:
listener - FacesListener быть зарегистрированным
Броски:
java.lang.NullPointerException - если listener null

getFacesListeners

protected FacesListener[] getFacesListeners(java.lang.Class clazz)
Описание скопировало с class: UIComponent

Возвратите массив зарегистрированных FacesListeners, которые являются экземплярами указанного class. Если нет таких зарегистрированных слушателей, массив нулевой длиной возвращается. Возвращенный массив может быть безопасно быть брошенным массиву, со строгим контролем типов к типу элемента clazz.

Определенный:
getFacesListeners в class UIComponent
Параметры:
clazz - Класс, который должен быть реализован a FacesListener для этого, чтобы быть возвращенным
Броски:
IllegalArgumentException - если class не, и не реализует, FacesListener
java.lang.NullPointerException - если clazz null

removeFacesListener

protected void removeFacesListener(FacesListener listener)

Удалите указанное FacesListener от группы слушателей, зарегистрированных, чтобы получить уведомления о событии от этого UIComponent.

Определенный:
removeFacesListener в class UIComponent
Параметры:
listener - FacesListener быть вычеркнутым из списка
Броски:
java.lang.NullPointerException - если listener null

queueEvent

public void queueEvent(FacesEvent event)
Описание скопировало с class: UIComponent

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

Определенный:
queueEvent в class UIComponent
Параметры:
event - FacesEvent быть поставленным в очередь
Броски:
IllegalStateException - если этот компонент не является потомком a UIViewRoot
java.lang.NullPointerException - если event null

subscribeToEvent

public void subscribeToEvent(java.lang.Class<? extends SystemEvent> eventClass,
                             ComponentSystemEventListener componentListener)

Установите экземпляр слушателя, на который ссылается параметр componentListener как слушатель для событий типа eventClass возникновение из этого определенного экземпляра UIComponent. Реализация по умолчанию создает внутреннее SystemEventListener экземпляр, который обертывает параметр componentListener как listener параметр. Этот внутренний class должен вызвать через к параметру componentListener в его реализации SystemEventListener#processEvent и его реализация SystemEventListener#isListenerForSource должен возвратить true если экземпляр class этого UIComponent присваиваемо от параметра до isListenerForSource.

Переопределения:
subscribeToEvent в class UIComponent
Параметры:
eventClass - Class из того, события, для который listener должен быть запущен.
componentListener - реализация ComponentSystemEventListener чей ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent) метод нужно вызвать когда события типа facesEventClass запускаются.
Броски:
NullPointerException - если какой-либо из параметров null.
С тех пор:
2.1

unsubscribeFromEvent

public void unsubscribeFromEvent(java.lang.Class<? extends SystemEvent> eventClass,
                                 ComponentSystemEventListener componentListener)

Удалите экземпляр слушателя, на который ссылается параметр componentListener как слушатель для событий типа eventClass возникновение из этого определенного экземпляра UIComponent. Делая сравнение, чтобы определить, равен ли существующий слушатель параметру componentListener (и таким образом должен быть удален), equals() метод на существующем слушателе должен быть вызван, передавая параметр componentListener, а не наоборот.

Переопределения:
unsubscribeFromEvent в class UIComponent
Параметры:
eventClass - Class из того, события, для который listener должен быть удален.
componentListener - реализация ComponentSystemEventListener чей ComponentSystemEventListener#processEvent метод больше нельзя вызвать когда события типа eventClass запускаются.
Броски:
NullPointerException - если какой-либо из параметров null.
С тех пор:
2.1

getListenersForEventClass

public java.util.List<SystemEventListener> getListenersForEventClass(java.lang.Class<? extends SystemEvent> eventClass)

Возвратитесь SystemEventListener экземпляры зарегистрировались на этом UIComponent экземпляр, которые интересуются событиями типа eventClass.

Определенный:
getListenersForEventClass в интерфейсе SystemEventListenerHolder
Переопределения:
getListenersForEventClass в class UIComponent
Параметры:
eventClass - Class из события, для которого должны быть возвращены слушатели.
Броски:
java.lang.NullPointerException - если параметр eventClass null.
С тех пор:
2.1

processDecodes

public void processDecodes(FacesContext context)
Описание скопировало с class: UIComponent

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

Определенный:
processDecodes в class UIComponent
Параметры:
context - FacesContext для запроса мы обрабатываем
Броски:
java.lang.NullPointerException - если context null

processValidators

public void processValidators(FacesContext context)
Описание скопировало с class: UIComponent

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

Определенный:
processValidators в class UIComponent
Параметры:
context - FacesContext для запроса мы обрабатываем
Броски:
java.lang.NullPointerException - если context null

processUpdates

public void processUpdates(FacesContext context)
Описание скопировало с class: UIComponent

Выполните компонентное дерево обработка необходимого фазой Значений Модели Обновления жизненного цикла обработки запросов для всех фасетов этого компонента, всех дочерних элементов этого компонента, и этого компонента непосредственно, следующим образом.

Определенный:
processUpdates в class UIComponent
Параметры:
context - FacesContext для запроса мы обрабатываем
Броски:
java.lang.NullPointerException - если context null

processSaveState

public java.lang.Object processSaveState(FacesContext context)
Описание скопировало с class: UIComponent

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

Этот метод нельзя вызвать, если метод сохранения состояния устанавливается в сервер.

Определенный:
processSaveState в class UIComponent
Параметры:
context - FacesContext для запроса мы обрабатываем
Броски:
java.lang.NullPointerException - если context null

processRestoreState

public void processRestoreState(FacesContext context,
                                java.lang.Object state)
Описание скопировало с class: UIComponent

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

Этот метод нельзя вызвать, если метод сохранения состояния устанавливается в сервер.

Определенный:
processRestoreState в class UIComponent
Параметры:
context - FacesContext для запроса мы обрабатываем
Броски:
java.lang.NullPointerException - если context null

getFacesContext

protected FacesContext getFacesContext()
Описание скопировало с class: UIComponent

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

Определенный:
getFacesContext в class UIComponent

getRenderer

protected Renderer getRenderer(FacesContext context)
Описание скопировало с class: UIComponent

Метод удобства, чтобы возвратиться Renderer экземпляр, связанный с этим компонентом, если любой; иначе, возвратиться null.

Определенный:
getRenderer в class UIComponent
Параметры:
context - FacesContext для текущего запроса

markInitialState

public void markInitialState()

Для каждого из присоединенных объектов на этом экземпляре та реализация PartialStateHolder, вызвать PartialStateHolder#markInitialState на присоединенном объекте.

Определенный:
markInitialState в интерфейсе PartialStateHolder
Переопределения:
markInitialState в class UIComponent
С тех пор:
2.0

clearInitialState

public void clearInitialState()

Для каждого из присоединенных объектов на этом экземпляре та реализация PartialStateHolder, вызвать PartialStateHolder#clearInitialState на присоединенном объекте.

Определенный:
clearInitialState в интерфейсе PartialStateHolder
Переопределения:
clearInitialState в class UIComponent
С тех пор:
2.0

saveState

public java.lang.Object saveState(FacesContext context)
Описание скопировало с интерфейса: StateHolder

Получает состояние экземпляра как a Serializable Объект.

Если у class, который реализует этот интерфейс, есть ссылки на экземпляры, которые реализуют StateHolder (такой как a UIComponent с обработчиками событий, блоками проверки допустимости, и т.д.), этот метод должен вызвать StateHolder.saveState(javax.faces.context.FacesContext) метод на всех тех экземплярах также. Этот метод не должен сохранить состояние дочерних элементов и фасетов. Это делается через StateManager

Этот метод не должен изменить состояние объекта реализации. Другими словами, после выполнения этого кода:

 Object state = component.saveState(facesContext);
 

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

Возврат из этого метода должен быть Serializable


restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)
Описание скопировало с интерфейса: StateHolder

Выполните любую обработку, требуемую восстановить состояние от записей в Объекте состояния.

Если у class, который реализует этот интерфейс, есть ссылки на экземпляры, которые также реализуют StateHolder (такой как a UIComponent с обработчиками событий, блоками проверки допустимости, и т.д.), этот метод должен вызвать StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) метод на всех тех экземплярах также.

Если state параметр null, не предпримите меры и возврат.


isTransient

public boolean isTransient()
Описание скопировало с интерфейса: StateHolder

Если это правда, Объект, реализовывая этот интерфейс не должен участвовать в сохранении состояния или восстановлении.


setTransient

public void setTransient(boolean transientFlag)
Описание скопировало с интерфейса: StateHolder

Обозначает, должен ли Объект, реализовывая этот интерфейс или не должен участвовать в сохранении состояния или восстановлении.

Параметры:
transientFlag - булева передача true если этот Объект не будет участвовать в сохранении состояния или восстановлении, иначе передайте false.

saveAttachedState

public static java.lang.Object saveAttachedState(FacesContext context,
                                                 java.lang.Object attachedObject)

Этим методом вызывают UIComponent подклассы, которые хотят сохранить один или более присоединенные объекты. Это - метод удобства, который делает работу сохранения присоединенных объектов, которые могут или, возможно, не реализуют StateHolder интерфейс. Используя этот метод подразумевает использование restoreAttachedState(javax.faces.context.FacesContext, java.lang.Object) восстановить присоединенные объекты.

Этот метод поддерживает сохранение присоединенные объекты следующего типа: Objects, null значения, и Collections этих объектов. Если какие-либо содержавшие объекты не Collections и не реализуют StateHolder, у них должны быть конструкторы общественности нулевого параметра. Точная структура возвращенного объекта неопределена и непрозрачна, но будет сериализуема.

Параметры:
context - FacesContext для этого запроса.
attachedObject - объект, который может быть a List экземпляр, или Объект. attachedObject (или элементы, которые включают attachedObject может реализовать StateHolder.
Броски:
java.lang.NullPointerException - если параметром контекста является нуль.

restoreAttachedState

public static java.lang.Object restoreAttachedState(FacesContext context,
                                                    java.lang.Object stateObj)
                                             throws java.lang.IllegalStateException

Этим методом вызывают UIComponent подклассы, которые должны восстановить объекты, они сохранили использование saveAttachedState(javax.faces.context.FacesContext, java.lang.Object). Этот метод сильно связан с saveAttachedState(javax.faces.context.FacesContext, java.lang.Object).

Этот метод поддерживает восстановление всех присоединенных типов объектов, поддерживаемых saveAttachedState(javax.faces.context.FacesContext, java.lang.Object).

Параметры:
context - FacesContext для этого запроса
stateObj - непрозрачный объект, возвращенный из saveAttachedState(javax.faces.context.FacesContext, java.lang.Object)
Броски:
java.lang.NullPointerException - если контекст является нулем.
IllegalStateException - если объект ранее не возвращается saveAttachedState(javax.faces.context.FacesContext, java.lang.Object).

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                              ClientBehavior behavior)

Это - реализация по умолчанию ClientBehaviorHolder.addClientBehavior(java.lang.String, javax.faces.component.behavior.ClientBehavior). UIComponent не реализует ClientBehaviorHolder интерфейс, но обеспечивает реализации по умолчанию для методов, определенных ClientBehaviorHolder упростить реализации подкласса. Подклассы, которые хотят поддерживать ClientBehaviorHolder контракт должен объявить, что подкласс реализует ClientBehaviorHolder, и должен обеспечить реализацию ClientBehaviorHolder.getEventNames().

Параметры:
eventName - логическое имя клиентского события, чтобы присоединить поведение к.
behavior - Behavior экземпляр, чтобы присоединить для указанного имени события.
С тех пор:
2.0

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Это - реализация по умолчанию ClientBehaviorHolder.getEventNames(). UIComponent не реализует ClientBehaviorHolder интерфейс, но обеспечивает реализации по умолчанию для методов, определенных ClientBehaviorHolder упростить реализации подкласса. Подклассы, которые хотят поддерживать ClientBehaviorHolder контракт должен объявить, что подкласс реализует ClientBehaviorHolder, и должен переопределить этот метод, чтобы возвратить непустое Collection из клиентских имен события, которые поддерживает компонент.

С тех пор:
2.0

getClientBehaviors

public java.util.Map<java.lang.String,java.util.List<ClientBehavior>> getClientBehaviors()

Это - реализация по умолчанию ClientBehaviorHolder.getClientBehaviors(). UIComponent не реализует ClientBehaviorHolder интерфейс, но обеспечивает реализации по умолчанию для методов, определенных ClientBehaviorHolder упростить реализации подкласса. Подклассы, которые хотят поддерживать ClientBehaviorHolder контракт должен объявить, что подкласс реализует ClientBehaviorHolder, и должен добавить реализацию ClientBehaviorHolder.getEventNames().

С тех пор:
2.0

getDefaultEventName

public java.lang.String getDefaultEventName()

Это - реализация по умолчанию ClientBehaviorHolder.getDefaultEventName(). UIComponent не реализует ClientBehaviorHolder интерфейс, но обеспечивает реализации по умолчанию для методов, определенных ClientBehaviorHolder упростить реализации подкласса. Подклассы, которые хотят поддерживать ClientBehaviorHolder контракт должен объявить, что подкласс реализует ClientBehaviorHolder, и должен обеспечить реализацию ClientBehaviorHolder.getEventNames().



Представьте ошибку или функцию

Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается срокам действия лицензии.

Сгенерированный на 10-February-2011 12:41

free hit counter