RecordGrid (クラス)
public RecordGrid {inherits SelectionContext, RecordSetDisplay, MultiUIControlFrame, RecordGridOptions, TestTabularData}
インポート元： CURL.GUI.STANDARD. package 内で定義されています CURL.GUI.CONTROL-LOGICAL.

データのソート、フィルタ、編集可能なグリッド。

説明

RecordGrid は、RecordGridColumn、columns コレクションの指定に従い、record-source 内のデータを表示します。record-source のフィールドの表示と編集機能は、個々の列で制御されます。データの表示方法を変更するために、これらの列を直接操作することができます。RecordGrid ではその record-source に基づいて自動的に列を作成することも、これらの列を直接指定することもできます。
RecordGrid で設定されるローカル オプションは、非ローカル オプションと同様にその RecordGridColumn および RecordGridCell によって「継承」される点に注意してください。詳細は RecordGridOptions を参照してください。
RecordGrid では、そのレコードか列、またはその両方の選択も可能です。この場合、RecordGridSelection 型を維持します。既定では、レコードのみ選択可能です。
最後に、RecordSetDisplay と SelectionContext が通常発生させる通知イベントを RecordGrid が発生させることにも注意してください。

ビジュアル テスト

このクラスは、CurlDataTable ビジュアル テスト タイプを実装します。
行と列は、名前 (ただし RecordGrid には名前付きの行がないためサポートされません)、またはインデックスにより参照されます。セルは、行と列のペアで参照されます。
すべての Visual によってサポートされる既定のビジュアル テスト アクションの他に、このクラスのオブジェクトは次のアクションをサポートします。
アクション 引数 説明
Action <none> テーブルについて標準アクションを実行します。
ActivateCell row:String, col:Stringセル row、col をアクティブにします。特殊なケースとして、row または col のいずれかが -1 の場合、すべてのセルが非アクティブになります。
ActivateRow row:String行 row をアクティブにします。
DeleteSelectedRows <none> 現在選択されている行を削除します。
ColumnMove move-col:String, before-col:String列 move-col を列 before-col の前に移動します。
ColumnResize col:String, delta:int列 col のサイズを delta ピクセル分変更します。
ColumnsResize col1:String, col2:String, delta:intcol1 から col2 までの列のサイズを delta ピクセル分変更します。
ColumnSort col:String, ascending?:bool列をソートします。
DeselectAll <none> テーブル内のすべての選択を解除します。
DeselectColumn col:String列 col の選択を解除します。
DeselectColumns col1:String, col2:Stringcol1 から col2 までの列の選択を解除します。
DeselectRow row:String行 row の選択を解除します。
DeselectRows row1:String, row2:Stringrow1 から row2 までの行の選択を解除します。
ExtendCell row:String, col:Stringセル row、col を選択済みセルのセットに追加します。
ExtendCellsRange start-row:String, start-col:String,
end-row:String, end-col:String		start-row、start-col から end-row、end-col までのセルを選択済みセルのセットに追加します。
ExtendColumn col:String列 col を選択済み列のセットに追加します。
ExtendColumnsRange col1:String, col2:String選択済み列のセットを、col1 から col2 までの列が含まれるように拡張します。
ExtendRow row:String行 row を選択済み行のセットに追加します。
ExtendRowsRange row1:String, row2:String選択済み行のセットを、row1 から row2 までの行が含まれるように拡張します。
GetCellData row:String, col:String指定したセル内のデータを返します。
ModifyCellsRange start-row:String, start-col:String,
end-row:String, end-col:String		最後に選択された領域を start-row、start-col から end-row、end-col までのセルに変更します。その他の選択には影響しません。
SelectAll <none> テーブル内のすべてを選択します。
SelectCell row:String, col:Stringセル row、col を選択します。
SelectCellsRange start-row:String, start-col:String,
end-row:String, end-col:String		start-row、start-col から end-row、end-col までのセルを選択します。
SelectColumn col:String列 col を選択します。
SelectColumnsRange col1:String, col2:Stringcol1 から col2 までの列を選択します。
SelectRow row:String行 row を選択します。
SelectRowsRange row1:String, row2:Stringrow1 から row2 までの行を選択します。
SetCellData row:String, col:String, data:String指定したセルの内容を設定します。
すべての Visual によってサポートされる既定のビジュアル テスト プロパティの他に、このクラスのオブジェクトは次のビジュアル テスト プロパティをサポートします。
プロパティ 説明
rows:Stringテーブル内の行の数です。
columns:String テーブル内の列の数です。

注意事項

このオブジェクトは、"RecordGrid"、"RecordGrid/internal-grid"のスタイル ルールを記述することによってスタイル化することが出来ます。詳細は スキンが適用されたレコードグリッド をご覧下さい。

コンストラクタ
default:このオブジェクトを作成します。
コンストラクタ public {RecordGrid.default
record-source:#RecordSet = null,
sort:#RecordSort = null,
filter:#RecordFilter = null,
key-spec:any = null,
header-options:RecordGridRowOptions = {RecordGridRowOptions},
ui-object:#RecordGridUI = null,
...
}

