ListBox (クラス)
public ListBox {inherits MultipleSelectionControl, ListModelControl, {MultiUIValueControlFrame-of any}}
インポート元： CURL.GUI.STANDARD. package 内で定義されています CURL.GUI.CONTROL-LOGICAL.

ListBox は、スクロール可能なボックスにアイテムのリストを含むコントロールです。ユーザーとの対話を介して 1 つ以上のアイテムが選択されると、プログラムは選択されたアイテムを取得することができます。

予期されたイベント

ValueChanged: ユーザーがマウスボタンを押してコントロールの値の変更を開始したとき、ユーザーが入力したとき、または名前に -with-events がついたメソッドのいずれかか呼び出されたときに発生します。
ValueFinished: ValueChanged の後でユーザー操作の完了を示すために発生することがあります。ユーザーがマウス ボタンを離したとき、キーが入力されたとき、または名前に -with-events がついたメソッドのいずれかが呼び出されたときに発生します。
Action: ユーザーがアイテムをダブルクリックしたとき、または ListBox にキーフォーカスがあり、ユーザーが Enter キーを押したときに発生します。

注意事項

クリックのようなユーザアクションで選択することができる縦にスクロール可能な SelectableItem のリストです。
このオブジェクトは、"ListBox"のスタイル ルールを記述することによってスタイル化することが出来ます。詳細は スキンが適用されたリストコントロール をご覧下さい。

ビジュアル テスト

このクラスは、CurlList ビジュアル テスト タイプを実装します。
アイテムは、名前またはインデックスで参照できます。
すべての Visual によってサポートされる既定のビジュアル テスト アクションの他に、このクラスのオブジェクトは次のアクションをサポートします。
アクション 引数 説明
Activate item:Stringコントロール内のアイテムをアクティブにします。
AddRange from:String, to:Stringfrom から to までのアイテムを選択済みアイテムのセットに追加します。
Deselect item:Stringコントロール内のアイテムの選択を解除します。
DeselectRange from:String, to:Stringfrom から to までのアイテムを選択済みアイテムのセットから削除します。
ExtendRange item:String選択を、item アイテムが含まれるように拡張します。
Select item:Stringコントロール内のアイテムを選択します。
SelectRange from:String, to:String一定範囲のアイテムを選択します。
すべての Visual によってサポートされる既定のビジュアル テスト プロパティの他に、このクラスのオブジェクトは次のビジュアル テスト プロパティをサポートします。
プロパティ 説明
items count:int選択対象のアイテムの数です。
value:String コントロールの現在値です。

コンストラクタ
default:このオブジェクトを作成します。
コンストラクタ public {ListBox.default
value:any = null,
data-model:ListModel = {DefaultListModel},
list-item-creation-proc:{proc-type {val:any}:ListItem} = ListModelControl.default-list-item-creation-proc,
selection-policy:SelectionPolicy = SelectionPolicy.multiple,
style:ListBoxStyle = ListBoxStyle.standard,
ui-object:#ListBoxUI = null,
...
}

