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

javax.faces.component
Класс UIForm

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

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

java.util. EventListener, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

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

HtmlForm

public class UIForm
расширяет UIComponentBase
реализации NamingContainer, UniqueIdVendor

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

По умолчанию, rendererType свойство должно быть установлено в"javax.faces.Form". Это значение может быть изменено, вызывая 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

Поля, наследованные от интерфейса javax.faces.component. NamingContainer

SEPARATOR_CHAR

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

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

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

java.lang.String	createUniqueId(FacesContext context, java.lang.String seed) Генерируйте идентификатор для компонента.
java.lang.String	getContainerClientId(FacesContext context) Переопределите UIComponent#getContainerClientId позволить пользователям отключать эту форму от предварительного ожидания clientId к его потомку clientIds в зависимости от значения этой формы isPrependId() свойство.
java.lang.String	getFamily() Возвратите идентификатор компонентного семейства, которому принадлежит этот компонент.
boolean	isPrependId() Флаг prependId.
boolean	isSubmitted() Возвращает текущую стоимость submitted свойство.
void	processDecodes(FacesContext context) Переопределение UIComponent#processDecodes гарантировать, что форма декодируется перед ее дочерними элементами.
void	processUpdates(FacesContext context) Переопределение UIComponent#processUpdates гарантировать что дочерние элементы этого UIForm экземпляр только обрабатывается если isSubmitted() возвраты true.
void	processValidators(FacesContext context) Переопределение UIComponent#processValidators гарантировать что дочерние элементы этого UIForm экземпляр только обрабатывается если isSubmitted() возвраты true.
void	setPrependId(boolean prependId)
void	setSubmitted(boolean submitted) Если это UIForm экземпляр (в противоположность другим формам в странице) испытывает представление во время этого жизненного цикла обработки запросов, этот метод нужно вызвать, с true как параметр, во время UIComponent#decode для этого UIForm экземпляр.
boolean	visitTree(VisitContext context, VisitCallback callback) Выполните древовидное посещение, запускающееся в этом узле в дереве.

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

addClientBehavior, addFacesListener, broadcast, 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, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

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

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

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

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

См. Также:

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

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

UIForm

public UIForm()

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

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

getFamily

public java.lang.String getFamily()

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

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

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

getFamily в class UIComponent

isSubmitted

public boolean isSubmitted()

Возвращает текущую стоимость submitted свойство. Значение по умолчанию false. См. setSubmitted(boolean) для деталей.

Это свойство должно быть сохранено как переходное свойство, используя UIComponent#getTransientStateHelper.

setSubmitted

public void setSubmitted(boolean submitted)

Если это UIForm экземпляр (в противоположность другим формам в странице) испытывает представление во время этого жизненного цикла обработки запросов, этот метод нужно вызвать, с true как параметр, во время UIComponent#decode для этого UIForm экземпляр. Если это UIForm экземпляр не испытывает представление, этот метод нужно вызвать, с false как параметр, во время UIComponent#decode для этого UIForm экземпляр.

Значение a UIForm's представленное свойство не должен быть сохранен как часть его состояния.

Это свойство должно быть сохранено как переходное свойство, используя UIComponent#getTransientStateHelper.

isPrependId

public boolean isPrependId()

Флаг prependId.

setPrependId

public void setPrependId(boolean prependId)

processDecodes

public void processDecodes(FacesContext context)

Переопределение UIComponent#processDecodes гарантировать, что форма декодируется перед ее дочерними элементами. Это необходимо, чтобы позволить submitted свойство, которое будет правильно установлено.

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

processDecodes в class UIComponentBase

Параметры:

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

Броски:

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

processValidators

public void processValidators(FacesContext context)

Переопределение UIComponent#processValidators гарантировать что дочерние элементы этого UIForm экземпляр только обрабатывается если isSubmitted() возвраты true.

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

processValidators в class UIComponentBase

Параметры:

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

Броски:

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

processUpdates

public void processUpdates(FacesContext context)

Переопределение UIComponent#processUpdates гарантировать что дочерние элементы этого UIForm экземпляр только обрабатывается если isSubmitted() возвраты true.

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

processUpdates в class UIComponentBase

Параметры:

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

Броски:

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

createUniqueId

public java.lang.String createUniqueId(FacesContext context,
                                       java.lang.String seed)

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

Генерируйте идентификатор для компонента. Идентификатор будет снабжен префиксом UNIQUE_ID_PREFIX, и будет уникален в пределах этого компонентного контейнера. Дополнительно, уникальное значение семени может быть предоставлено компонентными создателями, которые должны быть включены в сгенерированный уникальный идентификатор.

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

createUniqueId в интерфейсе UniqueIdVendor

Параметры:

context - FacesContext

seed - дополнительное значение семени - например, основанный на позиции компонента в VDL-шаблоне

Возвраты:

уникальный идентификатор в этом компонентном контейнере

getContainerClientId

public java.lang.String getContainerClientId(FacesContext context)

Переопределите UIComponent#getContainerClientId позволить пользователям отключать эту форму от предварительного ожидания clientId к его потомку clientIds в зависимости от значения этой формы isPrependId() свойство.

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

getContainerClientId в class UIComponent

visitTree

public boolean visitTree(VisitContext context,
                         VisitCallback callback)

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

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

UIComponent.visitTree () реализации не вызывают VisitCallback непосредственно, но вместо этого вызовите VisitContext#invokeVisitCallback вызвать обратный вызов. Это позволяет VisitContext реализации, чтобы обеспечить оптимизированные обходы дерева, например только вызывая VisitCallback для подмножества компонентов.

UIComponent.visitTree () реализации должен вызвать UIComponent.pushComponentToEL () прежде, чем выполнить посещение и UIComponent.popComponentFromEL () после посещения.

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

visitTree в class UIComponent

Параметры:

context - VisitContext для этого посещения

callback - VisitCallback экземпляр, чей visit метод вызовут для каждого узла, который посещают.

Возвраты:

компонентные реализации могут возвратиться true указать, что древовидное посещение полно (eg. все компоненты, которые нужно посетить, были посещены). Это приводит к древовидному посещению, закорачиваемому так, что, больше компонентов не посещают.

См. Также:

UIComponent#visitTree