ProgressBar

時間のかかる操作の進捗状況を視覚的に示すコントロールです。

説明

一般的に、アプリケーションがファイルのコピーやドキュメントの印刷などのタスクを実行する際に使用されます。アプリケーションのユーザーは、視覚的な表示がないと、アプリケーションが応答していないと考える場合があります。アプリケーションで ProgressBar を使用すると、アプリケーションが長時間のタスクを実行していて、応答中であることをユーザーに示すことができます。

ProgressBar.min-value と ProgressBar.max-value は、ProgressBar の範囲を決定します。

ProgressBar.value は、アプリケーションの操作の完了に向けての進捗状況を表わします。

ProgressBar.indeterminate? プロパティは、ProgressBar が確定状態であるかどうかを決定します。

既定では選択することも、フォーカスを受け取ることもできません。

注意事項

このオブジェクトは、"ProgressBar"、"ProgressBar/caption"、"ProgressBar/progress"のスタイルルールを記述することによってスタイル化することが出来ます。詳細はスキンが適用された他のコントロールをご覧下さい。

プロパティ継承 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?

プロパティ継承 ValueControl: form-value

プロパティ継承 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-type-name, 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

メソッド継承 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: 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, 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, 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

メソッド継承 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 (コンストラクタ)

このクラスを作成します。

min-value: ProgressBar の最小値。

max-value: ProgressBar の最大値。

value: ProgressBar の値。

ui-object: 描画とイベントを処理する UI デリゲート。

...: 追加オプションを指定します。

caption (ローカルオプション)

進捗状況バーのキャプションです。

説明

ProgressBar の UI は、キャプションを表示するかどうか、また、キャプションの表示場所と表示方法を決定します。

このオプションの変更ハンドラは、ProgressBar.react-to-visual-change を呼び出します。UI はこの呼び出しに応答して、キャプションを更新します。

caption-placement (ローカルオプション)

進捗バーにおけるキャプションの垂直な線です。

説明

ProgressBar の UI は、キャプションを表示するかどうか、また、キャプションの表示場所と表示方法を決定します。

このオプションの変更ハンドラは、ProgressBar.react-to-visual-change を呼び出します。UI はこの呼び出しに応答して、キャプションを更新します。

有効な値は、"inline"、"above"、"below"です。

導入: バージョン 6.0

determinate-skin (ローカルオプション)

確定状態のProgressBarのトラックの外観をよくするために、このコントロールで使用される定義です。

説明

このオプションは、この Control が SkinnableControlUI や SkinSpec の使用をサポートする ControlSkin で使用される場合のみ意味があります

導入: バージョン 6.0

has-value? (アクセサ)

ProgressBar に値があるかどうかを示します。

注意事項

進捗状況バーが確定の場合、すなわち ProgressBar.indeterminate? が false の場合、値を持つので、この関数は true を返します。それ以外の場合は、false を返します。

indeterminate-skin (ローカルオプション)

未確定状態ProgressBarのトラックの外観をよくするために、このコントロールで使用される定義です。

説明

このオプションは、この Control が SkinnableControlUI や SkinSpec の使用をサポートする ControlSkin で使用される場合のみ意味があります

導入: バージョン 6.0

indeterminate? (ローカルオプション)

ProgressBar が確定または不確定であるかどうかを判断します。

注意事項

ProgressBar が確定状態である場合、つまり ProgressBar.indeterminate? が false である場合、ProgressBar.min-value が ProgressBar.max-value を超えるとエラーがスローされます。 ProgressBar が確定状態である場合、ProgressBar.value は常に ProgressBar.min-value と ProgressBar.max-value の間に調節されます。

説明

通常、不確定 ProgressBar は、連続的にアニメーションを表示して、継続時間の不明な操作が実行されていることを示します。

既定では ProgressBar は確定です。

max-value (アクセサ)

ProgressBar の最大値を決定します。

説明