プロパティ
form-value:ListBox の値は、このコントロールを含む HttpForm が送信されるときに送信されます。
アクセサ public ListBox.form-value:any
has-value?:この Control は値を持っているかどうかを示します。
アクセサ public ListBox.has-value?:bool
pending-value?:ユーザーが項目を選択中である場合は True。そうでない場合は false。
フィールド public-get protected-set ListBox.pending-value?:bool
selected-count:現在選択されているアイテム数。
フィールド protected ListBox.selected-count:int =0
selected-indices:選択されたすべてのアイテムのインデックスの反復子。
アクセサ public ListBox.selected-indices:{Iterator-of int}
selected-item-count:現在選択されているアイテム数を返します。
アクセサ public ListBox.selected-item-count:int
selected-items:selected? フィールドが true である各 SelectableItem の反復子。
アクセサ public ListBox.selected-items:{Iterator-of SelectableItem}
selection-policy:このコントロールが使用する SelectionPolicy。
アクセサ public ListBox.selection-policy:SelectionPolicy
セッター public ListBox.selection-policy:SelectionPolicy
style:ListBox のビジュアル スタイル。
アクセサ public ListBox.style:ListBoxStyle
セッター public ListBox.style:ListBoxStyle
style-element:スタイリングの目的のための、この Visual の "要素" や "型" です。
アクセサ public ListBox.style-element:String
test-type-name:このオブジェクトをテストのメソッドとプロパティにマッピングするために、ビジュアル テスト インフラストラクチャが使用するタイプ名。
アクセサ public ListBox.test-type-name:#String
value:このコントロールの値。
アクセサ public ListBox.value:any
セッター public ListBox.value:any
プロパティ 継承 ListModelControl: data-model, for-loop-count, items, list-item-creation-proc, list-item-selected-background, list-item-selected-foreground, list-items, size
プロパティ 継承 MultiUIControlFrame: _ui-object, _ui-set-locally?, control-appearance-changeable?, display-context, focus-object, look-and-feel, options-present-here, ui-object
プロパティ 継承 ValueControl-of: value-as-any, value-type
プロパティ 継承 ControlFrame: color, control-color, control-content-background, enabled?, font-family, font-size, font-style, font-weight, text-breakable?, text-line-through?, text-preserve-whitespace?, text-underline?, visible?
プロパティ 継承 BaseFrame: child, clonable-class?, completely-clonable-children?, graphical-children, halign-spec, hstretch?-spec, ordered-children, reverse-ordered-children, valign-spec, vstretch?-spec, width-first?
プロパティ 継承 CommandBinding: bound-command, bound-command-impl
プロパティ 継承 Control: control-container, dialog, focus-skin, form, skin
プロパティ 継承 ActiveTraversor: _active-traversal-container, active-traversal-container, mnemonic, tab-index, takes-focus?, valid?, validation-result
プロパティ 継承 GetBoundsBox: layout-locally-valid?, layout-valid?
プロパティ 継承 EventTarget: event-handlers
プロパティ 継承 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-visible?, tooltip, user-data
プロパティ 継承 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?, 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, visual-parent, vorigin, width
プロパティ 継承 DataBindingTarget: data-binding-context, data-bindings
プロパティ 継承 OptionListInterface: option-register-proc, registered-option-keys

