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

javax.faces.component
Класс UICommand

java.lang.Object
  javax.faces.component. UIComponent
      javax.faces.component. UIComponentBase
          javax.faces.component.UICommand

Все Реализованные Интерфейсы:

java.util. EventListener, ActionSource, ActionSource2, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

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

HtmlCommandButton, HtmlCommandLink

public class UICommand
расширяет UIComponentBase
реализации ActionSource2

UICommand является a UIComponent это представляет компонент пользовательского интерфейса, который, когда активировано пользователем, инициировал специализированную "команду" или "действие". Такой компонент обычно представляется как кнопка, пункт меню, или гиперссылка.

Когда decode() метод этого UICommand, или его соответствие Renderer, обнаруживает, что это управление было активировано, оно поставит в очередь ActionEvent. Позже, broadcast() метод гарантирует, что это событие широковещательно передается всем заинтересованным слушателям.

Слушатели будут вызваны в следующем порядке:

1. ActionListeners, в порядке, в котором они были зарегистрированы.
2. "actionListener" MethodExpression (который покроет "actionListener", который был установлен как a MethodBinding).
3. Значение по умолчанию ActionListener, полученный от Application - и поэтому, любое присоединенное "действие" MethodExpression.

По умолчанию, rendererType свойство должно быть установлено в"javax.faces.Button". Это значение может быть изменено, вызывая setRendererType() метод.

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

static java.lang.String	COMPONENT_FAMILY Стандартное компонентное семейство для этого компонента.
static java.lang.String	COMPONENT_TYPE Стандартный компонент вводит для этого компонента.

Поля, наследованные от 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

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

UICommand()
Создайте новое UICommand экземпляр со значениями свойств значения по умолчанию.

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

void	addActionListener(ActionListener listener) Добавьте новое ActionListener к группе слушателей, заинтересованных тем, чтобы быть уведомленным, когда ActionEvents происходят.
void	broadcast(FacesEvent event) В дополнение к к значению по умолчанию UIComponent#broadcast обрабатывая, передайте ActionEvent будучи широковещательно переданным к методу, на который ссылаются actionListener (если любой), и к значению по умолчанию ActionListener зарегистрированный на Application.
MethodBinding	getAction() Осуждаемый. Это было заменено getActionExpression().
MethodExpression	getActionExpression() Возвратитесь MethodExpression указание на действие приложения, которое будет вызвано, если это UIComponent активируется пользователем, во время Применять Значений Запроса, или Вызовите фазу Приложения жизненного цикла обработки запросов, в зависимости от значения immediate свойство.
MethodBinding	getActionListener() Осуждаемый. Использовать getActionListeners() вместо этого.
ActionListener[]	getActionListeners() Возвратите набор зарегистрированных ActionListeners для этого ActionSource экземпляр.
java.lang.String	getFamily() Возвратите идентификатор компонентного семейства, которому принадлежит этот компонент.
java.lang.Object	getValue() Возвраты value свойство UICommand.
boolean	isImmediate() Непосредственный флаг.
void	queueEvent(FacesEvent e) Прерывание queueEvent и предпримите следующие меры.
void	removeActionListener(ActionListener listener) Удалите существующее ActionListener (если любой) от группы слушателей, заинтересованных тем, чтобы быть уведомленным, когда ActionEvents происходят.
void	setAction(MethodBinding action) Осуждаемый. Это было заменено setActionExpression(javax.el.MethodExpression).
void	setActionExpression(MethodExpression actionExpression) Установите MethodExpression указание на appication действие, которое будет вызвано, если это UIComponent активируется пользователем, во время Применять Значений Запроса, или Вызовите фазу Приложения жизненного цикла обработки запросов, в зависимости от значения immediate свойство.
void	setActionListener(MethodBinding actionListener) Осуждаемый. Это было заменено addActionListener(javax.faces.event.ActionListener).
void	setImmediate(boolean immediate) Установите "непосредственное выполнение" флаг для этого UIComponent.
void	setValue(java.lang.Object value) Наборы value свойство UICommand.

Методы, наследованные от class javax.faces.component. UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Методы, наследованные от class javax.faces.component. UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, 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

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

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

Стандартный компонент вводит для этого компонента.

См. Также:

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

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

Стандартное компонентное семейство для этого компонента.

См. Также:

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

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

UICommand

public UICommand()

Создайте новое UICommand экземпляр со значениями свойств значения по умолчанию.

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

getFamily

public java.lang.String getFamily()

Описание скопировало с class: UIComponent

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

Определенный:

getFamily в class UIComponent

getAction

public MethodBinding getAction()

Осуждаемый. Это было заменено getActionExpression().

Если реализация class также реализует ActionSource2, реализация этого метода должна вызвать через к ActionSource2#getActionExpression и исследуйте результат. Если результат прибыл из предыдущего звонка ActionSource.setAction(javax.faces.el.MethodBinding), извлеките MethodBinding от этого и возврат это. Иначе, оберните возвращенный MethodExpression в a MethodBinding реализация, и возврат это.

Если реализация class не реализует ActionSource2, возвратитесь MethodBindingуказание на действие приложения, которое будет вызвано, если это UIComponent активируется пользователем, во время Применять Значений Запроса, или Вызовите фазу Приложения жизненного цикла обработки запросов, в зависимости от значения immediate свойство.

Определенный:

getAction в интерфейсе ActionSource

setAction

public void setAction(MethodBinding action)

Осуждаемый. Это было заменено setActionExpression(javax.el.MethodExpression).

Если реализация class также реализует ActionSource2, реализация этого метода должна обернуть параметр action в class, который реализует MethodExpression и вызовите через к ActionSource2#setActionExpression, передача обернутого action.

