API リファレンス
検索インデックスを準備中…

文書から取得する Rml::ElementFormControl 基底ラッパー。

継承関係

階層 (概要を見る)

ソースと継承
メンバー一覧128

コンストラクター

アクセッサー

メソッド

コンストラクター

  • 切り離したネイティブ要素を作るか、内部ハンドルをラップします。

    引数

    tagOrHandle
    string | object

    具体的なネイティブ型から独立したタグ。

    attributes
    Record<string, VariantValue> = {}

    所有する初期値。既定は空の辞書。

    戻り値

    元の生成器を保持し、入力の既定値を初期化します。Factory の登録変更や プラグイン生成通知はありません。JS 派生型は最も近い登録済み具体型を使います。 抽象型 ElementFormControl のタグによる直接生成は拒否します。

    ソースと継承

アクセッサー

  • get absoluteLeft(): number

    GetAbsoluteLeft をコンテキストのピクセルで取得します。

    戻り値

    number

    コンテキスト内の水平オフセット。

    ソースと継承
  • get absoluteTop(): number

    GetAbsoluteTop をコンテキストのピクセルで取得します。

    戻り値

    number

    コンテキスト内の垂直オフセット。

    ソースと継承
  • get baseline(): number

    GetBaseline。下マージン端から上向きのピクセル距離です。

    戻り値

    number

    上向きのベースライン距離(ピクセル)。

    ソースと継承
  • get clientHeight(): number

    GetClientHeight。パディング高さから水平スクロールバーを除きます。

    戻り値

    number

    クライアント領域の高さ(ピクセル)。

    ソースと継承
  • get clientLeft(): number

    GetClientLeft(左ボーダー幅)を取得します。

    戻り値

    number

    左ボーダーの幅。

    ソースと継承
  • get clientTop(): number

    GetClientTop(上ボーダー幅)を取得します。

    戻り値

    number

    上ボーダーの幅。

    ソースと継承
  • get clientWidth(): number

    GetClientWidth。パディング幅から垂直スクロールバーを除きます。

    戻り値

    number

    クライアント領域の幅(ピクセル)。

    ソースと継承
  • get clipArea(): BoxArea

    GetClipArea/SetClipArea。Auto は自動クリッピングです。

    戻り値

    クリップ領域。

    ソースと継承
  • set clipArea(area: BoxArea): void

    クリッピングに使うボックス領域を設定します。

    引数

    area

    ネイティブのクリップ領域。

    戻り値

    void
    ソースと継承
  • get id(): string

    要素の id。

    戻り値

    string

    要素の id。未設定の場合は空文字列。

    ソースと継承
  • set id(id: string): void

    Rml::Element::SetId で要素の id を設定します。

    引数

    id
    string

    新しい要素の id。

    戻り値

    void
    ソースと継承
  • get innerRML(): string

    内部の RML マークアップ。

    戻り値

    string

    内部マークアップの文字列。

    ソースと継承
  • set innerRML(rml: string): void

    Rml::Element::SetInnerRML で子要素のマークアップを置換します。

    引数

    rml
    string

    新しいマークアップ。既存の子要素ラッパーは無効になります。

    戻り値

    void
    ソースと継承
  • get offsetHeight(): number

    GetOffsetHeight。コンテンツ、パディング、ボーダーを含みます。

    戻り値

    number

    ボーダー領域の高さ(ピクセル)。

    ソースと継承
  • get offsetLeft(): number

    GetOffsetLeft。オフセットの親から左ボーダーまでの距離です。

    戻り値

    number

    ボーダーの水平オフセット。

    ソースと継承
  • get offsetParent(): null | Element

    GetOffsetParent。オフセットの親が存在しない場合は null。

    戻り値

    null | Element

    有効なオフセット親、または null。

    ソースと継承
  • get offsetTop(): number

    GetOffsetTop。オフセットの親から上ボーダーまでの距離です。

    戻り値

    number

    ボーダーの垂直オフセット。

    ソースと継承
  • get offsetWidth(): number

    GetOffsetWidth。コンテンツ、パディング、ボーダーを含みます。

    戻り値

    number

    ボーダー領域の幅(ピクセル)。

    ソースと継承
  • get scrollHeight(): number

    GetScrollHeight。パディングとスクロール可能な内容を含みます。

    戻り値

    number

    スクロール可能な高さ(ピクセル)。

    ソースと継承
  • get scrollLeft(): number

    GetScrollLeft/SetScrollLeft。丸めと範囲制限を行い、 値が変わると scroll イベントを同期送信します。

    戻り値

    number

    水平スクロール量。

    ソースと継承
  • set scrollLeft(value: number): void

    Rml::Element::SetScrollLeft で水平スクロール位置を設定します。

    引数

    value
    number

    水平方向のピクセル位置。RmlUi が範囲内に制限します。

    戻り値

    void
    ソースと継承
  • get scrollTop(): number

    GetScrollTop/SetScrollTop。丸めと範囲制限を行い、 値が変わると scroll イベントを同期送信します。

    戻り値

    number

    垂直スクロール量。

    ソースと継承
  • set scrollTop(value: number): void

    Rml::Element::SetScrollTop で垂直スクロール位置を設定します。

    引数

    value
    number

    垂直方向のピクセル位置。RmlUi が範囲内に制限します。

    戻り値

    void
    ソースと継承
  • get scrollWidth(): number

    GetScrollWidth。パディングとスクロール可能な内容を含みます。

    戻り値

    number

    スクロール可能な幅(ピクセル)。

    ソースと継承
  • get zIndex(): number

    ネイティブ GetZIndex の結果を取得します。

    戻り値

    number

    ネイティブの z-index。

    ソースと継承