メソッド
add-from-init-args:この Visual のコンストラクタに渡されるオブジェクトを Visual の内容に追加します。
protected {ListBox.add-from-init-args a:any}:void
add-selected-index:インデックスが i のアイテムを選択します。
public {ListBox.add-selected-index i:int}:void
create-default-ui-object:このオブジェクトに適切な UI オブジェクトを作成します。
protected {ListBox.create-default-ui-object}:ControlUI
deselect-all-items:このコントロールのすべてのアイテムを選択解除します。
public {ListBox.deselect-all-items}:void
fire-value-changed:この ListBox の ValueChanged イベントをキューに入れます。このイベントは、現在のイベントが処理された後に送信されます。
public {ListBox.fire-value-changed}:void
fire-value-finished:このオブジェクトの ValueFinished イベントをキューに入れます。このイベントは、現在のイベントが処理された後に送信されます。
public {ListBox.fire-value-finished}:void
get-test-property:このオブジェクトのテスト プロパティ値を返します。
public {ListBox.get-test-property name:String}:any
notify-interval-added:新しい値が追加されたときにデータ モデルによって呼び出されるメソッド。
public {ListBox.notify-interval-added
lower:int,
upper:int,
item:#ListItem = null
}:void
notify-interval-changed:値が変更されたときにデータ モデルによって呼び出されるメソッド。
public {ListBox.notify-interval-changed
lower:int,
upper:int,
item:#ListItem = null
}:void
notify-interval-removed:値が削除されたときにデータ モデルによって呼び出されるメソッド。
public {ListBox.notify-interval-removed lower:int, upper:int}:void
notify-item-selected:選択状態が変化したことを通知するために ListItem によって呼び出されます。
public {ListBox.notify-item-selected item:ListItem}:void
rebuild-from-data-model:データ モデルの値で ListItem を再作成します。
public {ListBox.rebuild-from-data-model}:void
remove-selected-index:インデックスが i のアイテムの選択を解除します。
public {ListBox.remove-selected-index i:int}:void
select-all-items:このコントロール内のすべてのアイテムの selected? フィールドを true に設定します。
public {ListBox.select-all-items}:void
select-index:1 つのインデックスを選択し、選択されているほかのインデックスをすべて解除します。
public {ListBox.select-index i:int}:void
select-index-with-events:1 つのインデックスを選択します。選択されているほかのインデックスはすべて解除され、ValueChanged イベントと ValueFinished イベントが発生します。
public {ListBox.select-index-with-events i:int}:void
select-indices-with-events:指定された反復子によって返されるインデックスを選択し、イベントを発生させます。
public {ListBox.select-indices-with-events
indices:{Iterator-of int}
}:void
set-value-with-events:v に値を設定し、ValueChanged (該当する場合) および ValueFinished イベントを発生させます。
public {ListBox.set-value-with-events v:any}:void
test-run:オブジェクトに対してビジュアル テスト アクションを実行します。
public {ListBox.test-run action:String, args:FastArray}:any
unset-value:値をコントロールの既定値に戻すか、初期化されていない状態があればその状態に戻します。
public {ListBox.unset-value}:void
メソッド 継承 ListModelControl: append, clear-items, find, get, insert, remove, set
メソッド 継承 MultiUIValueControlFrame-of: unset-property
メソッド 継承 MultiUIControlFrame: generate-ui-object, handle-look-and-feel-change, handle-observer-message, on-focus-in, option-changed, option-lookup-here, option-propagate-notify, react-to-state-change, react-to-visual-change, request-key-focus, set-layout
メソッド 継承 ControlFrame: become-active, clear
メソッド 継承 BaseFrame: add-internal, after-reposition, allocate-layout-object, attempt-revalidate-layout, before-reposition, clone-appearance-helper, 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
メソッド 継承 Control: on-pointer-press
メソッド 継承 BasicBox: contains-point?, find-graphic-at, handle-crossing, on-pointer-envelope-event, pointer-enter-occurred, pointer-leave-occurred
メソッド 継承 StandardActiveTraversor: become-active-from-traversal, fire-event-at-container, handle-mnemonic, on-key-press
メソッド 継承 Observer: observe, stop-observing
メソッド 継承 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-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-pointer-button, on-pointer-crossing, on-pointer-event, on-pointer-motion, 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
メソッド 継承 ActiveTraversor: mark-invalid, mark-valid
メソッド 継承 GetBoundsBox: get-bounds, get-elastic-bounds-into, get-nonparent-bounds-into, request-layout, validate-layout
メソッド 継承 EventTarget: accepts-event-class?, add-event-handler, event-handler-present?, remove-event-handler, verify-event
メソッド 継承 Visual: add, animate, change-cursor, clonable-appearance?, clone-appearance, get-focus-manager, get-layout-context, get-test-parent, 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, scroll-to-include, test-record, transform-from-display-coordinates, transform-from-graphical-root-coordinates, transform-to-display-coordinates, transform-to-graphical-root-coordinates
メソッド 継承 Box: 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
メソッド 継承 BasicEventTarget: enqueue-event
メソッド 継承 GraphicOptions: any-to-Distance, get-display-context
メソッド 継承 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, paint-with-decorations, replace-with, request-draw, request-draw-rect, request-pointer-trace, search-next, search-prev, start-pagination, xy-offset-to
メソッド 継承 DataBindingTarget: add-data-binding, get-data-binding, refresh-data-binding, remove-data-binding, update-data-binding, validate-data-binding
メソッド 継承 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-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
メソッド 継承 InitRestArgParser: process-rest-args
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize



コンストラクタ詳細
default (コンストラクタ)
public {ListBox.default
value:any = null,
data-model:ListModel = {DefaultListModel},
list-item-creation-proc:{proc-type {val:any}:ListItem} = ListModelControl.default-list-item-creation-proc,
selection-policy:SelectionPolicy = SelectionPolicy.multiple,
style:ListBoxStyle = ListBoxStyle.standard,
ui-object:#ListBoxUI = null,
...
}

このオブジェクトを作成します。

value: ListBox.value を参照してください。
data-model: ListBox.data-model を参照してください。
list-item-creation-proc: ListBox.list-item-creation-proc を参照してください。
selection-policy: ListBox.selection-policy を参照してください。
style: ListBox.style を参照してください。
ui-object: このコントロールが使用する特定の ListBoxUI。詳細については、ListBox.ui-object を参照してください。
...: 追加オプションの仕様とイベント ハンドラ。

例


例
{value
    {let listbox:ListBox =
        {ListBox
            height = 1.0in,
            "Aardvark", "Cat", "Dog", "Elephant", "Gnu", "Zebra"
        }
    }
    let selected:StringArray = {StringArray "Cat", "Zebra"}
    set listbox.value = {selected.to-Iterator}
    listbox
}


プロパティ詳細
form-value (アクセサ)
アクセサ public ListBox.form-value:any

ListBox の値は、このコントロールを含む HttpForm が送信されるときに送信されます。

説明

ListBox で項目が選択されていないと、戻り値は null になります。項目が選択されていると、戻り値は、ValueControl.form-string proc を使用して String に変換された各選択済み項目からなる String の配列になります。

