クラス HtmlOutputFormat
- java.lang.ObjectSE
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIOutput
-
- jakarta.faces.component.html.HtmlOutputFormat
- 実装されているすべてのインターフェース:
PartialStateHolder、StateHolder、TransientStateHolder、ValueHolder、ComponentSystemEventListener、FacesListener、SystemEventListenerHolder、EventListenerSE
public class HtmlOutputFormat extends UIOutput
リソースバンドルでローカライズされたメッセージを検索し、オプションでそれを
MessageFormatパターン文字列として使用し、ネストされた UIParameter コンポーネントからのパラメーター値を置き換えて結果をレンダリングするコンポーネントを表します。"dir" または "lang" 属性が存在する場合は、span要素をレンダリングし、スパンの属性として渡します。デフォルトでは、
rendererTypeプロパティを "jakarta.faces.Format" に設定する必要があります。この値は、setRendererType()メソッドを呼び出すことで変更できます。
ネストされたクラスの要約
ネストされたクラス 修飾子と型 クラス 説明 protected static classHtmlOutputFormat.PropertyKeysプロパティキー。
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 static StringSECOMPONENT_TYPEこのコンポーネントの標準コンポーネント型。クラス jakarta.faces.component.UIOutput から継承されたフィールド
COMPONENT_FAMILY
クラス jakarta.faces.component.UIComponent から継承されたフィールド
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
コンストラクターの概要
コンストラクター コンストラクター 説明 HtmlOutputFormat()
方法の概要
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 StringSEgetDir()dirプロパティの値を返します。StringSEgetLang()langプロパティの値を返します。StringSEgetRole()roleプロパティの値を返します。StringSEgetStyle()styleプロパティの値を返します。StringSEgetStyleClass()styleClassプロパティの値を返します。StringSEgetTitle()titleプロパティの値を返します。booleanisEscape()escapeプロパティの値を返します。voidsetDir(StringSE dir)dirプロパティの値を設定します。voidsetEscape(boolean escape)escapeプロパティの値を設定します。voidsetLang(StringSE lang)langプロパティの値を設定します。voidsetRole(StringSE role)roleプロパティの値を設定します。voidsetStyle(StringSE style)styleプロパティの値を設定します。voidsetStyleClass(StringSE styleClass)styleClassプロパティの値を設定します。voidsetTitle(StringSE title)titleプロパティの値を設定します。クラス jakarta.faces.component.UIOutput から継承されたメソッド
clearInitialState, getConverter, getFamily, 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, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, 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
メソッドの詳細
getDir
public StringSE getDir()
dirプロパティの値を返します。- 戻り値:
- プロパティ値
内容: 方向性を継承しないテキストの方向指示。有効な値は "LTR" (左から右)および "RTL" (右から左)です。これらの属性は、XHTML にレンダリングするときに大文字と小文字を区別するため、大文字と小文字を区別するように注意する必要があります。
setDir
public void setDir(StringSE dir)
dirプロパティの値を設定します。- パラメーター:
dir- 新しいプロパティ値
isEscape
public boolean isEscape()
escapeプロパティの値を返します。- 戻り値:
- プロパティ値
内容: HTML および XML マークアップで機密性の高い文字をエスケープする必要があることを示すフラグ。このフラグはデフォルトで "true" に設定されています。
setEscape
public void setEscape(boolean escape)
escapeプロパティの値を設定します。- パラメーター:
escape- 新しいプロパティ値
getLang
public StringSE getLang()
langプロパティの値を返します。- 戻り値:
- プロパティ値
内容: このコンポーネントの生成されたマークアップで使用される言語を説明するコード。
setLang
public void setLang(StringSE lang)
langプロパティの値を設定します。- パラメーター:
lang- 新しいプロパティ値
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- 新しいプロパティ値
getTitle
public StringSE getTitle()
titleプロパティの値を返します。- 戻り値:
- プロパティ値
内容: このコンポーネントに対して生成されたマークアップ要素に関する助言のタイトル情報。
setTitle
public void setTitle(StringSE title)
titleプロパティの値を設定します。- パラメーター:
title- 新しいプロパティ値