ProgressBar が確定状態である場合、つまり ProgressBar.indeterminate? が false である場合、val が ProgressBar.min-value よりも少なければエラーがスローされます。また、ProgressBar が確定状態であり、ProgressBar.value が val を超している場合、val が使用されます。

min-value (アクセサ)

ProgressBar の最小値を示します。

説明

ProgressBar が確定状態である場合、つまり ProgressBar.indeterminate? が false である場合、val が ProgressBar.max-value を超していればエラーがスローされます。また、ProgressBar が確定状態であり、ProgressBar.value が val より少ない場合、val が使用されます。

percent-complete (アクセサ)

progress-color (ローカルオプション)

UI で進捗状況バーを表示する色を示します。

説明

ハンドラ呼び出し ProgressBar.react-to-visual-change が変更され、UI オブジェクトが進捗状況バーの色を更新して応答できるようになります。

progress-frame-skin (ローカルオプション)

埋められていないProgressBarトラックの外観をよくするために、このコントロールで使用される定義です。

説明

このオプションは、この Control が SkinnableControlUI や SkinSpec の使用をサポートする ControlSkin で使用される場合のみ意味があります

導入: バージョン 6.0

style-element (アクセサ)

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

説明

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

オーバーライド

Visual のサブクラスのスタイルが他のオブジェクトと異なる場合、このゲッターは適切な文字列を返すようにオーバーライドされる必要があります。慣例では,この文字列はクラス名または、オブジェクトを生成するマークアップの名前です。

オーバーライドでは、空の文字列でないかぎり、self._style-elementを返さなければなりません。

導入: バージョン 6.0

value (アクセサ)

ProgressBar の値。

注意事項

「ProgressBar.set-value-with-events」も参照してください。

説明

進捗状況バーが確定である場合、すなわち ProgressBar.indeterminate? が false の場合、ProgressBar の値は常に ProgressBar.min-value と ProgressBar.max-value で指定された ProgressBar の範囲内になります。

become-active (メソッド)

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

説明

この ActiveTraversor がアクティブになったときに、ActiveTraversalContainer によって呼び出されます。また ActiveTraversor のアクティブ化リクエストとしてユーザーが呼び出す場合もあります。

forward?: トラバースが前方に移動する場合 (Tab キー) は true、後方に移動する場合 (Shift + Tab キー) は false です。一般にユーザーコードでは既定値 true を使用します。

戻り値

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

create-default-ui-object (メソッド)

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

説明

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

set-value-with-events (メソッド)

ProgressBar の値を設定してから、値が実際に変更されたら、ValueChanged イベントを発生させ、次に ValueFinished イベントを発生させます。

注意事項

ValueChanged イベントと ValueFinished イベントを発生させたくない場合、ProgressBar.value セッターを使用して、ProgressBar の値を直接設定します。

unset-value (メソッド)

update-view (メソッド)

ProgressBar およびこれを含む View の再描画を要求します。

immediate?: true の場合、更新は直ちに実行されます。それ以外は、 ProgressBar が最大速度毎秒 20 回で物理的に更新され、ProgressBar を含むビュー全体は毎秒 2 回の頻度で更新されます。

説明

ProgressBar は、時間のかかる操作の進捗状況を表示するために使用されます。イベントループに戻ることがない単一のコードブロック内で操作全体が実行される場合は、操作全体が完了するまで、画面が再描画されません。このメソッドを使用すると、この状態での画面のリフレッシュが簡単になります。

最終の再描画以降にかなりの時間が経過しないと、再描画操作を実行しないため、このメソッドをタイトなループから呼び出すことができます。。他の方法で進捗状況バーを更新することがない、時間のかかる操作を開始しようとする場合に、immediate? = true でこのメソッドを呼び出してください。

ProgressBar を含む View の全体は、定期的に更新されるので、他のウィンドウがこのウィンドウの上にドラッグされると、表示内容が再描画されます。