has-value? (アクセサ)
アクセサ public ListBox.has-value?:bool

この Control は値を持っているかどうかを示します。

説明

ValueControl は通常はこのゲッターに true を返し、これはこのメソッドの既定の実装になります。ただし特定のタイプの ValueControl は false を返して、最初の値のない状態にあることを示します。

たとえば、TextField と ComboBox はそれらの値がプログラミングで、またはインタラクティブに設定されておらず、プロンプト を示している場合に false を返します。

RadioButton が選択されていない RadioFrame も false を返す必要があります。

一方、RadioButton や CheckButton などの多くのコントロールは、そのような初期化されていない状態ではないため、つねに true を返します。

has-value? が false のときに ValueControl.value-as-any ゲッターが返す値はクラスに依存することに注意してください。詳細については、各クラスのドキュメントを参照してください。

pending-value? (フィールド)
public-get protected-set ListBox.pending-value?:bool

ユーザーが項目を選択中である場合は True。そうでない場合は false。

説明

pending-value? が true の間、値プロパティは使用可能ですが、すぐに変わる可能性があります。正確には、ValueChanged イベントが送信される直前に、異なる選択がマウスでロールオーバーされると、pending-value? は true に設定されます。ValueFinished イベントが送信される直前に、選択したアイテム上でマウスを離すと、false に設定されます。このプロパティは読み取り専用です。

selected-count (フィールド)
protected ListBox.selected-count:int =0

現在選択されているアイテム数。

説明

この値は、ListBox.notify-item-selected、ListBox.notify-interval-changed および ListBox.notify-interval-removed によって更新されます。

通常、サブクラスでこれ以外の値は設定しないでください。

selected-indices (アクセサ)
アクセサ public ListBox.selected-indices:{Iterator-of int}

選択されたすべてのアイテムのインデックスの反復子。


selected-item-count (アクセサ)
アクセサ public ListBox.selected-item-count:int

現在選択されているアイテム数を返します。


selected-items (アクセサ)
アクセサ public ListBox.selected-items:{Iterator-of SelectableItem}

selected? フィールドが true である各 SelectableItem の反復子。


selection-policy (アクセサ)
アクセサ public ListBox.selection-policy:SelectionPolicy
セッター public ListBox.selection-policy:SelectionPolicy

このコントロールが使用する SelectionPolicy。

説明

このプロパティで有効な設定の詳細については、SelectionPolicy を参照してください。
このプロパティの値は、コントロールがサポートする必要のある選択操作を決定します。
このポリシーに反する項目の選択をプログラムによって行おうとすると、エラーが発生します。

style (アクセサ)
アクセサ public ListBox.style:ListBoxStyle
セッター public ListBox.style:ListBoxStyle

ListBox のビジュアル スタイル。

説明

このプロパティにより、ListBox の動作および描画方式を設定できます。このプロパティは以下の値に設定できます。

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

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

説明

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

オーバーライド

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

test-type-name (アクセサ)
アクセサ public ListBox.test-type-name:#String

このオブジェクトをテストのメソッドとプロパティにマッピングするために、ビジュアル テスト インフラストラクチャが使用するタイプ名。

説明

ビジュアル テストを正しく実行するには、テストは次のいずれかのタイプでなければなりません。特定のテスト タイプの詳細については、リストされている実装例の test-run および get-test-property メソッドの説明を参照してください。
オブジェクトのセマンティクスに近い、いずれかの定義済みテスト タイプの使用を検討してください。ただし、テスト タイプを変更せずにオブジェクトにテストのアクションとプロパティを追加する方が簡単な場合もあります。

value (アクセサ)
アクセサ public ListBox.value:any
セッター public ListBox.value:any

このコントロールの値。

説明

このプロパティを取得すると、選択された全てのアイテムの値を含む新規に作成された {Array-of any} が得られます。このプロパティをイテレータに設定することは、そのイテレータ内の全ての値を選択します。このプロパティを {Array-of any} に設定することは、この配列内の各値を選択します。このプロパティを他のものに設定すると、その値を持つ 1 つのアイテムを選択しようとします。設定したい値が {Array-of any} である場合は、この値を別の {Array-of any} でラップする必要があることに注意してください。
値を設定する時に、値が変更された時にイベントを発生させる set-value-with-events の使用を検討してください。




メソッド詳細
add-from-init-args (メソッド)
protected {ListBox.add-from-init-args a:any}:void

