DefaultTextFlowBox (クラス)
public DefaultTextFlowBox {inherits BasicTextFlowBox}
インポート元: CURL.GUI.STANDARD. package 内で定義されています CURL.GUI.BASE.

{new TextFlowBox} を実行するときに得られる TextFlowBox 実装。

説明

これは典型的な TextFlowBox の実装ですが、他にも特別なパフォーマンス機能を備えた実装があります。
特に、CastTextFlowBox は消費されるメモリ量を最小限に抑える働きがあります。
DefaultTextFlowBox 特有の機能が絶対に必要な場合以外は、TextFlowBox ファクトリーを使うことをお勧めします。これにより、後で他の TextFlowBox サブクラスに簡単に切り替えることができます。

コンストラクタ
clone-appearance-from:このタイプの新しいオブジェクトを作成するために Visual.clone-appearance が使用するコンストラクタ。
コンストラクタ protected {DefaultTextFlowBox.clone-appearance-from
other:DefaultTextFlowBox,
fixup:#{proc-type {Visual, Visual}:Visual}
}
default:このタイプの新しいオブジェクトを作成します。
コンストラクタ public {DefaultTextFlowBox.default ...}

プロパティ
clonable-class?:当該クラスがクローン化可能である場合は、true を返します。その他の場合は false を返します。
アクセサ protected DefaultTextFlowBox.clonable-class?:bool
display-context:このオブジェクトに関連付けられている DisplayContext
非ローカル オプション public DefaultTextFlowBox.display-context:#DisplayContext
last-request-layout-epoch:request-layout が最後に呼び出されたときの Layout Epoch を表す整数。
アクセサ protected DefaultTextFlowBox.last-request-layout-epoch:int
セッター protected DefaultTextFlowBox.last-request-layout-epoch:int
option-register-proc:子オブジェクトが興味を持つ非ローカルオプションに関して、このオブジェクトに通知するために呼び出されるプロシージャ。
アクセサ protected DefaultTextFlowBox.option-register-proc:{proc-type {OptionKey}:void}
registered-option-keys:このオブジェクトおよびその子孫により登録されたオプション キーのリストを返します。
アクセサ public DefaultTextFlowBox.registered-option-keys:{Array-of OptionKey}
プロパティ 継承 BasicTextFlowBox: completely-clonable-children?, text-selectable?
プロパティ 継承 TextFlowBox: color, font-family, font-size, font-style, font-weight, graphical-children, paragraph-after-spacing, paragraph-before-spacing, paragraph-first-line-offset, paragraph-justify, paragraph-left-indent, paragraph-line-spacing, paragraph-right-indent, style-element, text-bottom-margin, text-breakable?, text-left-margin, text-line-through?, text-preserve-whitespace?, text-right-margin, text-top-margin, text-underline?, viewport-width
プロパティ 継承 GetBoundsBox: layout-locally-valid?, layout-valid?
プロパティ 継承 Box: clip-child-shadows?, ordered-children, reverse-ordered-children
プロパティ 継承 Graphic: avoid-page-break?, background, border-color, border-spec, border-style, border-width, cell-border-spec, cell-border-width, cell-margin, discrete-select-in-range?, enabled?, graphic-selectable, height, horigin, is-paginating?, layout, margin, opaque-to-events?, option-parent, outside-margin, pagination-state, parent, possibly-displayed?, selection-context, shadow-color, shadow-spec, visible?, visual-parent, vorigin, width
プロパティ 継承 Visual: _style-element, cursor, data-source, dragee, graphical-parent, has-key-focus?, input-method-enabled?, input-method-keyboard-mode, name, options, style-class, style-manager, style-options, test-child?, test-description, test-name, test-parent?, test-type-name, test-visible?, tooltip, user-data
プロパティ 継承 DataBindingTarget: data-binding-context, data-bindings
プロパティ 継承 EventTarget: event-handlers
プロパティ 継承 OptionListInterface: options-present-here