プロパティ
alternate-row-background:一行おきに行の色を変えて、帳簿のように描画するために使う Background。
非ローカル オプション public RecordGrid.alternate-row-background:Background
automatic-columns?:RecordGrid がその RecordGrid.record-source 内のフィールドに対応する RecordGridColumn を自動的に生成するかどうか指定します。
ローカル オプション public RecordGrid.automatic-columns?:bool =true
background:グラフィカル オブジェクトの背景色または背景パターン。
ローカル オプション public RecordGrid.background:Background
base-columns:表示される順に並べられた BaseRecordGridColumn。
アクセサ public RecordGrid.base-columns:{Array-of BaseRecordGridColumn}
セッター public RecordGrid.base-columns:{Array-of BaseRecordGridColumn}
column-change-pending?:列の変更があるか、または列変更が準備されているかどうかを返します。
アクセサ public RecordGrid.column-change-pending?:bool
column-selection-enabled?:選択可能な列かどうかを示します。
ローカル オプション public RecordGrid.column-selection-enabled?:bool =false
columns:表示される順に並べられた RecordGridColumn。
アクセサ public RecordGrid.columns:{Array-of RecordGridColumn}
セッター public RecordGrid.columns:{Array-of RecordGridColumn}
container:この SelectionContext が適用される Graphic。
アクセサ public RecordGrid.container:Graphic
display-column-headers?:列ヘッダーを表示するかどうか指定します。
ローカル オプション public RecordGrid.display-column-headers?:bool =true
display-filler-column?:余分な空間を埋めるために空の列を表示しますか?
ローカル オプション public RecordGrid.display-filler-column?:bool =false
display-navigation-panel?:ナビゲーション パネルを表示するかどうかを指定します。
ローカル オプション public RecordGrid.display-navigation-panel?:bool
display-record-selectors?:レコード セレクタを表示するかどうかを指定します。
ローカル オプション public RecordGrid.display-record-selectors?:bool =true
enclose-header-label?:RecordGrid ヘッダー ラベルと共有列ヘッダーまたは上部の空間の間に、目に見える境界があるかどうか。
ローカル オプション public RecordGrid.enclose-header-label?:bool
frozen-column-count:適切にロックする必要がある列の数です。
アクセサ public RecordGrid.frozen-column-count:int
セッター public RecordGrid.frozen-column-count:int
frozen-column-start:適切にロックする必要がある最初の列のインデックスです。
アクセサ public RecordGrid.frozen-column-start:int
セッター public RecordGrid.frozen-column-start:int
frozen-row-count:適切にロックする必要がある行 (レコード) の数です。
アクセサ public RecordGrid.frozen-row-count:int
セッター public RecordGrid.frozen-row-count:int
frozen-row-start:適切にロックする必要がある最初の行のインデックスです。
アクセサ public RecordGrid.frozen-row-start:int
セッター public RecordGrid.frozen-row-start:int
frozen?:固定されている行や列があるかどうかを返します。
アクセサ public RecordGrid.frozen?:bool
grid-line-color:RecordGrid でセル間に引くグリッド線の色。
非ローカル オプション public RecordGrid.grid-line-color:FillPattern
header-options:この RecordGrid ですべての列見出しに適用される "バンドル" 式のグラフィック オプション設定です。
アクセサ public RecordGrid.header-options:RecordGridRowOptions
セッター public RecordGrid.header-options:RecordGridRowOptions
horizontal-grid-line-width:行の間に引くグリッド線の幅。
非ローカル オプション public RecordGrid.horizontal-grid-line-width:any
max-column-depth:このグリッド内で使用される全てのRecordGridColumnの列グループの深さの最大値。
フィールド public-get protected-set RecordGrid.max-column-depth:int =0
multiple-selection-enabled?:複数レコードまたは列を選択できるかどうか指定します。
ローカル オプション public RecordGrid.multiple-selection-enabled?:bool =true
record-selection-enabled?:選択可能なレコードかどうかを示します。
ローカル オプション public RecordGrid.record-selection-enabled?:bool =true
region-selection-enabled?:四角形の領域が選択可能かどうかを指定します。
ローカル オプション public RecordGrid.region-selection-enabled?:bool =false
row-background-spec:表示されている各行の background オプションを設定する proc です。
ローカル オプション public RecordGrid.row-background-spec:#{proc-type {RecordGrid, Record, int}:#Background} =null
select-current-record?:ユーザー操作により現在のレコードが移動される場合でも選択されるかどうかを指定します。
ローカル オプション public RecordGrid.select-current-record?:bool =false
selection:プロジェクトにより保持される、現在の Selection。
アクセサ public RecordGrid.selection:RecordGridSelection
style-element:スタイリングの目的のための、この Visual の "要素" や "型" です。
アクセサ public RecordGrid.style-element:String
test-type-name:このオブジェクトをテストのメソッドとプロパティにマッピングするために、ビジュアル テスト インフラストラクチャが使用するタイプ名。
アクセサ public RecordGrid.test-type-name:String
ui:このコントロールの UI オブジェクト (RecordGridUI など)
アクセサ public RecordGrid.ui:RecordGridUI
vertical-grid-line-width:列の間に引くグリッド線の幅。
非ローカル オプション public RecordGrid.vertical-grid-line-width:any
プロパティ 継承 SelectionContext: can-redo?, can-undo?, selection-context-active?
プロパティ 継承 RecordSetDisplay: current-index, current-record, filter, key-proc, key-spec, record-source, records, sort
プロパティ 継承 MultiUIControlFrame: _ui-object, _ui-set-locally?, control-appearance-changeable?, display-context, focus-object, look-and-feel, options-present-here, ui-object
プロパティ 継承 RecordGridOptions: cell-spec, cells-take-focus?, column-movable?, column-resizable?, edit-on-focus?, editable?, filter-menu-proc, format-spec, halign, header-spec, parse-spec, sort-spec, valign
プロパティ 継承 CommandContext: commands
プロパティ 継承 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
プロパティ 継承 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?
プロパティ 継承 OptionListInterface: option-register-proc, registered-option-keys
プロパティ 継承 EventTarget: event-handlers
プロパティ 継承 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
プロパティ 継承 DataBindingTarget: data-binding-context, data-bindings
プロパティ 継承 Control: control-container, dialog, focus-skin, form, has-value?, skin
プロパティ 継承 GetBoundsBox: layout-locally-valid?, layout-valid?
プロパティ 継承 ActiveTraversor: _active-traversal-container, active-traversal-container, mnemonic, tab-index, takes-focus?, valid?, validation-result
プロパティ 継承 Box: clip-child-shadows?
プロパティ 継承 Graphic: avoid-page-break?, 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