この Visual のコンストラクタに渡されるオブジェクトを Visual の内容に追加します。

プログラミング注意事項

このメソッドは Visual.non-keyword-init-arg で呼び出され、通常サブクラスでは直接呼び出しません。

オーバーライド

このメソッドの既定の実装では、Visual.add が呼び出されるだけです。サブクラスではこのメソッドをオーバーライドし、コンストラクタを使ってこの Visual に内容を追加する際の特別な処理を指定してください。

add-selected-index (メソッド)
public {ListBox.add-selected-index i:int}:void

インデックスが i のアイテムを選択します。


create-default-ui-object (メソッド)
protected {ListBox.create-default-ui-object}:ControlUI

このオブジェクトに適切な UI オブジェクトを作成します。

説明

このメソッドは、現在の LookAndFeel がこのコントロールの UI オブジェクトを指定しない場合にのみ使用されます。

deselect-all-items (メソッド)
public {ListBox.deselect-all-items}:void

このコントロールのすべてのアイテムを選択解除します。


fire-value-changed (メソッド)
public {ListBox.fire-value-changed}:void

この ListBox の ValueChanged イベントをキューに入れます。このイベントは、現在のイベントが処理された後に送信されます。


fire-value-finished (メソッド)
public {ListBox.fire-value-finished}:void

このオブジェクトの ValueFinished イベントをキューに入れます。このイベントは、現在のイベントが処理された後に送信されます。


get-test-property (メソッド)
public {ListBox.get-test-property name:String}:any

このオブジェクトのテスト プロパティ値を返します。

説明

既定の実装では、リフレクションを使用してオブジェクトの実行時プロパティの値を取得します。プロパティを実行時のインターフェイスではなくテスト環境に追加する場合は、サブクラスでこのメソッドをオーバーライドする必要があります。

注意事項

参照：canonical-test-value

notify-interval-added (メソッド)
public {ListBox.notify-interval-added
lower:int,
upper:int,
item:#ListItem = null
}:void

新しい値が追加されたときにデータ モデルによって呼び出されるメソッド。

説明

データ モデルは、ListItem にする必要がある新しい値がある場合にこのメソッドを呼び出します。このメソッドは ListItem を生成し、それを ListModelControl.items 配列に挿入します。通常は、ユーザー記述のコードでこのメソッドを呼び出さないでください。
lower: 追加されたアイテムの下限 (そのアイテムを含む)。
upper: 追加されたアイテムの上限 (そのアイテムを含む)。
item: これで指定した ListItem を使用し、list-item-creation-proc で自動的に生成されたものを使用しないことを意味します。このパラメータが指定された場合、その範囲に 1 つのアイテムだけを含める必要があります。このパラメータで関数を呼び出す必要はありません。ListModelControl.append と ListModelControl.insert によって使用されます。

オーバーライド

一般に、ListItem が削除されたときに追加の保守を行なう場合に、このメソッドをオーバーライドする必要があります。ほとんどの場合、最初に super.notify-interval-added を呼び出し、独自の操作を実行する前に ListItem を生成して配列に挿入します。

notify-interval-changed (メソッド)
public {ListBox.notify-interval-changed
lower:int,
upper:int,
item:#ListItem = null
}:void

値が変更されたときにデータ モデルによって呼び出されるメソッド。

説明

データ モデルは、一部の値が変更されたときにこのメソッドを呼び出します。このメソッドは、新しい値から新しい ListItem を生成し、ListModelControl.items 配列を適切に変更します。通常は、ユーザー記述のコードでこのメソッドを呼び出さないでください。
lower: 変更されたアイテムの下限 (そのアイテムを含む)。
upper: 変更されたアイテムの上限 (そのアイテムを含む)。
item: 特定の ListItem を使用し、list-item-creation-proc で自動的に生成されたものを使用しないことを意味します。このパラメータが指定された場合は、その範囲に 1 つのアイテムだけを含める必要があります。このパラメータで関数を呼び出す必要はありません。ListModelControl.set によって使用されます。

オーバーライド

一般に、ListItem が置き換えられたされたときに追加の保守を行なう場合に、このメソッドをオーバーライドする必要があります。ほとんどの場合、古い ListItem の状態を破棄し、super.notify-interval-changed を呼び出して追加された新しい ListItem の状態を設定します。

notify-interval-removed (メソッド)
public {ListBox.notify-interval-removed lower:int, upper:int}:void

値が削除されたときにデータ モデルによって呼び出されるメソッド。

説明