メソッド
add:BasicTextFlowBox に 1 つ以上の子を追加します。
public {DefaultTextFlowBox.add a:any, ...}:#Visual
clone-appearance-helper:クローンを作成し、クローン自体を返します。
protected {DefaultTextFlowBox.clone-appearance-helper
fixup:#{proc-type {Visual, Visual}:Visual}
}:Visual
notify-option-children:このオブジェクトのオプションの子にオプションが変更されたことを通知します。
public {DefaultTextFlowBox.notify-option-children
item:OptionItem,
removed?:bool
}:void
pick-child:指定された (xy) ポイントをカバーする TextFlowBoxEventForwarder 子孫を返します。
public {DefaultTextFlowBox.pick-child}:#EventForwarder
propagate-request-layout:Box からそのグラフィカルな親 (存在する場合) に新しいレイアウト ネゴシエーションの要求を伝播します。
public {DefaultTextFlowBox.propagate-request-layout epoch:int}:void
register-options:このオブジェクトがバインドのモニタリングを必要とする非ローカル オプション キーを登録します。
public {DefaultTextFlowBox.register-options
p:{proc-type {OptionKey}:void}
}:void
request-pointer-trace:表示されたオブジェクトの幾何形状が変更されていることを宣言し、必要な PointerCrossing イベントの発生を要求します。
public {DefaultTextFlowBox.request-pointer-trace}:void
メソッド 継承 BasicTextFlowBox: calculate-width-preference, clear, constrain-width, draw, draw-range-as-selected, end-pagination, get-composition-width, get-display-context, get-height-preference, get-range-as-selected-text, get-width-preference, make-gui-mark, paginate, search-next-here, search-prev-here, set-size
メソッド 継承 TextFlowBox: find-graphic-at, find-test-children, get-gui-path-to-child, get-text, note-attached, note-detaching
メソッド 継承 BasicBox: contains-point?, handle-crossing, on-pointer-envelope-event, pointer-enter-occurred, pointer-leave-occurred
メソッド 継承 GetBoundsBox: get-bounds, get-elastic-bounds-into, get-nonparent-bounds-into, request-layout, validate-layout
メソッド 継承 Box: compare-children, get-delimited-child-text-selection, get-visible-rect-in-root-into, graphical-child-visible-at
メソッド 継承 Graphic: after-reposition, attempt-revalidate-layout, before-reposition, constrain-height, create-pagination-state, detach, draw-shadow, find-ancestor, find-graphical-ancestor, fire-inferior-crossing-event, get-graphical-root, get-gui-path, get-origin-in-graphical-ancestor, get-origin-in-root, get-pagination-state, get-top-left-in-ancestor, get-visible-bounds-into, on-drag-enter, on-inspection, on-pointer-enter, option-changed, paint-with-decorations, replace-with, request-draw, request-draw-rect, search-next, search-prev, set-layout, start-pagination, xy-offset-to
メソッド 継承 Visual: add-from-init-args, animate, change-cursor, clonable-appearance?, clone-appearance, get-focus-manager, get-layout-context, get-test-parent, get-test-property, get-view, maybe-fire-attach-event, maybe-fire-detach-event, non-keyword-init-arg, note-caret-position, on-drag-leave, on-pointer-leave, pop-cursor, prepare-test-object, prepare-test-parent, push-cursor, quantize-width, refresh-style-options, release-key-focus, request-key-focus, scroll-to-include, test-record, test-run, transform-from-display-coordinates, transform-from-graphical-root-coordinates, transform-to-display-coordinates, transform-to-graphical-root-coordinates
メソッド 継承 GraphicOptions: any-to-Distance
メソッド 継承 GuiEventTarget: handle-delegate-event, handle-event, on-action, on-cancel-mode, on-command-changed, on-commit, on-composition-change-event, on-composition-result-event, on-context-menu-event, on-current-record-change-request, on-current-record-changed, on-destroy-notify, on-destroy-requested, on-drag-over, on-drag-pointer, on-drag-started, on-drop, on-end-composition-event, on-focus-event, on-focus-in, on-focus-out, on-gesture, on-gesture-begin, on-gesture-end, on-gesture-magnify, on-gesture-pan, on-gesture-rotate, on-gesture-swipe, on-gesture-tap, on-gesture-touch, on-grab-release, on-gui-event, on-input-method-event, on-key-event, on-key-press, on-pointer-button, on-pointer-crossing, on-pointer-event, on-pointer-motion, on-pointer-press, on-pointer-release, on-pointer-scroll, on-raw-key-event, on-raw-key-press, on-raw-key-release, on-reset, on-selectable-added, on-selectable-removed, on-selection-changed, on-selection-context-activated, on-selection-context-deactivated, on-selection-event, on-start-composition-event, on-start-event, on-stop-event, on-view-activate, on-view-deactivate, on-window-close, remove-event-handlers-for-event-class
メソッド 継承 DataBindingTarget: add-data-binding, get-data-binding, refresh-data-binding, remove-data-binding, unset-property, update-data-binding, validate-data-binding
メソッド 継承 EventTarget: accepts-event-class?, add-event-handler, event-handler-present?, remove-event-handler, verify-event
メソッド 継承 OptionListInterface: add-option, add-style-option, change-option-parent-notify, clone-options, get-option, get-option-by-name, keyword-init-arg, local-add-notify, local-remove-notify, name-to-option-key, new-option-item, option-change-notify, option-lookup, option-lookup-here, option-propagate-notify, option-set?, propagate-option-change, remove-option, remove-style-option, remove-styles, set-option-by-name, set-style-option-by-name, unset-option-by-name, unset-style-option-by-name
メソッド 継承 BasicEventTarget: enqueue-event
メソッド 継承 InitRestArgParser: process-rest-args
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize



