Frame (クラス)
public Frame {inherits BaseFrame}
インポート元： CURL.GUI.STANDARD. package 内で定義されています CURL.GUI.BASE.
直接継承しているサブクラス: Thumb, CalendarControlDayFrame, Knob, StandardActiveTraversalContainer, SkinnableControlFrame, SkinnableFrame, CollapseFrame, Pane, ClipFrame, AntialiasedFrame, ExposeFrame, Label, TraceFrame, ViewportBox, Viewport, RootFrame, GuiRangeSelectionFrame, DiscreteGraphicSelectionFrame, SliderUI, SpinControlUI, RecordGridUI, ScrollbarUI, ProgressBarUI, ComboBoxUI, DropdownListUI, CalendarControlUI, DateFieldUI, TreeControlUI, MenuPaneUI, BaseTextControlUI, DefaultFrameTreeIcon, BaseButtonUI, SelectableItem, MenuBarUI, ListBoxUI, GroupBoxUI, MenuButtonUI, BaseTabControlUI, TextDisplayUI

1 つの子 Graphic を保持するか、または 1 つも保持していないコンテナ。

説明

Frame は、グラフィカルな子を 1 つ持っているか、またはまったく持っていません。Frame は、Graphic 自体にオプションを設定しないで、Graphic の周囲にボーダーまたはマージンを配置したり、Graphic に影響するその他の非ローカル オプションを設定するのに便利です。また、Frame は、グラフィック階層内の同じ位置を占有しながら、一連の異なるオブジェクトをそのグラフィカルな子として保持するホルダーとして使用することもできます。

View と ScrollBox は Frame の重要なサブクラスです。

注意事項

このオブジェクトは、"Frame"のスタイル ルールを記述することによりスタイル化することが出来ます。

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

プロパティ
clonable-class?:当該クラスがクローン化可能である場合は、true を返します。その他の場合は false を返します。
アクセサ protected Frame.clonable-class?:bool
halign:Frame 内の子オブジェクトを水平方向で配置する方法を指定します。
ローカル オプション public Frame.halign:any ="origin"
halign-spec:レイアウトで使用される halign 値を提供します。
アクセサ protected Frame.halign-spec:any
hstretch?:Frame が、固定の子オブジェクトを強制的に伸張するかどうかを制御します。
ローカル オプション public Frame.hstretch?:bool =false
hstretch?-spec:レイアウトで使用される hstretch? 値 (BaseFrame の場合は true) を提供します。
アクセサ protected Frame.hstretch?-spec:bool
style-element:スタイリングの目的のための、この Visual の "要素" や "型" です。
アクセサ public Frame.style-element:String
valign:Frame の垂直方向の起点をその子オブジェクトからどのように計算するかを指定します。
ローカル オプション public Frame.valign:any ="origin"
valign-spec:レイアウト処理で使用される valign 値を提供します。
アクセサ protected Frame.valign-spec:any
vstretch?:Frame が固定の子オブジェクトの周りに垂直方向のパディングを配置するかどうかを制御します。
ローカル オプション public Frame.vstretch?:bool =false
vstretch?-spec:レイアウト処理で使用される vstretch? 値 (BaseFrame の場合は true) を提供します。
アクセサ protected Frame.vstretch?-spec:bool
プロパティ 継承 BaseFrame: child, completely-clonable-children?, graphical-children, ordered-children, reverse-ordered-children, width-first?
プロパティ 継承 GetBoundsBox: layout-locally-valid?, layout-valid?
プロパティ 継承 Box: clip-child-shadows?
プロパティ 継承 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?, display-context, 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, font-size, 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: option-register-proc, options-present-here, registered-option-keys

