HtmlForm (Jakarta EE Platform API)

java.lang.ObjectSE
- jakarta.faces.component.UIComponent
- - jakarta.faces.component.UIComponentBase
  - - jakarta.faces.component.UIForm
    - - jakarta.faces.component.html.HtmlForm

実装されているすべてのインターフェース:
ClientBehaviorHolder, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListenerSE
```
public class HtmlForm
extends UIForm
implements ClientBehaviorHolder
```
HTML form 要素を表します。子入力コンポーネントは、無効にされていない限り送信されます。
デフォルトでは、rendererType プロパティを "jakarta.faces.Form" に設定する必要があります。この値は、setRendererType() メソッドを呼び出すことで変更できます。

ネストされたクラスの要約
ネストされたクラス
修飾子と型クラスと説明
protected static class HtmlForm.PropertyKeys

ネストされたクラス
修飾子と型	クラスと説明
`protected static class`	`HtmlForm.PropertyKeys`

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static StringSE COMPONENT_TYPE
このコンポーネントの標準コンポーネント型。
- クラス jakarta.faces.component.UIForm から継承されたフィールド
  COMPONENT_FAMILY
- クラス 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
- インターフェース jakarta.faces.component.NamingContainer から継承されたフィールド
  SEPARATOR_CHAR

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

コンストラクターの概要
コンストラクター
コンストラクターと説明
HtmlForm()