メソッド

  • Rml::Element::AddAnimationKey でキーのコピーを追加。

    引数

    property
    string | PropertyId

    ネイティブのプロパティ名または ID。

    target

    型付き目標値。

    duration
    number

    追加する非負の秒数。

    tweenオプション

    イージング。既定はネイティブ Linear/Out。

    戻り値

    boolean

    成功結果。既存アニメーションがなければ false。

    ソースと継承
  • イベントリスナーを登録します。

    引数

    type
    string | number

    イベント名または登録済みネイティブ EventId。

    listener

    同期コールバック。複数の登録で共有できます。

    capture
    boolean = false

    キャプチャ段階で受け取るかどうか。既定値は false。

    戻り値

    void

    要素・種類・コールバック・capture が同じ登録は重複しません。 解除や要素破棄で自動解放され、実行中も自身や他のリスナーを解除できます。 例外はイベントを発生させた呼び出しから伝播します。クラス、スタイル、属性、 タイトル、無関係なサブツリーは同期変更できます。イベント対象や実行中の ネイティブ呼び出し対象の破棄、終了、再帰更新・入力は拒否されます。 属性設定・削除は活動対象の祖先でも拒否します。実行中の入力要素の type 設定・削除もネイティブウィジェットを保護するため拒否します。 これらは queueMicrotask などで実行後に予約してください。

    ソースと継承
  • プロパティ名または ID で Rml::Element::Animate を開始・置換。

    引数

    property
    string | PropertyId

    ネイティブのプロパティ名または ID。

    target

    RmlUi がコピーする型付き目標値。

    duration
    number

    秒単位の非負の継続時間。

    tweenオプション

    イージング。既定はネイティブ Linear/Out。

    iterations
    number = 1

    反復回数。既定は 1、-1 は無限。

    alternate
    boolean = true

    反復ごとに方向を反転。既定は true。

    delay
    number = 0

    秒単位の遅延。既定はゼロ。

    start
    null | Property = null

    コピーされる開始値。null は現在の値。

    戻り値

    boolean

    成功結果。不明・非対応のプロパティは false。

    ソースと継承
  • Rml::Element::AppendChild で未接続要素の所有権を移します。

    引数

    child

    所有権付き未接続要素。接続済みなら先に取り外してください。

    domElement
    boolean = true

    DOM 走査に含めるか。既定値は true。

    戻り値

    同じ子要素ラッパー。

    循環・コンテキストルート・実行中の対象ツリーは拒否します。 文書は元のコンテキストを保持し、その有効なコンテキスト内だけで移動できます。 コンテキストルートは自身の文書だけを DOM 子として受け入れます。 所有権は一度だけ移り、リスナーは取り外しと再挿入後も保持されます。 内部要素は読めますが取り外し・置換できません。API で追加した非 DOM 要素は移動できます。

    ソースと継承
  • ArePseudoClassesSet ですべての疑似クラスを確認します。

    引数

    names
    readonly string[]

    確認する名前。空の一覧は true を返します。

    戻り値

    boolean

    すべて有効かどうか。

    ソースと継承
  • Rml::Element::Clone で属性・スタイル・内容を複製します。

    戻り値

    null | Element

    所有権付き未接続コピー。失敗時は null。JS リスナーは複製しません。

    ソースと継承
  • 自身を除く祖先を Rml::Element::Closest で検索します。

    引数

    selector
    string

    RCSS セレクター。

    戻り値

    null | Element

    自身を除く最初の一致する祖先。なければ null。

    ソースと継承
  • 自身を含む包含関係を Rml::Element::Contains で検査します。

    引数

    element
    null | Element

    検査する要素、または null。

    戻り値

    boolean

    自身か子孫なら true、null や無関係な要素なら false。

    ソースと継承
  • Rml::Element::DispatchEvent で派生イベントを同期的に送信できます。

    引数

    type
    string | number

    イベント名または登録済みネイティブ EventId。

    parameters
    Readonly<Record<string, VariantValue>> = {}

    ネイティブ Variant のパラメーター。既定値は空。

    optionsオプション

    省略時は上流のイベント仕様の既定値を使用します。

    戻り値

    boolean

    イベントの伝播が継続しているかどうか。

    パラメーターの getter は要素検証前に実行します。対象や参照要素が破棄されたら 例外になります。リスナーではサブツリー置換で要素パラメーターを破棄できません。

    ソースと継承
  • Rml::Element::Focus でフォーカスを要求します。

    引数

    focusVisible
    boolean = false

    focus-visible 表示を有効にするか。既定値 false。

    戻り値

    boolean

    ネイティブのフォーカス要求が成功したか。

    ソースと継承
  • GetAddress で現在の葉から親へ向かうアドレスを生成します。

    引数

    includePseudoClasses
    boolean = false

    疑似クラスを含めるか。既定値は false。

    includeParents
    boolean = true

    祖先のアドレスを含めるか。既定値は true。

    戻り値

    string

    CSS セレクターではないネイティブアドレス文字列。

    ソースと継承
  • 属性を文字列として読み取ります。

    引数

    name
    string

    属性名。

    戻り値

    null | string

    属性値。存在しない場合は null。

    ソースと継承
  • 既定値のネイティブ型で GetAttribute を読み取ります。

    型パラメーター

    引数

    name
    string

    属性名。

    defaultValue

    ネイティブ変換型を選択する null 以外の既定値。

    戻り値

    既定値で初期化したネイティブ変換結果。

    number は double、BigInt は int64、INT64_MAX 超では uint64 です。 危険な数値から整数への変換は例外になります。ベクトルと色はコピーです。 キーなしは既定値です。number 型の無効な数値文字列は atof によりゼロです。

    ソースと継承
  • メインの Rml::Element::GetBox を独立した領域へコピーします。

    戻り値

    書き込み可能なコピー。変更は setBox で適用します。

    ソースと継承
  • 出力オフセットを含む Rml::Element::GetBox(index, offset) のコピー。

    引数

    index
    number

    添字。範囲外ではメインとゼロオフセットを返します。 上流の符号付きオーバーフローを防ぐため INT32_MIN は拒否します。

    戻り値

    独立したボックスとオフセット。

    ソースと継承
  • 自身を含めて GetClosestScrollableContainer を取得します。

    戻り値

    null | Element

    最も近いネイティブスクロールコンテナー。存在しなければ null。

    先に context.update() でスタイルとレイアウトを解決します。auto/scroll は 対象軸の内容が表示領域を超える場合のみ該当し、contain は溢れがなくても該当します。

    ソースと継承
  • 検証付きネイティブモデル索引で Rml::Element::GetDataModel を取得します。

    戻り値

    一意のモデル構築ラッパー。未接続なら null。

    RmlUi が接続したモデルを返します。取り外しやモデル削除で接続が解除され、 返されたモデルの寿命はコンテキストによって管理されます。

    ソースと継承
  • 検証済み要素を既定値にして GetAttribute<ScriptInterface*> を読みます。

    引数

    name
    string

    属性名。

    defaultValue
    null | Element = null

    キーなし・変換失敗時の既定要素。既定は null。

    戻り値

    null | Element

    有効な要素。保存された対象が破棄済みなら null。

    ソースと継承
  • 所属文書内で id により要素を検索します。

    引数

    id
    string

    要素の id。

    戻り値

    null | Element

    一致する要素。存在しない場合は null。

    兄弟を含む所属文書全体を幅優先で検索し、文書がなければ現在の要素から検索します。 #self、#document、#parent も使用できます。 子孫だけの検索には querySelector を使ってください。

    ソースと継承
  • Rml::Element::GetEventDispatcherSummary の診断文字列をコピーします。

    戻り値

    string

    ネイティブのイベント型とリスナー数。登録がなければ空文字列。

    ソースと継承
  • フォーム送信時に使うコントロール名を取得します。

    戻り値

    string

    一意である必要のない送信名。

    ソースと継承
  • 主レイアウトボックスと追加ボックスの総数を取得します。

    戻り値

    number

    メインと追加ボックスの総数。

    ソースと継承
  • Rml::Element::GetNumChildren で子要素を数えます。

    引数

    includeNonDomElements
    boolean = false

    内部要素を含むか。既定値は false。

    戻り値

    number

    ネイティブ子要素数。

    ソースと継承
  • Rml::Element::GetProperty の結果を所有プロパティにコピーします。

    引数

    name
    string | PropertyId

    属性名またはネイティブ ID。

    戻り値

    null | Property

    所有プロパティ。存在しない場合は null。

    継承と既定値を含みます。変数はコンテキスト更新後に解決します。

    ソースと継承
  • ネイティブ型の見本で Rml::Element::GetProperty を読み取ります。

    型パラメーター

    引数

    name
    string

    プロパティ名。

    type

    ネイティブ変換型の見本。

    戻り値

    変換値、またはネイティブ型の既定値。

    継承と既定値を含みます。変数は更新後に解決します。欠落・変換失敗時は T{} を返し、見本の値はフォールバックに使いません。

    ソースと継承
  • メッシュ生成用の Rml::Element::GetRenderBox をコピーします。

    引数

    fillArea
    BoxArea = BoxArea.Padding

    Border、Padding、Content。既定値は Padding。

    index
    number = 0

    添字。既定値はゼロ。範囲外の動作は getBox(index) と同じです。

    戻り値

    独立した描画ボックス値。

    ソースと継承
  • ネイティブ GetScriptObject を呼び、未登録なら null を返します。

    戻り値

    null | object

    登録されたスクリプト、または null。

    ソースと継承
  • 文書のオーバーライドを含む Rml::Element::GetStyleSheet を読み取ります。

    戻り値

    null | StyleSheet

    読み取り専用のコンパイルビュー。シートがなければ null。

    文書の破棄や置換後もコンテナーを保持します。再コンパイルで旧ビューは無効になります。

    ソースと継承
  • この入力型のネイティブ仮想メソッド GetValue を呼びます。

    戻り値

    string

    ネイティブの文字列値。

    ソースと継承
  • NONE 値の属性を含めて HasAttribute を照会します。

    引数

    name
    string

    属性名。

    戻り値

    boolean

    キーが存在するかどうか。

    ソースと継承
  • Rml::Element::InsertBefore で未接続要素の所有権を移します。

    引数

    child

    未接続要素。appendChild と同じ所有権検証を行います。

    adjacent
    null | Element

    基準の子要素。null や子以外なら DOM 末尾に追加します。

    戻り値

    同じ子要素。基準要素の DOM/非 DOM 区分を継承します。

    ソースと継承
  • Rml::Element::IsClass でネイティブ継承関係を確認します。

    引数

    identifier

    このモジュールの RTTI メソッドで取得したトークン。

    戻り値

    boolean

    この要素が指定ネイティブ型またはその派生型に属するか。

    ソースと継承
  • クラスが設定されているかを調べます。

    引数

    className
    string

    クラス名。

    戻り値

    boolean

    クラスが設定されていれば true。

    ソースと継承
  • コントロールに disabled 属性があるかを調べます。

    戻り値

    boolean

    disabled 属性が存在するか。

    ソースと継承
  • ネイティブ仮想メソッド IsSubmitted を呼びます。

    戻り値

    boolean

    型と状態が送信対象か。無効状態の判定は別です。

    ソースと継承
  • IsVisible を呼び出し、必要に応じて祖先も確認します。

    引数

    includeAncestors
    boolean = false

    祖先も検査するか。既定値 false。

    戻り値

    boolean

    ネイティブの可視性結果。

    ソースと継承
  • 一度のネイティブ走査で Rml::Element::IterateLocalProperties をコピーします。

    引数

    filterInheritedBy
    null | Element = null

    この要素が実際に継承する属性のみ。null は絞り込みなし。

    戻り値

    [string, Property][]

    ネイティブ順の名前と属性の組。値は独立した所有コピーです。

    インライン・シート・クラス属性、変数と変数付き略記を含み、ネイティブの 上書きと継承絞り込みに従います。後の変更や要素破棄もコピーには影響しません。

    ソースと継承
  • Rml::Element::Matches で現在の要素を検査します。

    引数

    selector
    string

    RCSS セレクター。

    戻り値

    boolean

    現在の要素が一致するか。

    ソースと継承
  • 有効なイベントで仮想 Rml::Element::ProcessDefaultAction を呼び出します。

    引数

    event

    この要素で実行中のリスナーが受け取ったイベント。

    戻り値

    void

    対象は event.currentTarget と一致する必要があります。段階・引数・伝播状態を維持し、 伝播停止後も動作します。後続の自動動作は取り消しません。手動のみなら中断可能な イベントで stopPropagation を呼びます。逐次呼出しは副作用を繰り返し、同一イベントでの再入は禁止。

    ソースと継承
  • ネイティブの深さ優先順で CSS セレクターに一致する最初の子孫を検索します。

    引数

    selector
    string

    CSS セレクター。

    戻り値

    null | Element

    一致する要素。存在しない場合は null。

    ソースと継承
  • Rml::Element::QuerySelectorAll で子孫のスナップショットを取得します。

    引数

    selector
    string

    RCSS セレクター。

    戻り値

    ネイティブの深さ優先順の有効なラッパー配列。配列の構成は固定です。

    ソースと継承
  • 元の生成器を通して所有する切り離したサブツリーを解放します。

    戻り値

    void

    追加済み・借用・実行中の木は拒否します。同期でネイティブを破棄し、 木に残るすべてのラッパーを無効化します。

    ソースと継承
  • Rml::Element::RemoveChild で子要素の所有権を取得します。

    引数

    child

    取り外す子要素。実行中のネイティブ・イベント対象は拒否します。

    戻り値

    null | Element

    同じ未接続ラッパー。現在の要素の子でなければ null。

    ソースと継承
  • 登録済みのイベントリスナーを解除します。

    引数

    type
    string | number

    イベント名または登録済みネイティブ EventId。

    listener

    登録時と同じコールバック参照。

    capture
    boolean = false

    登録時と同じキャプチャフラグ。既定値は false。

    戻り値

    void

    4 つの登録項目が一致する場合のみ解除し、不一致なら何もしません。

    ソースと継承
  • Rml::Element::ReplaceChild で要素の所有権を移します。

    引数

    child

    未接続の置換要素。appendChild と同じ検証を行います。

    replaced
    null | Element

    既存の子要素。null や子以外なら追加します。

    戻り値

    null | Element

    所有権付きで取り外した要素。追加した場合は null。

    ソースと継承
  • 現在のスタイルとコンテキストで Rml::Element::ResolveLength を呼び出します。

    引数

    value

    ネイティブ数値。長さ以外の単位はゼロを返します。

    戻り値

    number

    ピクセル単位の長さ。無効なフィールドや桁あふれは例外です。

    ソースと継承
  • ネイティブ単位変換を行う Rml::Element::ResolveNumericValue。

    引数

    value

    数値。NUMBER は基準値を乗算、PERCENT は number / 100 を乗算。 角度はラジアン、非数値単位はゼロを返します。

    baseValue
    number

    NUMBER と PERCENT の有限な基準値。

    戻り値

    number

    ネイティブの解決値。無効なフィールドや桁あふれは例外です。

    ソースと継承
  • SetAttributes で属性をマージします。

    引数

    attributes
    Readonly<Record<string, VariantValue>>

    所有される値。全変換後にネイティブ状態を変更します。

    戻り値

    void

    他のキーは保持され、グループ全体で OnAttributeChange を一度呼びます。

    ソースと継承
  • Rml::Element::SetBox へコピーし、追加ボックスを消去します。

    引数

    box

    有限な値。後の変更は要素へ影響しません。

    戻り値

    void

    後続のレイアウト更新は手動設定を上書きする場合があります。

    ソースと継承
  • クラスを追加または削除します。

    引数

    className
    string

    クラス名。

    activate
    boolean

    true で追加、false で削除します。

    戻り値

    void
    ソースと継承
  • SetClassNames でクラス名全体を置き換えます。

    引数

    names
    string

    空白区切りのネイティブクラス名。

    戻り値

    void
    ソースと継承
  • Rml::ElementFormControl::SetDisabled を呼びます。

    引数

    disabled
    boolean

    true は disabled 属性を追加し、false は削除します。

    戻り値

    void
    ソースと継承
  • Rml::ElementFormControl::SetName を呼びます。

    引数

    name
    string

    送信名。

    戻り値

    void
    ソースと継承
  • Rml::Element::SetOffset でネイティブ配置の基準を設定します。

    引数

    offset

    有限のピクセル座標。ネイティブの position 規則を適用します。

    offsetParent
    null | Element

    自身を除く祖先。null は独立した基準です。

    offsetFixed
    boolean = false

    祖先のスクロールを無視。既定値 false。

    戻り値

    void

    次の配置更新で基準が再設定される場合があります。fixed は offsetFixed を 含みます。祖先検証で循環と無効な参照を防ぎ、切り離しで木の外への参照を解除します。

    ソースと継承
  • Rml::Element::SetProperty でローカル RCSS プロパティを設定します。

    引数

    name
    string

    RCSS 文字列には名前、型付き値には PropertyId。

    value
    string

    RCSS 文字列または値コピーする Property。

    戻り値

    boolean

    プロパティを適用できたかどうか。

    ソースと継承
  • Rml::Element::SetProperty でローカル RCSS プロパティを設定します。

    引数

    name

    RCSS 文字列には名前、型付き値には PropertyId。

    value

    RCSS 文字列または値コピーする Property。

    戻り値

    boolean

    プロパティを適用できたかどうか。

    ソースと継承
  • SetPseudoClass でネイティブ疑似クラスを設定します。

    引数

    name
    string

    コロンを含まない疑似クラス名。

    active
    boolean

    有効にするかどうか。

    戻り値

    void
    ソースと継承
  • DOM 所有権を維持し、管理ネイティブスクリプトを登録します。

    引数

    object
    null | object

    ホストオブジェクト。null は関連付けを解除します。

    戻り値

    void

    接続ツリーが保持します。分離した循環は回収でき、複製は null。 ネイティブ RTTI は変わりません。

    ソースと継承
  • 選択肢の準備を含むネイティブ仮想メソッド SetValue を呼びます。

    引数

    value
    string

    ネイティブ入力が解釈する新しい値。

    戻り値

    void
    ソースと継承
  • 抽象入力の値を属性として実装するネイティブ生成器を作ります。

    引数

    valueAttribute
    string = 'value'

    空文字やヌル文字を含まない属性名。

    戻り値

    終了時に無効となる所有ネイティブ ElementInstancer。

    GetValue は属性を文字列として読み、未設定時は空文字。SetValue は同じ属性に 書き込みます。名前・無効状態・フォーカス・IsSubmitted は実際の基底を使います。 値と data-attr 更新は JS 仮想コールバックなしでネイティブ実行します。 JS サブクラスの上書きはネイティブ仮想関数に適用しません。Factory は属性を 設定し、直接 instanceElement は設定しません。入力の直接複製は元の生成器、 属性名と解放通知を保持し、JS 生成コールバックを再実行しません。 祖先の複製は現在の Factory 登録で子孫を再解析します。 Form::Submit の対象タグは input、textarea、select のみです。

    ソースと継承

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0