メソッド
add:Frame に子アイテムを追加します。
public {Frame.add g:any, ...}:#Visual
clone-appearance-helper:クローンを作成し、クローン自体を返します。
protected {Frame.clone-appearance-helper
fixup:#{proc-type {Visual, Visual}:Visual}
}:Visual
remove-child:Frame の子を削除します。
public {Frame.remove-child}:void
メソッド 継承 BaseFrame: add-internal, after-reposition, allocate-layout-object, attempt-revalidate-layout, before-reposition, compute-child-bounds, compute-parent-elastic, constrain-height, constrain-width, draw, end-pagination, get-height-preference, get-text, get-width-preference, install-child-bounds, internal-remove-child, note-attached, note-detaching, notify-option-children, paginate, pick-child, propagate-request-layout, register-options, set-size
メソッド 継承 BasicBox: contains-point?, find-graphic-at, 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: clear, compare-children, find-test-children, get-delimited-child-text-selection, get-gui-path-to-child, get-range-as-selected-text, get-visible-rect-in-root-into, graphical-child-visible-at, make-gui-mark, search-next-here, search-prev-here
メソッド 継承 Graphic: create-pagination-state, detach, draw-range-as-selected, 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, request-pointer-trace, 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, get-display-context
メソッド 継承 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 {Frame.clone-appearance-from
other:Frame,
fixup:#{proc-type {Visual, Visual}:Visual}
}

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

other: クローンする Frame。
fixup: other に子が 1 つある場合は、その子のクローンを作成するとき、このプロシージャが Visual.clone-appearance に渡されます。

注意事項

クローン化をサポートする Frame のサブクラスには、このコンストラクタを呼び出すコンストラクタが必要です。ただし、これらのコンストラクタがそれぞれ自身のオプションをクローン化し、それぞれの子を、クローンに追加する前にクローン化する場合は、その限りではありません。

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

Frame 型の新しいオブジェクトを作成します。

注意事項

このメソッドに指定可能な引数は、次の 3 つのタイプです。


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

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

オーバーライド

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

halign (ローカル オプション)
public Frame.halign:any ="origin"

Frame 内の子オブジェクトを水平方向で配置する方法を指定します。

説明

Frame は、その内側起点を基準にして子を水平に配置します。Frame の内側起点は、子の外側起点によって決定されます。このとき、Frame.horigin オプションと Frame.vorigin オプションの設定が Frame.halign および Frame.valign と連携し、最終的な配置が決まります。halign の有効な値は、以下のとおりです。

例

次の例は、パディングが必要な Frame とパディングが必要でない halign で、halign プロパティに異なる値を指定した場合の動作を示しています。


例
{VBox
    spacing=3pt,
    halign="origin",
    {Frame background="red", {RectangleGraphic height=18pt, width=24pt}},
    {Frame
        background="red",
        halign="right",
        {RectangleGraphic height=18pt, width=24pt}},
    {Frame
        background="red",
        width=2in,
        halign="left",
        {RectangleGraphic height=18pt, width=24pt}},
    {Frame
        background="red",
        width=2in,
        halign="center",
        {RectangleGraphic height=18pt, width=24pt}},
    {Frame
        background="red",
        width=2in,
        halign="right",
        {RectangleGraphic height=18pt, width=24pt}},
    {Frame
        background="red",
        width=2in,
        halign="origin",
        {RectangleGraphic height=18pt, width=24pt}},
    {Frame
        background="red",
        width=2in,
        halign="origin",
        {RectangleGraphic height=18pt, width=24pt, horigin="center"}}}

halign-spec (アクセサ)
アクセサ protected Frame.halign-spec:any

レイアウトで使用される halign 値を提供します。

説明

null の場合は原点に合わせて整列されます。それ以外の場合、この値は 0 (左揃え) ～ 1 (右揃え) の数になります。

オーバーライド

既定の実装は、原点に合わせた整列を指定する null を返します。異なる値を指定 (または計算) するように、派生クラスでオーバーライドできます。

hstretch? (ローカル オプション)
public Frame.hstretch?:bool =false

Frame が、固定の子オブジェクトを強制的に伸張するかどうかを制御します。

説明

このオプションの既定値は、false です。既定の動作は次のとおりです。

このオプションを true に設定した場合、Frame の子はその伸張順位に関係なく強制的に伸張され、Frame 内を埋め尽くします。

これらの計算の最終的な結果、既定では、Frame は TextFlowBox や TextFlowBox よりされに固定されたオブジェクトを伸張しません。次の例を参照してください。