コンストラクター
コンストラクターと説明
`HtmlForm()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`StringSE`	`getAccept()` `accept` プロパティの値を返します。
`StringSE`	`getAcceptcharset()` `acceptcharset` プロパティの値を返します。
`StringSE`	`getDefaultEventName()` これは `ClientBehaviorHolder.getDefaultEventName()` のデフォルトの実装です。
`StringSE`	`getDir()` `dir` プロパティの値を返します。
`StringSE`	`getEnctype()` `enctype` プロパティの値を返します。
`CollectionSE<StringSE>`	`getEventNames()` これは `ClientBehaviorHolder.getEventNames()` のデフォルトの実装です。
`StringSE`	`getLang()` `lang` プロパティの値を返します。
`StringSE`	`getOnclick()` `onclick` プロパティの値を返します。
`StringSE`	`getOndblclick()` `ondblclick` プロパティの値を返します。
`StringSE`	`getOnkeydown()` `onkeydown` プロパティの値を返します。
`StringSE`	`getOnkeypress()` `onkeypress` プロパティの値を返します。
`StringSE`	`getOnkeyup()` `onkeyup` プロパティの値を返します。
`StringSE`	`getOnmousedown()` `onmousedown` プロパティの値を返します。
`StringSE`	`getOnmousemove()` `onmousemove` プロパティの値を返します。
`StringSE`	`getOnmouseout()` `onmouseout` プロパティの値を返します。
`StringSE`	`getOnmouseover()` `onmouseover` プロパティの値を返します。
`StringSE`	`getOnmouseup()` `onmouseup` プロパティの値を返します。
`StringSE`	`getOnreset()` `onreset` プロパティの値を返します。
`StringSE`	`getOnsubmit()` `onsubmit` プロパティの値を返します。
`StringSE`	`getRole()` `role` プロパティの値を返します。
`StringSE`	`getStyle()` `style` プロパティの値を返します。
`StringSE`	`getStyleClass()` `styleClass` プロパティの値を返します。
`StringSE`	`getTarget()` `target` プロパティの値を返します。
`StringSE`	`getTitle()` `title` プロパティの値を返します。
`void`	`setAccept(StringSE accept)` `accept` プロパティの値を設定します。
`void`	`setAcceptcharset(StringSE acceptcharset)` `acceptcharset` プロパティの値を設定します。
`void`	`setDir(StringSE dir)` `dir` プロパティの値を設定します。
`void`	`setEnctype(StringSE enctype)` `enctype` プロパティの値を設定します。
`void`	`setLang(StringSE lang)` `lang` プロパティの値を設定します。
`void`	`setOnclick(StringSE onclick)` `onclick` プロパティの値を設定します。
`void`	`setOndblclick(StringSE ondblclick)` `ondblclick` プロパティの値を設定します。
`void`	`setOnkeydown(StringSE onkeydown)` `onkeydown` プロパティの値を設定します。
`void`	`setOnkeypress(StringSE onkeypress)` `onkeypress` プロパティの値を設定します。
`void`	`setOnkeyup(StringSE onkeyup)` `onkeyup` プロパティの値を設定します。
`void`	`setOnmousedown(StringSE onmousedown)` `onmousedown` プロパティの値を設定します。
`void`	`setOnmousemove(StringSE onmousemove)` `onmousemove` プロパティの値を設定します。
`void`	`setOnmouseout(StringSE onmouseout)` `onmouseout` プロパティの値を設定します。
`void`	`setOnmouseover(StringSE onmouseover)` `onmouseover` プロパティの値を設定します。
`void`	`setOnmouseup(StringSE onmouseup)` `onmouseup` プロパティの値を設定します。
`void`	`setOnreset(StringSE onreset)` `onreset` プロパティの値を設定します。
`void`	`setOnsubmit(StringSE onsubmit)` `onsubmit` プロパティの値を設定します。
`void`	`setRole(StringSE role)` `role` プロパティの値を設定します。
`void`	`setStyle(StringSE style)` `style` プロパティの値を設定します。
`void`	`setStyleClass(StringSE styleClass)` `styleClass` プロパティの値を設定します。
`void`	`setTarget(StringSE target)` `target` プロパティの値を設定します。
`void`	`setTitle(StringSE title)` `title` プロパティの値を設定します。

クラス jakarta.faces.component.UIForm から継承されたメソッド
createUniqueId, getContainerClientId, getFamily, isPrependId, isSubmitted, processDecodes, processUpdates, processValidators, setPrependId, setSubmitted, visitTree

クラス jakarta.faces.component.UIComponentBase から継承されたメソッド
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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, unsubscribeFromEvent

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

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

インターフェース jakarta.faces.component.behavior.ClientBehaviorHolder から継承されたメソッド
addClientBehavior, getClientBehaviors

- フィールドの詳細
  - COMPONENT_TYPE
```
public static final StringSE COMPONENT_TYPE
```
    このコンポーネントの標準コンポーネント型。
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - HtmlForm
```
public HtmlForm()
```
- メソッドの詳細
  - getAccept
```
public StringSE getAccept()
```
    accept プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: このフォームを処理するサーバーが正しく処理するコンテンツ型のリスト
  - setAccept
```
public void setAccept(StringSE accept)
```
    accept プロパティの値を設定します。
    パラメーター:
    accept - 新しいプロパティ値
  - getAcceptcharset
```
public StringSE getAcceptcharset()
```
    acceptcharset プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: このフォームを処理するサーバーによって受け入れられる入力データの文字エンコードのリスト。
  - setAcceptcharset
```
public void setAcceptcharset(StringSE acceptcharset)
```
    acceptcharset プロパティの値を設定します。
    パラメーター:
    acceptcharset - 新しいプロパティ値
  - getDir
```
public StringSE getDir()
```
    dir プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: 方向性を継承しないテキストの方向指示。有効な値は "LTR" （左から右）および "RTL" （右から左）です。これらの属性は、XHTML にレンダリングするときに大文字と小文字を区別するため、大文字と小文字を区別するように注意する必要があります。
  - setDir
```
public void setDir(StringSE dir)
```
    dir プロパティの値を設定します。
    パラメーター:
    dir - 新しいプロパティ値
  - getEnctype
```
public StringSE getEnctype()
```
    enctype プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: フォームをサーバーに送信するために使用されるコンテンツ型。指定しない場合、デフォルト値は "application/x-www-form-urlencoded" です。
  - setEnctype
```
public void setEnctype(StringSE enctype)
```
    enctype プロパティの値を設定します。
    パラメーター:
    enctype - 新しいプロパティ値
  - getLang
```
public StringSE getLang()
```
    lang プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: このコンポーネントの生成されたマークアップで使用される言語を説明するコード。
  - setLang
```
public void setLang(StringSE lang)
```
    lang プロパティの値を設定します。
    パラメーター:
    lang - 新しいプロパティ値
  - getOnclick
```
public StringSE getOnclick()
```
    onclick プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: この要素の上でポインターボタンがクリックされたときに実行される JavaScript コード。
  - setOnclick
```
public void setOnclick(StringSE onclick)
```
    onclick プロパティの値を設定します。
    パラメーター:
    onclick - 新しいプロパティ値
  - getOndblclick
```
public StringSE getOndblclick()
```
    ondblclick プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: ポインタボタンがこの要素上でダブルクリックされたときに実行される JavaScript コード。
  - setOndblclick
```
public void setOndblclick(StringSE ondblclick)
```
    ondblclick プロパティの値を設定します。
    パラメーター:
    ondblclick - 新しいプロパティ値
  - getOnkeydown
```
public StringSE getOnkeydown()
```
    onkeydown プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: この要素上でキーが押されたときに実行される Javascript コード。
  - setOnkeydown
```
public void setOnkeydown(StringSE onkeydown)
```
    onkeydown プロパティの値を設定します。
    パラメーター:
    onkeydown - 新しいプロパティ値
  - getOnkeypress
```
public StringSE getOnkeypress()
```
    onkeypress プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: この要素上でキーを押して離したときに実行される Javascript コード。
  - setOnkeypress
```
public void setOnkeypress(StringSE onkeypress)
```
    onkeypress プロパティの値を設定します。
    パラメーター:
    onkeypress - 新しいプロパティ値
  - getOnkeyup
```
public StringSE getOnkeyup()
```
    onkeyup プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: この要素でキーが離されたときに実行される Javascript コード。
  - setOnkeyup
```
public void setOnkeyup(StringSE onkeyup)
```
    onkeyup プロパティの値を設定します。
    パラメーター:
    onkeyup - 新しいプロパティ値
  - getOnmousedown
```
public StringSE getOnmousedown()
```
    onmousedown プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: この要素上でポインタボタンが押されたときに実行される Javascript コード。
  - setOnmousedown
```
public void setOnmousedown(StringSE onmousedown)
```
    onmousedown プロパティの値を設定します。
    パラメーター:
    onmousedown - 新しいプロパティ値
  - getOnmousemove
```
public StringSE getOnmousemove()
```
    onmousemove プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: この要素内でポインタボタンが移動したときに実行される Javascript コード。
  - setOnmousemove
```
public void setOnmousemove(StringSE onmousemove)
```
    onmousemove プロパティの値を設定します。
    パラメーター:
    onmousemove - 新しいプロパティ値
  - getOnmouseout
```
public StringSE getOnmouseout()
```
    onmouseout プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: ポインタボタンがこの要素から離れたときに実行される JavaScript コード。
  - setOnmouseout
```
public void setOnmouseout(StringSE onmouseout)
```
    onmouseout プロパティの値を設定します。
    パラメーター:
    onmouseout - 新しいプロパティ値
  - getOnmouseover
```
public StringSE getOnmouseover()
```
    onmouseover プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: ポインタボタンがこの要素に移動したときに実行される Javascript コード。
  - setOnmouseover
```
public void setOnmouseover(StringSE onmouseover)
```
    onmouseover プロパティの値を設定します。
    パラメーター:
    onmouseover - 新しいプロパティ値
  - getOnmouseup
```
public StringSE getOnmouseup()
```
    onmouseup プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: この要素上でポインターボタンが離されたときに実行される JavaScript コード。
  - setOnmouseup
```
public void setOnmouseup(StringSE onmouseup)
```
    onmouseup プロパティの値を設定します。
    パラメーター:
    onmouseup - 新しいプロパティ値
  - getOnreset
```
public StringSE getOnreset()
```
    onreset プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: このフォームがリセットされたときに実行される JavaScript コード。
  - setOnreset
```
public void setOnreset(StringSE onreset)
```
    onreset プロパティの値を設定します。
    パラメーター:
    onreset - 新しいプロパティ値
  - getOnsubmit
```
public StringSE getOnsubmit()
```
    onsubmit プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: このフォームが送信されたときに実行される JavaScript コード。
  - setOnsubmit
```
public void setOnsubmit(StringSE onsubmit)
```
    onsubmit プロパティの値を設定します。
    パラメーター:
    onsubmit - 新しいプロパティ値
  - getRole
```
public StringSE getRole()
```
    role プロパティの値を返します。
    戻り値:
    プロパティ値
    コンテンツ:
    WAI-ARIA 仕様と HTML5 との関連（セクションタイトル ARIA Role Attriubute）に従って、すべての HTML 要素には "role" 属性が含まれる場合があり、その値は、最終的なレンダリングマークアップで宣言されている要素に変更されずに渡される必要があります。属性は、指定される場合、要素が属するさまざまな WAI-ARIA ロールを表すスペースで区切られたトークンのセットである文字列リテラル、または評価される EL 式である値を持つ必要があります。
    ユーザーエージェントがこの属性の値を正しく解釈できることを確認するのは、ページ作成者の責任です。
  - setRole
```
public void setRole(StringSE role)
```
    role プロパティの値を設定します。
    パラメーター:
    role - 新しいプロパティ値
  - getStyle
```
public StringSE getStyle()
```
    style プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: このコンポーネントがレンダリングされるときに適用される CSS スタイル。
  - setStyle
```
public void setStyle(StringSE style)
```
    style プロパティの値を設定します。
    パラメーター:
    style - 新しいプロパティ値
  - getStyleClass
```
public StringSE getStyleClass()
```
    styleClass プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: この要素がレンダリングされるときに適用される CSS スタイルクラスのスペースで区切られたリスト。この値は、生成されたマークアップで "class" 属性としてパススルーする必要があります。
  - setStyleClass
```
public void setStyleClass(StringSE styleClass)
```
    styleClass プロパティの値を設定します。
    パラメーター:
    styleClass - 新しいプロパティ値
  - getTarget
```
public StringSE getTarget()
```
    target プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: このフォームの送信後に取得したレスポンスを表示するフレームの名前。
  - setTarget
```
public void setTarget(StringSE target)
```
    target プロパティの値を設定します。
    パラメーター:
    target - 新しいプロパティ値
  - getTitle
```
public StringSE getTitle()
```
    title プロパティの値を返します。
    戻り値:
    プロパティ値
    内容: このコンポーネントに対して生成されたマークアップ要素に関する助言のタイトル情報。
  - setTitle
```
public void setTitle(StringSE title)
```
    title プロパティの値を設定します。
    パラメーター:
    title - 新しいプロパティ値
  - getEventNames
```
public CollectionSE<StringSE> getEventNames()
```
    クラスからコピーされた説明: UIComponentBase
    これは ClientBehaviorHolder.getEventNames() のデフォルトの実装です。UIComponent は ClientBehaviorHolder インターフェースを実装していませんが、ClientBehaviorHolder によって定義されたメソッドのデフォルト実装を提供して、サブクラスの実装を簡素化しています。ClientBehaviorHolder 契約をサポートするサブクラスは、サブクラスが ClientBehaviorHolder を実装することを宣言し、このメソッドをオーバーライドして、コンポーネントがサポートするクライアントイベント名の空でない Collection を返す必要があります。
    次で指定:
    インターフェース ClientBehaviorHolder の getEventNames
    オーバーライド:
    クラス UIComponentBase の getEventNames
    戻り値:
    イベント名のコレクション。
  - getDefaultEventName
```
public StringSE getDefaultEventName()
```
    クラスからコピーされた説明: UIComponentBase
    これは ClientBehaviorHolder.getDefaultEventName() のデフォルトの実装です。UIComponent は ClientBehaviorHolder インターフェースを実装していませんが、ClientBehaviorHolder によって定義されたメソッドのデフォルト実装を提供して、サブクラスの実装を簡素化しています。ClientBehaviorHolder 契約をサポートするサブクラスは、サブクラスが ClientBehaviorHolder を実装することを宣言し、ClientBehaviorHolder.getEventNames() の実装を提供する必要があります。
    次で指定:
    インターフェース ClientBehaviorHolder の getDefaultEventName
    オーバーライド:
    クラス UIComponentBase の getDefaultEventName
    戻り値:
    デフォルトのイベント名。

クラス HtmlForm

ネストされたクラスの要約

フィールドのサマリー

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

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

インターフェース jakarta.faces.component.NamingContainer から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

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

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

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

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

インターフェース jakarta.faces.component.behavior.ClientBehaviorHolder から継承されたメソッド

フィールドの詳細

COMPONENT_TYPE

コンストラクターの詳細

HtmlForm

メソッドの詳細

getAccept

setAccept

getAcceptcharset

setAcceptcharset

getDir

setDir

getEnctype

setEnctype

getLang

setLang

getOnclick

setOnclick

getOndblclick

setOndblclick

getOnkeydown

setOnkeydown

getOnkeypress

setOnkeypress

getOnkeyup

setOnkeyup

getOnmousedown

setOnmousedown

getOnmousemove

setOnmousemove

getOnmouseout

setOnmouseout

getOnmouseover

setOnmouseover

getOnmouseup

setOnmouseup

getOnreset

setOnreset

getOnsubmit

setOnsubmit

getRole

setRole

getStyle

setStyle

getStyleClass

setStyleClass

getTarget

setTarget

getTitle

setTitle

getEventNames

getDefaultEventName