UIOutcomeTarget (Jakarta EE Platform API)

java.lang.ObjectSE
- jakarta.faces.component.UIComponent
- - jakarta.faces.component.UIComponentBase
  - - jakarta.faces.component.UIOutput
    - - jakarta.faces.component.UIOutcomeTarget

実装されたすべてのインターフェース:
PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListenerSE
既知の直属サブクラス
HtmlOutcomeTargetButton, HtmlOutcomeTargetLink
```
public class UIOutcomeTarget
extends UIOutput
```
このコンポーネントは、jakarta.faces.Button または jakarta.faces.Link レンダラーとペアになっており、結果をレスポンスに直接レンダリングすることに関連するプロパティをカプセル化します。これにより、Jakarta Server Faces アプリケーションでブックマーク可能になります。
導入:
2.0

フィールドサマリー

フィールド
修飾子と型	フィールドと説明
`static StringSE`	`COMPONENT_FAMILY` このコンポーネントの標準コンポーネントファミリ。
`static StringSE`	`COMPONENT_TYPE` このコンポーネントの標準コンポーネント型。

クラス jakarta.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

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
UIOutcomeTarget()
デフォルトのプロパティ値で新しい UIOutcomeTarget インスタンスを作成します。

コンストラクター
コンストラクターと説明
`UIOutcomeTarget()` デフォルトのプロパティ値で新しい `UIOutcomeTarget` インスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`StringSE`	`getFamily()` このコンポーネントが属するコンポーネントファミリの識別子を返します。
`StringSE`	`getOutcome()` `UIOutcomeTarget` の `outcome` プロパティを返します。
`boolean`	`isDisableClientWindow()` クライアントウィンドウをターゲット URL にエンコードする必要があるかどうかを返します。
`boolean`	`isIncludeViewParams()` ビューパラメーターをターゲット URL にエンコードする必要があるかどうかを返します。
`void`	`setDisableClientWindow(boolean disableClientWindow)` クライアントウィンドウをターゲット URL にエンコードするかどうかを設定します。
`void`	`setIncludeViewParams(boolean includeViewParams)` ページパラメーターをターゲット URL にエンコードするかどうかを設定します。
`void`	`setOutcome(StringSE outcome)` `UIOutcomeTarget` の `outcome` プロパティを設定します。

クラス jakarta.faces.component.UIOutput から継承されたメソッド
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue

クラス jakarta.faces.component.UIComponentBase から継承されたメソッド
addClientBehavior, addFacesListener, broadcast, 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

クラス jakarta.faces.component.UIComponent から継承されたメソッド
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - COMPONENT_TYPE
```
public static final StringSE COMPONENT_TYPE
```
    このコンポーネントの標準コンポーネント型。
    関連事項:
    定数フィールド値
  - COMPONENT_FAMILY
```
public static final StringSE COMPONENT_FAMILY
```
    このコンポーネントの標準コンポーネントファミリ。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - UIOutcomeTarget
```
public UIOutcomeTarget()
```
    デフォルトのプロパティ値で新しい UIOutcomeTarget インスタンスを作成します。
- メソッドの詳細
  - getFamily
```
public StringSE getFamily()
```
    クラスからコピーされた説明: UIComponent
    このコンポーネントが属するコンポーネントファミリの識別子を返します。この識別子は、rendererType プロパティの値と組み合わせて、このコンポーネントインスタンスに適切な Renderer を選択するために使用できます。このメソッドは null を返すべきではないことに注意してください
    オーバーライド:
    クラス UIOutput の getFamily
    戻り値:
    コンポーネントファミリ（null 以外）。
  - isIncludeViewParams
```
public boolean isIncludeViewParams()
```
    ビューパラメーターをターゲット URL にエンコードする必要があるかどうかを返します。
    戻り値:
    ビューパラメーターを URL にエンコードする必要がある場合は true、それ以外の場合は false。
    導入:
    2.0
  - setIncludeViewParams
```
public void setIncludeViewParams(boolean includeViewParams)
```
    ページパラメーターをターゲット URL にエンコードするかどうかを設定します。
    パラメーター:
    includeViewParams - ページパラメーターをエンコードするためのスイッチの状態
    導入:
    2.0
  - isDisableClientWindow
```
public boolean isDisableClientWindow()
```
    クライアントウィンドウをターゲット URL にエンコードする必要があるかどうかを返します。
    戻り値:
    クライアントウィンドウを URL にエンコードしない場合は true、それ以外の場合は false。
    導入:
    2.0
  - setDisableClientWindow
```
public void setDisableClientWindow(boolean disableClientWindow)
```
    クライアントウィンドウをターゲット URL にエンコードするかどうかを設定します。
    パラメーター:
    disableClientWindow - @{code true} の場合、クライアントウィンドウはこの結果ターゲットに含まれません。
    導入:
    2.2
  - getOutcome
```
public StringSE getOutcome()
```
    UIOutcomeTarget の outcome プロパティを返します。この値は、このコンポーネントのターゲット URL を解決するときに NavigationHandler に渡されます。
    戻り値:
    結果。
    導入:
    2.0
  - setOutcome
```
public void setOutcome(StringSE outcome)
```
    UIOutcomeTarget の outcome プロパティを設定します。この値は、このコンポーネントのターゲット URL を解決するときに NavigationHandler に渡されます。
    パラメーター:
    outcome - ナビゲーションの結果
    導入:
    2.0

クラス UIOutcomeTarget

フィールドサマリー

クラス jakarta.faces.component.UIComponent から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス jakarta.faces.component.UIOutput から継承されたメソッド

クラス jakarta.faces.component.UIComponentBase から継承されたメソッド

クラス jakarta.faces.component.UIComponent から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

COMPONENT_TYPE

COMPONENT_FAMILY

コンストラクターの詳細

UIOutcomeTarget

メソッドの詳細

getFamily

isIncludeViewParams

setIncludeViewParams

isDisableClientWindow

setDisableClientWindow

getOutcome

setOutcome