Если реализация class не реализует ActionSource2, установите MethodBinding указание на appication действие, которое будет вызвано, если это UIComponent активируется пользователем, во время Применять Значений Запроса, или Вызовите фазу Приложения жизненного цикла обработки запросов, в зависимости от значения immediate свойство.

Любой метод, на который ссылается такое выражение, должен быть общедоступным с типом возврата String, и не примите параметры.

Определенный:

setAction в интерфейсе ActionSource

Параметры:

action - Новое выражение MethodBinding

getActionListener

public MethodBinding getActionListener()

Осуждаемый. Использовать getActionListeners() вместо этого.

Если ActionSource.setActionListener(javax.faces.el.MethodBinding) ранее не требовался этот экземпляр, этот метод должен возвратиться null. Если бы это вызвали, то этот метод должен возвратить точное MethodBinding экземпляр, к которому передали ActionSource.setActionListener(javax.faces.el.MethodBinding).

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

Определенный:

getActionListener в интерфейсе ActionSource

setActionListener

public void setActionListener(MethodBinding actionListener)

Осуждаемый. Это было заменено addActionListener(javax.faces.event.ActionListener).

Оберните параметр actionListener в реализации ActionListener и сохраните это во внутренней структуре данных, которую это поддерживает ActionSource.getActionListeners() метод, заботясь, чтобы перезаписать любой экземпляр, который был сохранен предыдущим звонком setActionListener.

Любой метод, на который ссылается такое выражение, должен быть общедоступным с типом возврата void, и примите единственный параметр типа ActionEvent.

Определенный:

setActionListener в интерфейсе ActionSource

Параметры:

actionListener - Новый метод обязательное выражение

isImmediate

public boolean isImmediate()

Непосредственный флаг.

Определенный:

isImmediate в интерфейсе ActionSource

setImmediate

public void setImmediate(boolean immediate)

Описание скопировало с интерфейса: ActionSource

Установите "непосредственное выполнение" флаг для этого UIComponent.

Определенный:

setImmediate в интерфейсе ActionSource

Параметры:

immediate - Новый непосредственный флаг выполнения

getValue

public java.lang.Object getValue()

Возвраты value свойство UICommand. Это чаще всего представляется как метка.

setValue

public void setValue(java.lang.Object value)

Наборы value свойство UICommand. Это чаще всего представляется как метка.

Параметры:

value - новое значение

getActionExpression

public MethodExpression getActionExpression()

Описание скопировало с интерфейса: ActionSource2

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

Отметьте, что возможно что возвращенный MethodExpression только обертка вокруг a MethodBinding экземпляр whith был установлен звонком ActionSource#setAction. Это позволяет значению по умолчанию ActionListener продолжать работать должным образом с более старыми компонентами.

Определенный:

getActionExpression в интерфейсе ActionSource2

setActionExpression

public void setActionExpression(MethodExpression actionExpression)

Описание скопировало с интерфейса: ActionSource2

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

Любой метод, на который ссылается такое выражение, должен быть общедоступным с типом возврата String, и не примите параметры.

Определенный:

setActionExpression в интерфейсе ActionSource2

Параметры:

actionExpression - Новое выражение метода

addActionListener

public void addActionListener(ActionListener listener)

Описание скопировало с интерфейса: ActionSource

Добавьте новое ActionListener к группе слушателей, заинтересованных тем, чтобы быть уведомленным, когда ActionEvents происходят.

Определенный:

addActionListener в интерфейсе ActionSource

Параметры:

listener - ActionListener быть добавленным

Броски:

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

getActionListeners

public ActionListener[] getActionListeners()

Описание скопировало с интерфейса: ActionSource

Возвратите набор зарегистрированных ActionListeners для этого ActionSource экземпляр. Если нет никаких зарегистрированных слушателей, массив нулевой длиной возвращается.

Определенный:

getActionListeners в интерфейсе ActionSource

removeActionListener

public void removeActionListener(ActionListener listener)

Описание скопировало с интерфейса: ActionSource

Удалите существующее ActionListener (если любой) от группы слушателей, заинтересованных тем, чтобы быть уведомленным, когда ActionEvents происходят.

Определенный:

removeActionListener в интерфейсе ActionSource

Параметры:

listener - ActionListener быть удаленным

Броски:

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

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

public void broadcast(FacesEvent event)
               throws AbortProcessingException

В дополнение к к значению по умолчанию UIComponent#broadcast обрабатывая, передайте ActionEvent будучи широковещательно переданным к методу, на который ссылаются actionListener (если любой), и к значению по умолчанию ActionListener зарегистрированный на Application.

Переопределения:

broadcast в class UIComponentBase

Параметры:

event - FacesEvent быть широковещательно переданным

Броски:

AbortProcessingException - Сигнализируйте реализацию Поверхностей JavaServer, что никакая дальнейшая обработка на текущем событии не должна быть выполнена

IllegalArgumentException - если реализация class этого FacesEvent не поддерживается этим компонентом

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

queueEvent

public void queueEvent(FacesEvent e)

Прерывание queueEvent и предпримите следующие меры. Если событие ActionEvent, получите UIComponent экземпляр от события. Если компонент ActionSource получите значение его "непосредственного" свойства. Если это - истина, отметьте phaseId для события, чтобы быть PhaseId.APPLY_REQUEST_VALUES иначе, отметьте phaseId, чтобы быть PhaseId.INVOKE_APPLICATION. Событие должно быть передано super.queueEvent() прежде, чем возвратиться из этого метода.

Переопределения:

queueEvent в class UIComponentBase

Параметры:

e - FacesEvent быть поставленным в очередь