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

javax.faces.component.visit
Класс VisitContext

java.lang.Object
  javax.faces.component.visit.VisitContext

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

VisitContextWrapper

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

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

Компонентные посещения дерева инициируются, вызывая UIComponent#visitTree, в которой точке оба a VisitContext и a VisitCallback должен быть обеспечен.

С тех пор:

2.0

См. Также:

UIComponent.visitTree(), VisitCallback

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

static java.util.Collection<java.lang.String>

ALL_IDS Этот неподдающийся изменению Набор возвращается getIdsToVisit() и getSubtreeIdsToVisit() в случаях, где все идентификаторы нужно посетить.

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

VisitContext()

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

static VisitContext	createVisitContext(FacesContext context) Создает экземпляр VisitContext для использования с UIComponent.visitTree().
static VisitContext	createVisitContext(FacesContext context, java.util.Collection<java.lang.String> ids, java.util.Set<VisitHint> hints) Возвращает экземпляр VisitContext, который инициализируется с указанными идентификаторами и использованием hintsfor с UIComponent#visitTree.
abstract FacesContext	getFacesContext() Возвращает FacesContext для текущего запроса.
abstract java.util.Set<VisitHint>	getHints() Возвраты подсказывают, что влияют на поведение древовидного посещения.
abstract java.util.Collection<java.lang.String>	getIdsToVisit() Возвращает идентификаторы компонентов, чтобы посетить.
abstract java.util.Collection<java.lang.String>	getSubtreeIdsToVisit(UIComponent component) Данный a NamingContainer компонент, возвращает клиентские идентификаторы любых компонентов под NamingContainer, который нужно посетить.
abstract VisitResult	invokeVisitCallback(UIComponent component, VisitCallback callback) Вызванный UIComponent.visitTree() посетить единственный компонент.

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

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

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

ALL_IDS

public static final java.util.Collection<java.lang.String> ALL_IDS

Этот неподдающийся изменению Набор возвращается getIdsToVisit() и getSubtreeIdsToVisit() в случаях, где все идентификаторы нужно посетить.

Упростить логику для visitTree() реализации, этот Набор всегда возвращается false для isEmpty. Весь другой бросок методов UnsupportedOperationException.

С тех пор:

2.0

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

VisitContext

public VisitContext()

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

getFacesContext

public abstract FacesContext getFacesContext()

Возвращает FacesContext для текущего запроса.

С тех пор:

2.0

getIdsToVisit

public abstract java.util.Collection<java.lang.String> getIdsToVisit()

Возвращает идентификаторы компонентов, чтобы посетить.

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

getSubtreeIdsToVisit

public abstract java.util.Collection<java.lang.String> getSubtreeIdsToVisit(UIComponent component)

Данный a NamingContainer компонент, возвращает клиентские идентификаторы любых компонентов под NamingContainer, который нужно посетить.

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

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

Параметры:

component - компонент NamingContainer

Возвраты:

неподдающийся изменению Набор, содержащий клиентские идентификаторы любых компонентов под NamingContainer, которые, как известно, являются целями древовидного посещения. Если никакие такие компоненты не существуют, возвращает пустой Набор. Если все компоненты под NamingContainer нужно посетить, возвраты VisitContext.ALL_IDS набор.

Броски:

IllegalArgumentException - если component не экземпляр NamingContainer

invokeVisitCallback

public abstract VisitResult invokeVisitCallback(UIComponent component,
                                                VisitCallback callback)

Вызванный UIComponent.visitTree() посетить единственный компонент.

Параметры:

component - компонент, чтобы посетить

callback - VisitCallback, чтобы вызвать

Возвраты:

значение VisitResult, которое указывает, продолжать ли посещать поддерево компонента, пропустите посещение поддерева компонента или прервите посещение в целом.

getHints

public abstract java.util.Set<VisitHint> getHints()

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

Заинтересованные стороны, такой как UIComponent.visitTree() реализации, может проверить, чтобы видеть, присутствует ли определенная подсказка, вызывая VisitContext.getHints().contains(), передача в одной из подсказок, определенных VisitHint.

Возвраты:

непустой, неподдающийся изменению набор VisitHints

createVisitContext

public static VisitContext createVisitContext(FacesContext context,
                                              java.util.Collection<java.lang.String> ids,
                                              java.util.Set<VisitHint> hints)

Возвращает экземпляр VisitContext, который инициализируется с указанными идентификаторами и использованием hintsfor с UIComponent#visitTree.

Параметры:

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

ids - клиентские идентификаторы компонентов, чтобы посетить. Если ноль, все компоненты посетят.

hints - VisitHints, чтобы примениться к посещению. Если null, никакие подсказки не применяются.

Возвраты:

экземпляр VisitContext, который инициализируется с указанными идентификаторами и подсказками.

createVisitContext

public static VisitContext createVisitContext(FacesContext context)

Создает экземпляр VisitContext для использования с UIComponent.visitTree(). Этот метод может использоваться, чтобы получить экземпляр VisitContext, когда все компоненты нужно посетить с подсказками посещения значения по умолчанию.

Параметры:

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

Возвраты:

экземпляр VisitContext