コンストラクタ詳細
clone-appearance-from (コンストラクタ)
protected {DefaultTextFlowBox.clone-appearance-from
other:DefaultTextFlowBox,
fixup:#{proc-type {Visual, Visual}:Visual}
}

このタイプの新しいオブジェクトを作成するために Visual.clone-appearance が使用するコンストラクタ。



default (コンストラクタ)
public {DefaultTextFlowBox.default ...}

このタイプの新しいオブジェクトを作成します。

注意事項

このメソッドは 3 種類の引数を受け取ります。



プロパティ詳細
clonable-class? (アクセサ)
アクセサ protected DefaultTextFlowBox.clonable-class?:bool

当該クラスがクローン化可能である場合は、true を返します。その他の場合は false を返します。

オーバーライド

既定の実装は false を返します。クローン化機能を提供するクラスは、{type-of self} == {compile-time-type-of self} を返すためには、このゲッターをオーバーライドする必要があります。クローン化可能な Visual が必ずしもクローン化可能であるとは限らないので、単に true を返すだけでは正しくありません。
このメソッドをオーバーライドする場合は、Visual.clone-appearance-helper もオーバーライドする必要があります。


display-context (非ローカル オプション)
public DefaultTextFlowBox.display-context:#DisplayContext

このオブジェクトに関連付けられている DisplayContext

プログラミング注意事項

このオプションは、Curl グラフィック システム内での通信のために使用されます。これは、ユーザー コードで不用意に設定や設定解除を行わないでください。また、通常は、ユーザー コードで直接読み取るべきではありません。現在の DisplayContext が必要な場合は、Visual.get-display-context を呼び出すことによりフェッチしてください。

画面上のウィンドウまたは印刷されたページで表示可能なすべてのグラフィック階層は、そのルートにおいて、display-context オプションを DisplayContext オブジェクトに設定するオブジェクトを持つ必要があります。このオブジェクトは、グラフィック階層の表示に使用される表示媒体に適しています。つまり、オブジェクトは、display-context オプションの値が null から非 null DisplayContext オブジェクトに変更されるのをモニタリングすることにより、表示不可能なグラフィック階層に連結されていることを認識します。したがって、特定の動作を実行する必要のある Visual のサブクラスは、表示不可能なグラフィック階層に接続された場合、次のようなオプション宣言を含むことにより display-context オプションをモニタリングします。

{nonlocal-option public display-context:#DisplayContext
change handler}


ここで、change handler 内のコードは display-context オプションの現在値 (変数 display-context の値として、変更ハンドラ内にある) を取得し、null および非 null の値の間で行われる変更をモニタリングし、必要とされる動作を実行します。