例
{VBox
    spacing=3pt,
    {paragraph Rigid child, hstretch?=false},
    {Frame
        background="red",
        width=2in,
        {RectangleGraphic
            height=18pt, width=24pt}
    },

    {paragraph High stretch order child, hstretch?=false},
    {Frame
        background="red",
        width=2in,
        {RectangleGraphic
            height=18pt, width={make-elastic
                                   preferred-size=24pt,
                                   stretch-order=30}
        }
    },

    {paragraph Rigid child, hstretch?=true},
    {Frame
        background="red",
        width=2in,
        hstretch?=true,
        {RectangleGraphic height=18pt, width=24pt}
    },

    {paragraph High stretch order child, hstretch?=true},
    {Frame
        background="red",
        width=2in,
        hstretch?=true,
        {RectangleGraphic
            height=18pt, width={make-elastic
                                   preferred-size=24pt,
                                   stretch-order=30}
        }
    },

    {paragraph TextFlowBox, hstretch?=false},
    {Frame
        background="red",
        width=2in,
        {TextFlowBox background="yellow", {bold Hi there!}}},
    {paragraph TextFlowBox, hstretch?=true},
    {Frame
        background="red",
        width=2in,
        hstretch?=true,
        {TextFlowBox background="yellow", {bold Hi there!}}}
}

hstretch?-spec (アクセサ)
アクセサ protected Frame.hstretch?-spec:bool

レイアウトで使用される hstretch? 値 (BaseFrame の場合は true) を提供します。

オーバーライド

異なる値を指定 (または計算) するように、派生クラスでオーバーライドできます。

style-element (アクセサ)
アクセサ public Frame.style-element:String

スタイリングの目的のための、この Visual の "要素" や "型" です。

説明

この実装によって Visual._style-elementの値が返されますが、通常は定数を返すためにオーバーライドされます。

オーバーライド

Visual のサブクラスのスタイルが他のオブジェクトと異なる場合、このゲッターは適切な文字列を返すようにオーバーライドされる必要があります。 慣例では,この文字列はクラス名または、オブジェクトを生成するマークアップの名前です。
オーバーライドでは、空の文字列でないかぎり、self._style-elementを返さなければなりません。
導入: バージョン 6.0

valign (ローカル オプション)
public Frame.valign:any ="origin"

Frame の垂直方向の起点をその子オブジェクトからどのように計算するかを指定します。

説明

このオプションに指定可能な値は、"origin"、"top"、"center"、"bottom" です。Frame.halign に対して指定可能な値 "origin"、"left"、"center"、"right" ではありません。詳細については、Frame.halign を参照してください。

valign-spec (アクセサ)
アクセサ protected Frame.valign-spec:any

レイアウト処理で使用される valign 値を提供します。

説明

null の場合は原点に合わせて整列されます。それ以外の場合、この値は 0 (上揃え) ～ 1 (下揃え) の数になります。

オーバーライド

既定の実装は、原点に合わせた整列を指定する null を返します。異なる値を指定 (または計算) するように、派生クラスでオーバーライドできます。

vstretch? (ローカル オプション)
public Frame.vstretch?:bool =false

Frame が固定の子オブジェクトの周りに垂直方向のパディングを配置するかどうかを制御します。

説明

このオプションは Frame.hstretch? オプションに似ていますが、操作が水平方向ではなく垂直方向である点が異なります。

vstretch?-spec (アクセサ)
アクセサ protected Frame.vstretch?-spec:bool

レイアウト処理で使用される vstretch? 値 (BaseFrame の場合は true) を提供します。

オーバーライド

異なる値を指定 (または計算) するように、派生クラスでオーバーライドできます。




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

Frame に子アイテムを追加します。

g: 追加するアイテム。g が Graphic でない場合、g は Graphic に強制変換され、変換された結果が追加されます。

注意事項

Frame.add にはキーワード パラメータ replace? もあります。replace? が true の場合、Frameが直前に保持していた子があれば、それが g に置き換えられます。replace? が false (既定) の場合、子を保持している Frame でこのメソッドを呼び出そうとするとエラーが発生します。

戻り値

追加された実際の値。追加された Graphic のサブタイプになります。

オーバーライド

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

{super.add g, ...}

これで、Frame 自体の追加アクションを呼び出し、replace? 引数が指定されている場合は、この引数とともに渡します。

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

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

オーバーライド

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

remove-child (メソッド)
public {Frame.remove-child}:void

Frame の子を削除します。

オーバーライド

子が Frame から切り離されたときにサブクラスで別の記録処理を実行する場合、または最初にこのメソッドを呼び出す場合、Frame のサブクラスでオーバーライドできます。