public class UIForm extends UIComponentBase implements NamingContainer, UniqueIdVendor
UIForm は、ユーザーに提示される入力フォームを表す UIComponent であり、その子コンポーネントは（とりわけ）フォームの送信時に含まれる入力フィールドを表します。
デフォルトでは、rendererType プロパティを "jakarta.faces.Form" に設定する必要があります。この値は、setRendererType() メソッドを呼び出すことで変更できます。
| 修飾子と型 | フィールドと説明 |
|---|---|
static StringSE | COMPONENT_FAMILY このコンポーネントの標準コンポーネントファミリ。 |
static StringSE | COMPONENT_TYPE このコンポーネントの標準コンポーネント型。 |
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_KEYSEPARATOR_CHAR| 修飾子と型 | メソッドと説明 |
|---|---|
StringSE | createUniqueId(FacesContext context, StringSE seed)コンポーネントの識別子を生成します。 |
StringSE | getContainerClientId(FacesContext context)UIComponent.getContainerClientId(jakarta.faces.context.FacesContext) をオーバーライドして、このフォームの isPrependId() プロパティの値に応じて、ユーザーがこのフォームを無効にして、clientId をその子孫の clientIds の前に付加できないようにします。 |
StringSE | getFamily()このコンポーネントが属するコンポーネントファミリの識別子を返します。 |
boolean | isPrependId() 先頭に ID が付いています。 |
boolean | isSubmitted()submitted プロパティの現在の値を返します。 |
void | processDecodes(FacesContext context)UIComponent.processDecodes(jakarta.faces.context.FacesContext) をオーバーライドして、フォームがその子より先にデコードされるようにします。 |
void | processUpdates(FacesContext context)UIComponent.processUpdates(jakarta.faces.context.FacesContext) をオーバーライドして、この UIForm インスタンスの子が isSubmitted() が true を返す場合にのみ処理されるようにします。 |
void | processValidators(FacesContext context)
|
void | setPrependId(boolean prependId) |
void | setSubmitted(boolean submitted)（ページ内の他の形ではなく） この UIForm インスタンスがこのリクエスト処理ライフサイクル中に提出発生している場合、このメソッドは、この UIForm インスタンスの UIComponent.decode(jakarta.faces.context.FacesContext) 時に、引数として true で、呼び出されなければなりません。 |
boolean | visitTree(VisitContext context, VisitCallback callback)ツリー内のこのノードからツリー訪問を実行します。 |
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, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpressioncloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSEpublic UIForm()
デフォルトのプロパティ値で新しい UIForm インスタンスを作成します。
public StringSE getFamily()
UIComponent このコンポーネントが属するコンポーネントファミリの識別子を返します。この識別子は、rendererType プロパティの値と組み合わせて、このコンポーネントインスタンスに適切な Renderer を選択するために使用できます。このメソッドは null を返すべきではないことに注意してください
UIComponent の getFamily public boolean isSubmitted()
submitted プロパティの現在の値を返します。デフォルト値は false です。詳細については、setSubmitted(boolean) を参照してください。
このプロパティは、UIComponent.getTransientStateHelper() を使用して一時的なプロパティとして保持する必要があります。
true、それ以外の場合は false。public void setSubmitted(boolean submitted)
（ページ内の他の形ではなく） この UIForm インスタンスがこのリクエスト処理ライフサイクル中に提出発生している場合、このメソッドは、この UIForm インスタンスの UIComponent.decode(jakarta.faces.context.FacesContext) 時に、引数として true で、呼び出されなければなりません。この UIForm インスタンスで送信が発生していない場合は、この UIForm インスタンスの UIComponent.decode(jakarta.faces.context.FacesContext) 中に、false を引数としてこのメソッドを呼び出す必要があります。
UIForm の送信されたプロパティの値は、その状態の一部として保存してはなりません。
このプロパティは、UIComponent.getTransientStateHelper() を使用して一時的なプロパティとして保持する必要があります。
submitted - 送信されたフラグの新しい値。public boolean isPrependId()
true、それ以外の場合は false。public void setPrependId(boolean prependId)
public void processDecodes(FacesContext context)
UIComponent.processDecodes(jakarta.faces.context.FacesContext) をオーバーライドして、フォームがその子より先にデコードされるようにします。これは、submitted プロパティを正しく設定するために必要です。
UIComponentBase の processDecodes context - FacesContext（処理中のリクエスト）NullPointerExceptionSE - context が null の場合 public void processValidators(FacesContext context)
UIComponent.processValidators(jakarta.faces.context.FacesContext) をオーバーライドして、この UIForm インスタンスの子が isSubmitted() が true を返す場合にのみ処理されるようにします。
UIComponentBase の processValidators context - FacesContext（処理中のリクエスト）NullPointerExceptionSE - context が null の場合 PreValidateEvent, PostValidateEventpublic void processUpdates(FacesContext context)
UIComponent.processUpdates(jakarta.faces.context.FacesContext) をオーバーライドして、この UIForm インスタンスの子が isSubmitted() が true を返す場合にのみ処理されるようにします。
UIComponentBase の processUpdates context - FacesContext（処理中のリクエスト）NullPointerExceptionSE - context が null の場合 public StringSE createUniqueId(FacesContext context, StringSE seed)
コンポーネントの識別子を生成します。識別子の前には UNIQUE_ID_PREFIX が付けられ、このコンポーネントコンテナー内で一意になります。オプションで、生成された一意の ID に含める必要のある一意のシード値をコンポーネントの作成者が提供できます。
prependId プロパティの値が false の場合、このメソッドは次の祖先 UniqueIdVendor で createUniqueId を呼び出す必要があります。
UniqueIdVendor の createUniqueId context - FacesContextseed - オプションのシード値 - 例 VDL テンプレート内のコンポーネントの位置に基づく public StringSE getContainerClientId(FacesContext context)
UIComponent.getContainerClientId(jakarta.faces.context.FacesContext) をオーバーライドして、このフォームの isPrependId() プロパティの値に応じて、ユーザーがこのフォームを無効にして、clientId をその子孫の clientIds の前に付加できないようにします。
UIComponent の getContainerClientId context - Faces コンテキスト。public boolean visitTree(VisitContext context, VisitCallback callback)
UIComponentツリー内のこのノードからツリー訪問を実行します。
UIComponent.visitTree() の実装は VisitCallback を直接呼び出さず、代わりに VisitContext.invokeVisitCallback(jakarta.faces.component.UIComponent, jakarta.faces.component.visit.VisitCallback) を呼び出してコールバックを呼び出します。これにより、VisitContext 実装は、たとえばコンポーネントのサブセットに対して VisitCallback を呼び出すだけで、最適化されたツリートラバーサルを提供できます。
UIComponent.visitTree() 実装は、訪問を実行する前に UIComponent.pushComponentToEL() を呼び出し、訪問後に UIComponent.popComponentFromEL() を呼び出す必要があります。
UIComponent の visitTree context - この訪問の VisitContext callback - 訪問したノードごとに visit メソッドが呼び出される VisitCallback インスタンス true を返し、ツリーの訪問が完了したことを示す場合があります（訪問する必要のあるすべてのコンポーネントが訪問されたなど）。これにより、ツリーへのアクセスが短絡され、アクセスされるコンポーネントがなくなります。UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback)Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.