ただし、このプログラミング熟語を使用するプログラマーは、グラフィカル表示を再配列する際、グラフィック階層からグラフィカル オブジェクトを一時的に分離し、これらを同じ階層に再アタッチすることが、割に一般的であることを理解するべきです。この処理により、一時的に分離されたオブジェクトは、display-context オブジェクトが null になり、再び非 null になるのを観察します。display-context オプションでの変更をモニタリングするコードは、この可能性を考慮に入れ、この状況における望ましくない動作の実行を回避しなくてはなりません。


last-request-layout-epoch (アクセサ)
アクセサ protected DefaultTextFlowBox.last-request-layout-epoch:int
セッター protected DefaultTextFlowBox.last-request-layout-epoch:int

request-layout が最後に呼び出されたときの Layout Epoch を表す整数。

プログラミング注意事項

この値が LayoutContext.epoch より大きい場合は、レイアウト処理中にレイアウト要求が行われたことを意味します。レイアウト処理が再実行されることになるので、この値を使用して、進行中の処理を完了前に停止することができます。get-layout-epoch も参照してください。

オーバーライド

既定の実装は、-1 を返します。これは、レイアウトが再実行されるかどうかを無視することを示します。サブクラスでエポックをキャッシュする場合は、TextFlowBox.propagate-request-layout をオーバーライドし、キャッシュされた値をここで返します。


option-register-proc (アクセサ)
アクセサ protected DefaultTextFlowBox.option-register-proc:{proc-type {OptionKey}:void}

子オブジェクトが興味を持つ非ローカルオプションに関して、このオブジェクトに通知するために呼び出されるプロシージャ。

プログラミング注意事項

返されたプロシージャは、各オプション子(またはその子孫)が興味を持つ、各非ローカルオプションに対して1回呼び出されます。オプション キーが、このプロシージャを介して登録されていない場合は、オプション値が変更する場合に、このオブジェクトは子孫に対し、(子孫がこのオプションに関心を示していないため)変更ハンドラを呼び出す必要はありません。

特に、返された値が null でない場合は、このオブジェクトが新しいオプション子を入手すると OptionListInterface.change-option-parent-notify がそれを呼び出します。

注意事項

既定では、返されたプロシージャは、そのオプション親に登録を転送します。

オーバーライド

まれですが、典型的には、オプションの伝搬メカニズムをオーバーライドするオブジェクトのみにより、オーバーライドされます。


registered-option-keys (アクセサ)
アクセサ public DefaultTextFlowBox.registered-option-keys:{Array-of OptionKey}

このオブジェクトおよびその子孫により登録されたオプション キーのリストを返します。

戻り値

これらの OptionKeyArray-of

オーバーライド

既定の実装 OptionListInterface.registered-option-keys は、このオブジェクトで OptionListInterface.register-options を呼び出し、その結果得られるオプション キーのセットを収集し、リストとして返します。これはシンプルで正確な方法ですが、あまり効率的ではない場合があります。したがって、サブクラスでもその register-options の実装が非常に複雑な場合は、この既定の実装を使用しないように推奨されます。代わりに、このようなサブクラスでは register-options 呼び出しの結果をリストとしてキャッシュし、このリストを返すだけのメソッドで OptionListInterface.registered-option-keys をオーバーライドする必要があります。





メソッド詳細
add (メソッド)
public {DefaultTextFlowBox.add a:any, ...}:#Visual

BasicTextFlowBox に 1 つ以上の子を追加します。

obj: 追加するオブジェクト。追加される前に Visual に強制変換されます。

注意事項

このメソッドは、2 つのオプション キーワード引数も受け取ります。ただし、どちらか 1 つしか指定できません。どちらも指定されていない場合、新しい子は BasicTextFlowBox に最後のオブジェクトとして追加されます。指定する sibling は、TextFlowBox のトップレベルの直接の子でなければなりません (このメソッドで追加された子などがこれにあたります)。

戻り値

(Visual に強制変換された後) 追加されたオブジェクト。