メソッド
become-active:アクティブ化に対して応答します。
public {RecordGrid.become-active forward?:bool = true}:bool
become-active-from-traversal:トラバースによるアクティブ化に応答します。
public {RecordGrid.become-active-from-traversal
forward?:bool = true
}:bool
create-command:時間をかけてコマンドを作成します。
public {RecordGrid.create-command name:String}:#Command
create-default-ui-object:このオブジェクトに適切な UI オブジェクトを作成します。
protected {RecordGrid.create-default-ui-object}:ControlUI
delete-selection:現在の選択範囲を削除します。
public {RecordGrid.delete-selection}:void
deselect-column:現在の選択範囲から列を削除します。
public {RecordGrid.deselect-column column:BaseRecordGridColumn}:void
deselect-record:現在の選択範囲からレコードを削除します。
public {RecordGrid.deselect-record index:int}:void
deselect-region:現在の選択範囲から範囲を削除します。
public {RecordGrid.deselect-region region:RecordGridRegion}:void
get-test-property:このオブジェクトのテスト プロパティ値を返します。
public {RecordGrid.get-test-property name:String}:any
get-test-tabular-attributes:ビジュアル テスト用に、表の行情報を返します。
public {RecordGrid.get-test-tabular-attributes
}:(full-size:int, min-visible-row:int, max-visible-row:int)
get-test-tabular-data:ビジュアル テスト用に、表データを返します。
public {RecordGrid.get-test-tabular-data
min-row:int,
max-row:int
}:(column-titles:StringVec, data:FastArray)
grid-objects-at:グリッド内の特定位置のグリッド オブジェクトの情報を取得します。
public {RecordGrid.grid-objects-at
x:Distance,
y:Distance
}:(cell:#RecordGridCell, record-index:int, column-index:int )
modify-last-selected-region:現在の選択の最後の領域を置き換えます。
public {RecordGrid.modify-last-selected-region
region:RecordGridRegion
}:void
move-column:グリッド内でRecordGridColumnを移動させます。
public {RecordGrid.move-column
source-index:int,
destination-index:int
}:void
note-column-changed:columns の 1 つが変更されたことをグリッドに通知します。
public {RecordGrid.note-column-changed
column:BaseRecordGridColumn,
property-name:String
}:void
note-current-record-changed:current-index への変更および/または current レコードの識別情報の変更を示すために呼び出されます。
protected {RecordGrid.note-current-record-changed
index-change?:bool,
identity-change?:bool
}:void
note-record-set-event:RecordSetEvent が RecordSetDisplay.records プロパティによって処理されたことをこのレコード グリッドに通知します。
public {RecordGrid.note-record-set-event ev:RecordSetEvent}:void
note-row-options-changed:RecordGridRowOptions のいずれかが変更されたことをグリッドに通知します。
public {RecordGrid.note-row-options-changed
row:RecordGridRowOptions,
property-name:String
}:void
on-context-menu-event:ContextMenuEvent イベントのスタティック イベント ハンドラ。
public {RecordGrid.on-context-menu-event ev:ContextMenuEvent}:void
on-selection-changed:SelectionChanged イベントのスタティック イベント ハンドラ。
public {RecordGrid.on-selection-changed sc:SelectionChanged}:void
option-lookup-here:オプション検索ステップを実行します。
public {RecordGrid.option-lookup-here
key:OptionKey,
local?:bool
}:(item:#OptionItem, local-key?:bool)
propagate-option-change:このオブジェクト、および該当する場合はそのオプションの子孫にオプションが変更されたことを通知します。
public {RecordGrid.propagate-option-change
item:OptionItem,
removed?:bool
}:void
refresh-automatic-columns:columns コレクションの自動生成 RecordGridColumn を RecordGrid.record-source に同期させます。
protected {RecordGrid.refresh-automatic-columns}:void
select-all:すべてのレコード、列、領域、またはその組み合わせを選択します。
public {RecordGrid.select-all}:void
select-column:列を選択します。
public {RecordGrid.select-column
column:BaseRecordGridColumn,
additive?:bool = false
}:void
select-column-range:列範囲を選択します。
public {RecordGrid.select-column-range
start-column:BaseRecordGridColumn,
end-column:BaseRecordGridColumn,
additive?:bool = false
}:void
select-nothing:このコンテキストの選択をクリアします。
public {RecordGrid.select-nothing}:void
select-record:レコードを選択します。
public {RecordGrid.select-record
index:int,
additive?:bool = false
}:void
select-record-range:レコード範囲を選択します。
public {RecordGrid.select-record-range
start-index:int,
end-index:int,
additive?:bool = false
}:void
select-region:四角形の領域を選択します。
public {RecordGrid.select-region
region:RecordGridRegion,
additive?:bool = false
}:void
set-frozen-region:適切にロックされる必要がある行数と列数、および表示する行と列が始まる場所を設定します。
public {RecordGrid.set-frozen-region
rows:int,
columns:int,
row-start:int = -1,
column-start:int = -1
}:void
test-record:オブジェクトのテスト アクションを記録します。
public {RecordGrid.test-record action:String, ...}:void
test-run:オブジェクトに対してビジュアル テスト アクションを実行します。
public {RecordGrid.test-run action:String, args:{FastArray-of any}}:any
unset-frozen-region:このグリッドから固定設定をすべて削除します。
public {RecordGrid.unset-frozen-region}:void
メソッド 継承 SelectionContext: note-selection-context-activated, note-selection-context-deactivated, overdraw-selection, redo, selection-context-request-activate, undo
メソッド 継承 RecordSetDisplay: on-current-record-change-request, reload, request-current-record-change
メソッド 継承 MultiUIControlFrame: generate-ui-object, handle-look-and-feel-change, handle-observer-message, on-focus-in, option-changed, option-propagate-notify, react-to-state-change, react-to-visual-change, request-key-focus, set-layout
メソッド 継承 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-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-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
メソッド 継承 CommandContext: add-command, command-enabled?, command-supported?, do-command, get-command, request-update-commands
メソッド 継承 Visual: add, add-from-init-args, 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, transform-from-display-coordinates, transform-from-graphical-root-coordinates, transform-to-display-coordinates, transform-to-graphical-root-coordinates
メソッド 継承 ControlFrame: clear
メソッド 継承 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?, 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
メソッド 継承 EventTarget: accepts-event-class?, add-event-handler, event-handler-present?, remove-event-handler, verify-event
メソッド 継承 GraphicOptions: any-to-Distance, get-display-context
メソッド 継承 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
メソッド 継承 InitRestArgParser: process-rest-args
メソッド 継承 BasicEventTarget: enqueue-event
メソッド 継承 DataBindingTarget: add-data-binding, get-data-binding, refresh-data-binding, remove-data-binding, unset-property, update-data-binding, validate-data-binding
メソッド 継承 BasicBox: contains-point?, find-graphic-at, handle-crossing, on-pointer-envelope-event, pointer-enter-occurred, pointer-leave-occurred
メソッド 継承 Control: on-pointer-press
メソッド 継承 StandardActiveTraversor: fire-event-at-container, handle-mnemonic, on-key-press
メソッド 継承 Observer: observe, stop-observing
メソッド 継承 GetBoundsBox: get-bounds, get-elastic-bounds-into, get-nonparent-bounds-into, request-layout, validate-layout
メソッド 継承 ActiveTraversor: mark-invalid, mark-valid
メソッド 継承 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
メソッド 継承 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
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize



コンストラクタ詳細
default (コンストラクタ)
public {RecordGrid.default
record-source:#RecordSet = null,
sort:#RecordSort = null,
filter:#RecordFilter = null,
key-spec:any = null,
header-options:RecordGridRowOptions = {RecordGridRowOptions},
ui-object:#RecordGridUI = null,
...
}

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

record-source: 表示される RecordSet。
sort: RecordSort。sort を参照。
filter: RecordFilter。filter を参照。
key-spec: any。key-spec を参照してください。
header-options: RecordGridRowOptions。header-options を参照してください。
ui-object: 描画とイベントを処理する UI デリゲート。
...: MultiUIControlFrame のコンストラクタに渡すオプションを含めることができます。このコレクションにカスタムの RecordGridColumn を含めることも可能です。ここで指定される列はすべて、同じフィールドに対して自動的に生成される列をオーバーライドします。

説明

適切な key-spec によりユーザーエクスペリエンスの向上が期待できる場合、key-spec を設定すべきです。ただし RecordSetEvent が発生した時に、null の key-spec が設定されていると current-index や selection の喪失を引き起こす原因となります。


プロパティ詳細
alternate-row-background (非ローカル オプション)
public RecordGrid.alternate-row-background:Background

一行おきに行の色を変えて、帳簿のように描画するために使う Background。


automatic-columns? (ローカル オプション)
public RecordGrid.automatic-columns?:bool =true

RecordGrid がその RecordGrid.record-source 内のフィールドに対応する RecordGridColumn を自動的に生成するかどうか指定します。

説明

true の場合、このオブジェクトの record-source のフィールドに対応する列が自動的に生成および管理されます。このような自動的に生成された列は、RecordGridColumn.automatic? プロパティの設定によって識別されます。
自動生成列は、record-source が新規の非 null 値に変更されるたびに、または既存 record-source の RecordSet.fields コレクションが変更されるたびに「リフレッシュ」されます。この操作の目的は、columns コレクションを record-source と同期させると同時に、columns コレクションにアプリケーションやエンドユーザーが加えた変更を可能な限り保持することです。
リフレッシュは以下の規則に従って発生します。
  • columns コレクションに現在表されていない record-source のフィールド名に対して、新しい automatic? 列が作成されます。このような列はコレクションの最後に配置されます。
  • automatic? 列が record-source のフィールド名を参照しなくなった場合、これらは削除されます。
  • automatic? 列は、同じフィールド名を持つ既存の非 automatic? 列を置き換えません。
自動的に生成された列をアプリケーションで管理するには (したがって置き換えや削除が起こらないようにするには)、列の automatic? プロパティを false に設定する必要があります。

background (ローカル オプション)
public RecordGrid.background:Background

グラフィカル オブジェクトの背景色または背景パターン。

説明

グラフィカル オブジェクトの背景色または背景パターンを、"red" などの FillPattern に自動変換する Background、FillPattern、 または String に設定します。

例


例: 背景を文字列に設定
{CheckButton
    label="Check here if you like my background",
    background="lime"
}



例: 背景を Background オブジェクトに設定
{Fill
    width = 2cm,
    height = 2cm,
    background =
        {Background
            {url "curl://install/docs/default/images/grass.jpg"}
        }
}

注意事項

背景を Observable でもある FillPattern アニメーションに設定すると、必要に応じて Graphic がそれ自体を再描画するように FillPattern が登録されます。

ただし、よりシンプルな call-back メカニズムによって背景を NotifyingFillPattern に設定した場合もこのような処理が行われるので注意してください。

base-columns (アクセサ)
アクセサ public RecordGrid.base-columns:{Array-of BaseRecordGridColumn}
セッター public RecordGrid.base-columns:{Array-of BaseRecordGridColumn}

表示される順に並べられた BaseRecordGridColumn。

説明

RecordGrid.columns とは異なり、これは具象と抽象の両方の列エンティティを表わしますが、その RecordGridColumnGroup 階層の一番上のレベルのエンティティしか表わしません。これによって返されるすべての RecordGridColumnGroup の子 RecordGridColumn すべてを縦型検索で取得することによって RecordGrid.columns を取得できます。
重要：このコレクションの個々の列エンティティは直接編集することができますが、コレクション自体は変更しないでください。表示する列のセット (または順序) を変更するには、このコレクションのクローンを編集し、編集後のクローンとなるようプロパティをリセットします。

column-change-pending? (アクセサ)
アクセサ public RecordGrid.column-change-pending?:bool

列の変更があるか、または列変更が準備されているかどうかを返します。

導入: バージョン 7.0

column-selection-enabled? (ローカル オプション)
public RecordGrid.column-selection-enabled?:bool =false

選択可能な列かどうかを示します。


columns (アクセサ)
アクセサ public RecordGrid.columns:{Array-of RecordGridColumn}
セッター public RecordGrid.columns:{Array-of RecordGridColumn}

表示される順に並べられた RecordGridColumn。

説明

RecordGrid.data-source プロパティのフィールドに関連付けできない列は、データなしで表示されます。
RecordGrid.base-columns が変更された場合は、このプロパティが更新されます。またその逆も起こります。このアクセッサでは RecordGridColumn のみ使用可能で、設定されると、列のグループ情報が失われることに注意してください (すなわち、すべての列で BaseRecordGridColumn.parent-group が設定解除されます)。列グループを維持するには、代わりに RecordGrid.base-columns を使用します。
重要：このコレクションの個々の列は直接編集することができますが、コレクション自体は変更しないでください。表示する列のセット (または順序) を変更するには、このコレクションのクローンを編集し、編集後のクローンとなるようプロパティをリセットします。

container (アクセサ)
アクセサ public RecordGrid.container:Graphic

この SelectionContext が適用される Graphic。

説明

ネストされた SelectionContext のメンバではない、この Graphic の内容 (グラフィカルな子を含む) は、いずれもオブジェクトによる選択候補になります。

display-column-headers? (ローカル オプション)
public RecordGrid.display-column-headers?:bool =true

列ヘッダーを表示するかどうか指定します。


display-filler-column? (ローカル オプション)
public RecordGrid.display-filler-column?:bool =false

余分な空間を埋めるために空の列を表示しますか?

説明

true の場合、"filler"列の列見出しは空で、右端の列と、グリッドの右端エッジとの間には、セルが描画されません。

display-navigation-panel? (ローカル オプション)
public RecordGrid.display-navigation-panel?:bool

ナビゲーション パネルを表示するかどうかを指定します。

説明

ナビゲーション パネルには通常、current-record、表示レコード数およびレコードの合計数に関する情報が含まれます。また、current-record を移動するためのコントロールが含まれる場合もあります。

display-record-selectors? (ローカル オプション)
public RecordGrid.display-record-selectors?:bool =true

レコード セレクタを表示するかどうかを指定します。


enclose-header-label? (ローカル オプション)
public RecordGrid.enclose-header-label?:bool

RecordGrid ヘッダー ラベルと共有列ヘッダーまたは上部の空間の間に、目に見える境界があるかどうか。


frozen-column-count (アクセサ)
アクセサ public RecordGrid.frozen-column-count:int
セッター public RecordGrid.frozen-column-count:int

適切にロックする必要がある列の数です。

説明

使用中の一部の RecordGridUI によってサポートされない場合は、このプロパティを設定しても視覚的効果は何もありません。

frozen-column-start (アクセサ)
アクセサ public RecordGrid.frozen-column-start:int
セッター public RecordGrid.frozen-column-start:int

適切にロックする必要がある最初の列のインデックスです。

説明

使用中の一部の RecordGridUI によってサポートされない場合は、このプロパティを設定しても視覚的効果は何もありません。

frozen-row-count (アクセサ)
アクセサ public RecordGrid.frozen-row-count:int
セッター public RecordGrid.frozen-row-count:int

適切にロックする必要がある行 (レコード) の数です。

説明

使用中の一部の RecordGridUI によってサポートされない場合は、このプロパティを設定しても視覚的効果は何もありません。

frozen-row-start (アクセサ)
アクセサ public RecordGrid.frozen-row-start:int
セッター public RecordGrid.frozen-row-start:int

適切にロックする必要がある最初の行のインデックスです。

説明

使用中の一部の RecordGridUI によってサポートされない場合は、このプロパティを設定しても視覚的効果は何もありません。

frozen? (アクセサ)
アクセサ public RecordGrid.frozen?:bool

固定されている行や列があるかどうかを返します。

導入: バージョン 7.0

grid-line-color (非ローカル オプション)
public RecordGrid.grid-line-color:FillPattern

RecordGrid でセル間に引くグリッド線の色。


header-options (アクセサ)
アクセサ public RecordGrid.header-options:RecordGridRowOptions
セッター public RecordGrid.header-options:RecordGridRowOptions

この RecordGrid ですべての列見出しに適用される "バンドル" 式のグラフィック オプション設定です。

説明

すべての列見出しで使用するグラフィック オプション設定を集中的に管理するため、このプロパティを使用します。ここで設定するオプションは、RecordGridUI によりすべての見出しに適用されます。
このプロパティで指定されたオプション設定は、RecordGridColumn で指定されるすべての設定より優先されます。

horizontal-grid-line-width (非ローカル オプション)
public RecordGrid.horizontal-grid-line-width:any

行の間に引くグリッド線の幅。


max-column-depth (フィールド)
public-get protected-set RecordGrid.max-column-depth:int =0

このグリッド内で使用される全てのRecordGridColumnの列グループの深さの最大値。

導入: バージョン 7.0

multiple-selection-enabled? (ローカル オプション)
public RecordGrid.multiple-selection-enabled?:bool =true

複数レコードまたは列を選択できるかどうか指定します。


record-selection-enabled? (ローカル オプション)
public RecordGrid.record-selection-enabled?:bool =true

選択可能なレコードかどうかを示します。


region-selection-enabled? (ローカル オプション)
public RecordGrid.region-selection-enabled?:bool =false

四角形の領域が選択可能かどうかを指定します。


row-background-spec (ローカル オプション)
public RecordGrid.row-background-spec:#{proc-type {RecordGrid, Record, int}:#Background} =null

表示されている各行の background オプションを設定する proc です。

説明

nullでない場合、ここに設定されるプロシージャは この RecordGrid に表示されている各行の Background を生成するために繰り返し呼び出されます。プロシージャには次の 3 つの引数が必要です。：この RecordGrid、 対象の行に対応した Record、RecordGrid.records 内のRecord のインデックス。Background がその行で必要でない場合には、null が返されます。そうでない場合は、その行で使用される Background が返されます。
このオプションに null を設定すると、全ての計算された行の背景色は unset されます。
ここに設定されたプロシージャは、元となるデータやレイアウトが変更されていなくても頻繁に呼び出される可能性があります。これは、使用される RecordGridUI の実装に依存します。
導入: バージョン 6.0

select-current-record? (ローカル オプション)
public RecordGrid.select-current-record?:bool =false

ユーザー操作により現在のレコードが移動される場合でも選択されるかどうかを指定します。

説明

ユーザーがキーボードまたはマウスで選択するレコードが、選択状態になり current-record とする場合、このオプションを true に設定します。この動作は ListBox の動作とよく似ています。
このオプションが false (既定) の場合、ユーザーがレコード セレクタをクリックまたはドラッグするときにのみレコードが選択されます。ただし、このオプションが true である場合は、レコードの本体での消費されないクリックまたはドラッグによりレコードが選択されます。
また、true の場合、現在のレコードを変更するキーボード ナビゲーション操作、たとえば KeyPressValue.up、KeyPressValue.dn、KeyPressValue.pgup、KeyPressValue.pgdn、KeyPressValue.home、KeyPressValue.end も、同様に新しいレコードを選択します。
このオプションは、セルがフォーカスを取得しない編集不可能なグリッドに対し最も便利です。特に、通常は RecordGrid.cells-take-focus? を false に設定します。

selection (アクセサ)
アクセサ public RecordGrid.selection:RecordGridSelection

プロジェクトにより保持される、現在の Selection。


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

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

説明

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

オーバーライド

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

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

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

説明

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

ui (アクセサ)
アクセサ public RecordGrid.ui:RecordGridUI

このコントロールの UI オブジェクト (RecordGridUI など)

オーバーライド

オーバーライドしないでください。代わりに RecordGrid.ui-object をオーバーライドしてください。

vertical-grid-line-width (非ローカル オプション)
public RecordGrid.vertical-grid-line-width:any

列の間に引くグリッド線の幅。





メソッド詳細
become-active (メソッド)
public {RecordGrid.become-active forward?:bool = true}:bool

アクティブ化に対して応答します。

説明

この ActiveTraversor がアクティブになったときに、ActiveTraversalContainer によって呼び出されます。また ActiveTraversor のアクティブ化リクエストとしてユーザーが呼び出す場合もあります。
forward?: トラバースが前方に移動する場合 (Tab キー) は true、後方に移動する場合 (Shift + Tab キー) は false です。一般にユーザー コードでは既定値 true を使用します。

戻り値

このオブジェクトがアクティブになる予定であれば true、それ以外の場合は false です。

become-active-from-traversal (メソッド)
public {RecordGrid.become-active-from-traversal
forward?:bool = true
}:bool

トラバースによるアクティブ化に応答します。

説明

このクラスの既定の実装では、ActiveTraversor.become-active が呼び出されます。トラバースとその以外のアクティブ化方法とを区別する必要がある場合にのみ、既定の実装をオーバーライドします。
forward?: トラバースが前方に移動する場合 (Tab キー) は true、後方に移動する場合 (Shift + Tab キー) は false です。一般にユーザー コードでは既定値 true を使用します。

戻り値

このオブジェクトがアクティブになる予定であれば true、それ以外の場合は false です。

create-command (メソッド)
public {RecordGrid.create-command name:String}:#Command

時間をかけてコマンドを作成します。

説明

通常は直接呼び出されません。代わりに、CommandContext.get-command を呼び出すことを検討してください。

オーバーライド

要求されたときにこの CommandContext で動的にインスタンス化する必要があるコマンドの場合は、このメソッドをオーバーライドします。スーパークラスから動的に作成されたコマンドも同様に継承したい場合は、必ずこのメソッドのスーパークラスの実装も呼び出してください。

なお、コマンドは、クラスのコンストラクタでメソッド CommandContext.add-command を呼び出して指定することもできます。パフォーマンスの理由と、サブクラスでコマンドをオーバーライドできるようにするために、このメソッドを代わりに使用することを推奨します。

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

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

説明

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

delete-selection (メソッド)
public {RecordGrid.delete-selection}:void

現在の選択範囲を削除します。


deselect-column (メソッド)
public {RecordGrid.deselect-column column:BaseRecordGridColumn}:void

現在の選択範囲から列を削除します。


deselect-record (メソッド)
public {RecordGrid.deselect-record index:int}:void

現在の選択範囲からレコードを削除します。


deselect-region (メソッド)
public {RecordGrid.deselect-region region:RecordGridRegion}:void

現在の選択範囲から範囲を削除します。

region: 削除される RecordGridRegion です。

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

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

説明

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

注意事項

参照：canonical-test-value

get-test-tabular-attributes (メソッド)
public {RecordGrid.get-test-tabular-attributes
}:(full-size:int, min-visible-row:int, max-visible-row:int)

ビジュアル テスト用に、表の行情報を返します。

戻り値

総行数、および目に表内の目に見える行の範囲。

get-test-tabular-data (メソッド)
public {RecordGrid.get-test-tabular-data
min-row:int,
max-row:int
}:(column-titles:StringVec, data:FastArray)

ビジュアル テスト用に、表データを返します。

min-row: データが取得される最初の行のインデックス。
max-row: データが取得される最後の行のインデックス。

戻り値

列ヘッダーの StringVec そして、テーブルデータを含む FastArray が次に続きます。 column-titles のサイズは列数を示します。data のサイズは column-titles.size * (max-row - min-row) です。

grid-objects-at (メソッド)
public {RecordGrid.grid-objects-at
x:Distance,
y:Distance
}:(cell:#RecordGridCell, record-index:int, column-index:int )

グリッド内の特定位置のグリッド オブジェクトの情報を取得します。

説明

このメソッドは、特定の列、レコード、またはセルでの動作を必要とする、グリッド上のポインタ イベント ハンドラで使います。
ポイントが列またはレコードには関連し、セルには関連しない場合 (たとえば、ポイントがセルの間、column-header または record-selector 上にある場合など) があることに注意してください。

戻り値


modify-last-selected-region (メソッド)
public {RecordGrid.modify-last-selected-region
region:RecordGridRegion
}:void

現在の選択の最後の領域を置き換えます。

region: 最後に選択された領域に置き換わる RecordGridRegion です。この値が RecordGrid のレコードまたは列の境界を超えて領域を記述する場合は、エラーがスローされます。

説明

領域が現在選択されていない場合は、region が単一の選択領域となります。

move-column (メソッド)
public {RecordGrid.move-column
source-index:int,
destination-index:int
}:void

グリッド内でRecordGridColumnを移動させます。

source-index: このグリッド上を移動させられるRecordGridColumnのインデックスです。
destination-index: source-indexで設定されるRecordGridColumnの移動先のインデックスです。

説明

このメソッドは列をRecordGridColumnGroup外部から内部へ、または内部から外部へは移動させません。このような場合、何の作用もなくリターンされます。この制限は今後のリリースでは取り除かれる可能性があります。
導入: バージョン 7.0

note-column-changed (メソッド)
public {RecordGrid.note-column-changed
column:BaseRecordGridColumn,
property-name:String
}:void

columns の 1 つが変更されたことをグリッドに通知します。

property-name: String。 変更された列のプロパティ。空の文字列に等しい場合、列全体が変更されたことを意味します。

説明

このメソッドは columns コレクションが変更されたときに呼び出されます。アプリケーションでは通常呼び出す必要はありません。

オーバーライド

このメソッドの既定の実装では、コントロールの ui-object で同名のメソッドを呼び出します。通常このメソッドの実装ではスーパー実装も呼び出します。

note-current-record-changed (メソッド)
protected {RecordGrid.note-current-record-changed
index-change?:bool,
identity-change?:bool
}:void

current-index への変更および/または current レコードの識別情報の変更を示すために呼び出されます。

説明

このメソッドの既定実装は、非同期処理で CurrentRecordChanged イベントを生成し、キューに投入します。

オーバーライド

この変更に対し同期的に応答するサブクラスは、必ずスーパー実装も呼び出すよう、このメソッドをオーバーライドする必要があります。

note-record-set-event (メソッド)
public {RecordGrid.note-record-set-event ev:RecordSetEvent}:void

RecordSetEvent が RecordSetDisplay.records プロパティによって処理されたことをこのレコード グリッドに通知します。

オーバーライド

ディスプレイの元のデータに起こった変更に応答するには、このメソッドをオーバーライドします。基本実装では、関連するレコードセットのサイズが変更したときに、current-index プロパティが有効範囲内にとどまるようになっています。したがって、実装では必ずスーパー実装を最初に呼び出してから、追加のアクションを実行してください。

note-row-options-changed (メソッド)
public {RecordGrid.note-row-options-changed
row:RecordGridRowOptions,
property-name:String
}:void

RecordGridRowOptions のいずれかが変更されたことをグリッドに通知します。

property-name: String。 変更された行のプロパティ。空の文字列に等しい場合、行全体が変更されたことを意味します。

説明

現在、唯一サポートされている RecordGridRowOptions は、RecordGrid.header-options です。
このメソッドは行が変更されたときに呼び出されます。アプリケーションでは通常呼び出す必要はありません。

オーバーライド

このメソッドの既定の実装では、コントロールの ui-object で同名のメソッドを呼び出します。通常このメソッドの実装ではスーパー実装も呼び出します。

on-context-menu-event (メソッド)
public {RecordGrid.on-context-menu-event ev:ContextMenuEvent}:void

ContextMenuEvent イベントのスタティック イベント ハンドラ。

説明

スタティック イベント ハンドラの一般的な情報については、GuiEventTarget.on-pointer-event を参照してください。

on-selection-changed (メソッド)
public {RecordGrid.on-selection-changed sc:SelectionChanged}:void

SelectionChanged イベントのスタティック イベント ハンドラ。

説明

スタティック イベント ハンドラの一般的な情報については、GuiEventTarget.on-pointer-event を参照してください。

option-lookup-here (メソッド)
public {RecordGrid.option-lookup-here
key:OptionKey,
local?:bool
}:(item:#OptionItem, local-key?:bool)

オプション検索ステップを実行します。

key: 検索されるオプションの OptionKey。
local?: bool で、このオブジェクトがオプション検索の開始場所である場合は true、オプション検索がこのオブジェクトの子孫から開始した場合は false です。

戻り値

返される OptionItem には、該当する key のバインドが含まれます (このオブジェクトで存在する場合)。返される bool は、key がローカル オプション キーの場合は true です。この場合、このオブジェクト以降のオプション検索は行なわれません。

プログラミング注意事項

主に内部使用を目的としています。

オーバーライド

クラスが OptionKey とバインディング オプションのマッピングに非標準のアルゴリズムを実装する場合は、オーバーライドされます。

propagate-option-change (メソッド)
public {RecordGrid.propagate-option-change
item:OptionItem,
removed?:bool
}:void

このオブジェクト、および該当する場合はそのオプションの子孫にオプションが変更されたことを通知します。

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

注意事項

このオブジェクトのオプション変更通知メソッドが呼び出され、さらにオプションが非ローカル オプションの場合は、 OptionListInterface.notify-option-children を呼び出して、この通知をこのオブジェクトのオプションの子に伝えます。

プログラミング注意事項

option-list パッケージでの内部使用を目的としています。

オーバーライド

通常はオーバーライドされません。

refresh-automatic-columns (メソッド)
protected {RecordGrid.refresh-automatic-columns}:void

columns コレクションの自動生成 RecordGridColumn を RecordGrid.record-source に同期させます。

説明

このメソッドは、RecordGrid.automatic-columns? プロパティで説明されている「リフレッシュ」操作を実装します。詳細はこのプロパティの説明を参照してください。
RecordGrid.automatic-columns? が false の場合、このメソッドを呼び出しても効果はありません。

オーバーライド

record-source の fields コレクションとグリッドの columns コレクションの同期に使われるアルゴリズムを変更するには、このメソッドをオーバーライドします。
RecordGrid.automatic-columns? で説明されている基本的な規則を変更する場合は、必ず詳細な説明を付けてください。

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

すべてのレコード、列、領域、またはその組み合わせを選択します。


select-column (メソッド)
public {RecordGrid.select-column
column:BaseRecordGridColumn,
additive?:bool = false
}:void

列を選択します。

説明

additive? が true の場合、列が既存の選択に追加されます。それ以外は、既存の選択がクリアされます。
RecordGridColumnGroup が引数として指定されると、該当グループの下のすべての RecordGridColumn が選択されます。

select-column-range (メソッド)
public {RecordGrid.select-column-range
start-column:BaseRecordGridColumn,
end-column:BaseRecordGridColumn,
additive?:bool = false
}:void

列範囲を選択します。

説明

RecordGrid.select-column を参照してください。

select-nothing (メソッド)
public {RecordGrid.select-nothing}:void

このコンテキストの選択をクリアします。


select-record (メソッド)
public {RecordGrid.select-record
index:int,
additive?:bool = false
}:void

レコードを選択します。

説明

additive? が true の場合、既存の選択範囲にレコードが追加されます。 その他の場合、既存の選択範囲がクリアされます。

select-record-range (メソッド)
public {RecordGrid.select-record-range
start-index:int,
end-index:int,
additive?:bool = false
}:void

レコード範囲を選択します。

説明

RecordGrid.select-record を参照してください。

select-region (メソッド)
public {RecordGrid.select-region
region:RecordGridRegion,
additive?:bool = false
}:void

四角形の領域を選択します。

region: 選択される RecordGridRegion です。この値が RecordGrid のレコードまたは列の境界を超えて領域を記述している場合は、エラーがスローされます。
additive?: true の場合、領域が既存の選択に追加されます。その他の場合、既存の選択範囲がクリアされます。

set-frozen-region (メソッド)
public {RecordGrid.set-frozen-region
rows:int,
columns:int,
row-start:int = -1,
column-start:int = -1
}:void

適切にロックされる必要がある行数と列数、および表示する行と列が始まる場所を設定します。

rows: 固定する行のカウントです。
columns: 固定する列のカウントです。
row-start: 固定する最初の行 (非表示になる行の前) のインデックスです。
column-start: 固定する最初の列 (非表示になる行の前) のインデックスです。

説明

使用中の一部の RecordGridUI によってサポートされない場合は、このメソッドを呼び出しても視覚的効果は何もありません。

test-record (メソッド)
public {RecordGrid.test-record action:String, ...}:void

オブジェクトのテスト アクションを記録します。

action: 記録するアクションの名前。アクションは、次のいずれかである必要があります。
...: アクションの引数。引数は、テスト環境に必要な型に一致していなければなりません。ただし、必要に応じて String に自動的に変換される型と値もあります。TestRecorder.record-values-by-index? も参照してください。

説明

このメソッドは、ユーザー インターフェイス操作に応じて、オブジェクトがその操作に反応する前に呼び出す必要があります。システムはオブジェクトの代わりに多くのイベントをまとめて記録します。このような包括的な記録が行われないようにするには、ユーザー インターフェイス操作に関連付けられているイベントの GuiInputEvent.test-recorded? フラグを、記録前に true に設定します。
通常のプログラムの API からの呼び出しにより変更が生じる場合は、このメソッドを呼び出さないでください。ユーザー インターフェイス操作が行われなくてもその呼び出しが発生する可能性があるからです。
これらのルールに従わない場合、エラーが発生するか、再生時にアクションが重複する可能性があります。
記録を準備するには (記録をコミットする必要があるかどうかが事前にわからない場合)、代わりに TestRecorder.prepare-recording を使用します。

注意事項

テスト オブジェクトとするには、null 以外の test-name または test-type-name が必要です。ビジュアル テスト インフラストラクチャは、テスト オブジェクト以外は見つけられません。記録されたアクションが正しく再生されないため、オブジェクトがテスト オブジェクトでない場合、このメソッドはエラーをスローします。

オーバーライド

通常はオーバーライドされません。呼び出し側は test-visible? のチェック後に TestRecorder.record を直接呼び出すことができます。そのため、このメソッドをオーバーライドしてもこのオブジェクトに対するすべての記録呼び出しをインターセプトできません。

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

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

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

説明

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

注意事項

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

注意事項

参照：canonical-test-value

オーバーライド

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

unset-frozen-region (メソッド)
public {RecordGrid.unset-frozen-region}:void

このグリッドから固定設定をすべて削除します。