データ モデルは、一部の値が削除されたときにこのメソッドを呼び出します。このメソッドは値を ListModelControl.items 配列から削除します。値がすでに ListModel から削除されていることに注意してください。通常は、ユーザー記述のコードでこのメソッドを呼び出さないでください。
lower: 削除されたアイテムの下限 (そのアイテムを含む)。
upper: 削除されたアイテムの上限 (そのアイテムを含む)。

オーバーライド

一般に、ListItem が挿入されたときに追加の保守を行なう場合に、このメソッドをオーバーライドする必要があります。ほとんどの場合、最初に独自の破棄操作を行なうため ListItem へのアクセスが必要で、この操作の最後で super.notify-interval-removed を呼び出します。

notify-item-selected (メソッド)
public {ListBox.notify-item-selected item:ListItem}:void

選択状態が変化したことを通知するために ListItem によって呼び出されます。

説明

ListItem.selected? を設定して実際に選択状態が変化するとこのメソッドが呼び出され、コントロールは内部の選択状態を更新してこれに一致させます。通常は、ユーザー記述のコードでこのメソッドを呼び出さないでください。

rebuild-from-data-model (メソッド)
public {ListBox.rebuild-from-data-model}:void

データ モデルの値で ListItem を再作成します。

説明

このクラスの実装では、現存するすべてのアイテムを削除して、データ モデル内の新しいアイテムをすべて追加するだけです。

オーバーライド

サブクラスでこのメソッドをオーバーライドして、super.rebuild-from-data-model を呼び出す前の更新をオフにして、後で同時に更新を行なうようにすると効率がよくなります。

remove-selected-index (メソッド)
public {ListBox.remove-selected-index i:int}:void

インデックスが i のアイテムの選択を解除します。


select-all-items (メソッド)
public {ListBox.select-all-items}:void

このコントロール内のすべてのアイテムの selected? フィールドを true に設定します。


select-index (メソッド)
public {ListBox.select-index i:int}:void

1 つのインデックスを選択し、選択されているほかのインデックスをすべて解除します。


select-index-with-events (メソッド)
public {ListBox.select-index-with-events i:int}:void

1 つのインデックスを選択します。選択されているほかのインデックスはすべて解除され、ValueChanged イベントと ValueFinished イベントが発生します。


select-indices-with-events (メソッド)
public {ListBox.select-indices-with-events
indices:{Iterator-of int}
}:void

指定された反復子によって返されるインデックスを選択し、イベントを発生させます。

説明

詳細は MultipleSelectionControl.select-indices-with-events を参照してください。

改訂

ListBox.select-indices-with-events の実装は、リリース 3.0.6 前までは不適切でした。 これを使用する場合はヘッダーに 3.0.6+ を指定してください。

set-value-with-events (メソッド)
public {ListBox.set-value-with-events v:any}:void

v に値を設定し、ValueChanged (該当する場合) および ValueFinished イベントを発生させます。


test-run (メソッド)
public {ListBox.test-run action:String, args:FastArray}:any

オブジェクトに対してビジュアル テスト アクションを実行します。

action: 実行するアクションの名前。
args: ビジュアル テスト アクションの引数。ビジュアル テスト インフラストラクチャは、引数の数と型をチェックしますが、値はチェックしません。実装では、すべての有効な値を処理し、不正な値に対しては例外またはエラーをスローするようにしてください。

説明

そのクラスによってサポートされたテスト動作のリストについてクラスのドキュメントを御読み下さい。
既定の実装では、RawClick などの一般的な操作を処理し、action が既知のアクションに一致しない場合にはリフレクションを使用してメソッドを呼び出します。

注意事項

QuickTest Property™ のビジュアル テスト環境では、任意の実行時メソッドを直接呼び出せません。代わりに CallMethod アクションを使用して、最初の引数としてメソッド名を渡してください。ビジュアル テスト インフラストラクチャは、CallMethod アクションを実際のアクションに変換してから test-run を呼び出します。

注意事項

参照：canonical-test-value

オーバーライド

新しいテスト アクションを追加するには、action と新しいアクションの名前を照合します。一致する場合は、引数を処理してアクションを実行し、適切なタイプの値 (戻り値がない場合は null) を返します。action が新しいテスト アクションに一致しない場合は、super.test-run を呼び出します。

unset-value (メソッド)
public {ListBox.unset-value}:void

値をコントロールの既定値に戻すか、初期化されていない状態があればその状態に戻します。

説明

詳細については、ValueControl.has-value? を参照してください。