説明

obj がもともと Visual だった場合は、それまで置かれていた場所から自動的に削除されます。

強制変換が行われる場合は、次の規則に従います。

オーバーライド

子の追加にさらに別の処理を関連付けることができるように、BasicTextFlowBox のサブクラスでオーバーライドできます。この種のオーバーライド メソッドは、以下を呼び出す必要があります。

{super.add obj, ...}

これで、BasicTextFlowBox 自体の追加アクションを呼び出して、提供された任意のキーワード引数を渡します。

注意事項

BasicTextFlowBox に何かを追加しても、パラグラフ、行、または語の境界が自動的に挿入されることは意味しません。

ボタンを押してテキストを末尾に追加します。
例: TextFlowBoxにテキストを追加
{value
    let tfb:TextFlowBox =
        {TextFlowBox
            width = 5cm,
            height = 6cm,
            border-color = "black",
            border-width = .05cm,
            "Initial content"
        }
    let addme:CommandButton =
        {CommandButton
            label="Add more content",
            {on Action do
                {tfb.add "and more"}
            }
        }
    {VBox
        tfb,
        addme
    }
}


clone-appearance-helper (メソッド)
protected {DefaultTextFlowBox.clone-appearance-helper
fixup:#{proc-type {Visual, Visual}:Visual}
}:Visual

クローンを作成し、クローン自体を返します。

オーバーライド

既定の実装はエラーをスローします。クローン化機能を提供するクラスは、
{{compile-time-type-of self}.clone-appearance-from self, fixup}
を返すためには、このゲッターをオーバーライドする必要があります。


notify-option-children (メソッド)
public {DefaultTextFlowBox.notify-option-children
item:OptionItem,
removed?:bool
}:void

このオブジェクトのオプションの子にオプションが変更されたことを通知します。

item: 追加または削除されたバインディング オプション。
removed?: item が削除された場合は true、それ以外の場合は false。

オーバーライド

既定の実装 OptionListInterface.notify-option-children では、何も行われません。サブクラスではこのメソッドをオーバーライドして、このオブジェクトの各オプションの子 c に対して {c.option-propagate-notify item removed? } を呼び出すようにする必要があります。


pick-child (メソッド)
public {DefaultTextFlowBox.pick-child}:#EventForwarder

指定された (xy) ポイントをカバーする TextFlowBoxEventForwarder 子孫を返します。

x, y: ポイントの座標です。

戻り値

このポイントをカバーする EventForwarder 子孫、あるいはそのような子孫が存在しない場合は NULL です。

プログラミング注意事項

このメソッドは、PointerEvent を転送する場合やその他の類似の状況で使用されます。

注意事項

他の Box は、通常このメソッドから Graphic を返しますが、TextFlowBox は返しません。

オーバーライド

サブクラスは、上記の指定に適合する様式で、このメソッドを実装しなければなりません。


propagate-request-layout (メソッド)
public {DefaultTextFlowBox.propagate-request-layout epoch:int}:void

Box からそのグラフィカルな親 (存在する場合) に新しいレイアウト ネゴシエーションの要求を伝播します。

epoch: このレイアウト無効化に関連付けられている Layout Epoch。これは、通常、get-layout-epoch を使用して得られる現在の Layout Epoch です。

プログラミング注意事項

一般的に、このメソッドは、Box.request-layout から Box の親にレイアウトの要求を伝えるために呼び出されるか、Layout.request-layout から呼び出されます。

Box でこのメソッドを呼び出すことは、Box のグラフィカルな子孫のいずれかが新しいレイアウト ネゴシエーションを要求していることを示します。この状況は、Box での Box.request-layout の呼び出しとは対照的です。この場合は、Box 自体が新しいレイアウト ネゴシエーションを要求していることを意味します。これらの 2 つの別個のメソッドが提供されるのは、その後のレイアウト ネゴシエーションの初めに Graphic.attempt-revalidate-layout が呼び出されるときに、異なるアクションを保証するためです。Box.propagate-request-layout の呼び出しによって、この Box にレイアウト要求が通知された場合は、Box 自体では何も変更されていないので、Box の子で Graphic.attempt-revalidate-layout メソッドが呼び出されたときにすべての子の答えが true であれば、BoxGraphic.attempt-revalidate-layout に対する答えは常に true になります。しかし、Box.request-layout が呼び出された場合は、Box は、そのすべての子のレイアウトについて有効性を再検証できたとしても、それ自体のレイアウトが有効とは認められない場合があります。これは、グラフィカルな子の追加や削除、またはそれらの子の空白や配列での変更など、Box 自体の構造で変更が加えられている可能性があるからです。

オーバーライド

このメソッドは、情報を保持してレイアウト無効化を追跡する Box サブクラスでオーバーライドできます。このようなオーバーライド メソッドにはすべて super.propagate-request-layout の呼び出しが必要です。このメソッドは、グラフィック階層のルートになるように設計されている View などのクラスでもオーバーライドされます。この場合、レイアウト要求を記録し、新しいレイアウト ネゴシエーションに合わせて整列させるコードによってメソッドがオーバーライドされます。


register-options (メソッド)
public {DefaultTextFlowBox.register-options
p:{proc-type {OptionKey}:void}
}:void

このオブジェクトがバインドのモニタリングを必要とする非ローカル オプション キーを登録します。

p: 引数として OptionKey を使用して呼び出せるプロシージャ。

プログラミング注意事項

このメソッドは、オブジェクトがモニタしているオプション キーを確認する必要がある場合に任意のコード内で呼び出されます。このメソッドは、プロシージャ p をまったく呼び出さないかまたは何回か呼び出し、呼び出すたびに引数として OptionKey を渡す必要があります。このオブジェクトによりモニタリングされるオプション キーのセットは、p のすべての呼び出しで指定されたオプション キー セットの連結であると見なされます。p を複数回呼び出せるという能力を利用して、オプション親はモニタの対象となるオプション キーのリストを指定して p を一度呼び出し、次に、同じ引数 p を与えてオプションの子それぞれの register-options メソッドを呼び出し、このメソッドの目的を果たすことができます。この方法はシンプルですが、ほとんどの場合は、オプション親がその子における register-options 呼び出しの結果をキャッシュして、親の register-options メソッドが呼び出されたときにそのリストを提供する方がより効率的です。ローカル バインディング オプションへの変更通知は、それらのキーが登録されていない場合でも行われます。

オーバーライド

OptionListInterface.register-options の既定の実装は、このオブジェクトの変更ハンドラを持つ各非ローカル オプションで p を呼び出します。サブクラスは、{super.register-options p} を呼び出し、登録される必要がある追加のオプション キー上全てで、p を呼び出すように、このメソッドをオーバーライドする必要する必要があります。一般的に、これらの追加のオプション キーは、子供または子孫のオブジェクトが監視する必要がある非ローカル オプションに対応します。それは、このオブジェクトの子オブジェクト上で、register-options を呼び出すことによって決定されます。
注意 一般的に、このメソッドをオーバーライドする必要があるオブジェクトだけが、オプションの子を持つオブジェクトです。


request-pointer-trace (メソッド)
public {DefaultTextFlowBox.request-pointer-trace}:void

表示されたオブジェクトの幾何形状が変更されていることを宣言し、必要な PointerCrossing イベントの発生を要求します。

説明

要求は、このオブジェクトのグラフィック階層のルートに到達するまでグラフィカルな祖先のチェイン上を転送されていきます。このルートが View で、ポインタがその View 内にある場合、PointerNonevent を含む PointerEnvelopeEvent が発生し、必要な PointerCrossing イベントの生成を引き起こします。

オーバーライド

ポイント (x,y) を含む子オブジェクトの識別に (x,y) の位置をマップする、キャッシュされた状態を格納する SequenceBox のようなサブクラスによってオーバーライドできます。こうした状態はリセットして、グラフィック階層のオブジェクトの幾何形状が変更されても新しい PointerEnvelopeEvent が適切に送信されるようにします。このメソッドをオーバーライドする場合、オーバーライド メソッドには以下の呼び出しを含めます。

{super.request-pointer-trace}