クラス ProgressView
java.lang.ObjectSE
org.springframework.shell.component.view.control.AbstractControl
org.springframework.shell.component.view.control.AbstractView
org.springframework.shell.component.view.control.BoxView
org.springframework.shell.component.view.control.ProgressView
ProgressView は進行状況インジケーターを表示するために使用されます。デフォルトは ネストされたクラスの概要
ネストされたクラス修飾子と型クラス説明static interfaceProgressViewセルコンポーネントのコンテキスト。static final recordProgressViewの現在の実行状態をカプセル化します。static final recordViewEventは進行が終了したことを示します。static class進行状況ビュー内の項目を定義します。static final record進行が開始されたことを示すViewEvent。static final record進行状態が変更されたことを示すViewEvent。static final recordProgressView.ProgressStateを使用するイベントの場合はViewEventArgs。コンストラクター概要
コンストラクターコンストラクター説明tickStart 0とtickEnd 100を使用してビューを構築します。ProgressView(int tickStart, int tickEnd) tickStart 0とtickEnd 100を使用してビューを構築します。ProgressView(int tickStart, int tickEnd, ProgressView.ProgressViewItem... items) tickStartとtickEndの指定された境界を使用してビューを構築します。ProgressView(ProgressView.ProgressViewItem... items) 方法の概要
修飾子と型メソッド説明protected voiddrawInternal(Screen screen) 場合によっては、ボックス上部の境界でこのビューとタイトルの周囲にボックスを描画します。進行状況の説明を取得します。getState()このProgressViewの状態を取得します。voidsetDescription(StringSE description) 進行状況の説明を設定します。voidsetSpinner(Spinner spinner) 使用する明示的なスピナーを設定します。voidsetTickValue(int value) ティック値を設定します。voidstart()ランタイムロジックを開始します。voidstop()ランタイムロジックを停止します。voidtickAdvance(int count) tickValueを指定されたカウントだけ進めます。クラス org.springframework.shell.component.view.control.BoxView から継承されたメソッド
drawBackground, getBackgroundStyle, getInnerRect, isShowBorder, setBackgroundColor, setBorderPadding, setFocusedTitleColor, setFocusedTitleStyle, setRect, setShowBorder, setTitle, setTitleAlign, setTitleColor, setTitleStyleクラス org.springframework.shell.component.view.control.AbstractView から継承されたメソッド
destroy, dispatch, dispatchKeyRunCommand, dispatchMouseRunCommand, dispatchRunnable, draw, focus, getDrawFunction, getEventLoop, getHotKeyBindings, getHotKeyHandler, getKeyBindings, getKeyHandler, getLayer, getMouseBindings, getMouseHandler, getViewCommands, getViewService, hasFocus, init, initInternal, onDestroy, registerHotKeyBinding, registerHotKeyBinding, registerHotKeyBinding, registerKeyBinding, registerKeyBinding, registerKeyBinding, registerMouseBinding, registerMouseBinding, registerMouseBinding, registerViewCommand, runViewCommand, setDrawFunction, setEventLoop, setLayer, setViewService, shortcutクラス org.springframework.shell.component.view.control.AbstractControl から継承されたメソッド
getRect, getThemeName, getThemeResolver, resolveThemeBackground, resolveThemeForeground, resolveThemeSpinner, resolveThemeStyle, setThemeName, setThemeResolverクラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース org.springframework.shell.component.view.control.Control から継承されたメソッド
getRect, setThemeName, setThemeResolver
コンストラクターの詳細
ProgressView
public ProgressView()ProgressView
public ProgressView(int tickStart, int tickEnd) - パラメーター:
tickStart- ティックスタートtickEnd- ティックエンド
ProgressView
- パラメーター:
items- 進捗状況ビュー項目
ProgressView
tickStartとtickEndに指定された境界を使用してビューを構築します。tickStartは 0 以上である必要があります。tickEndはtickStartよりも大きい必要があります。定義された進行状況ビュー項目を使用します。- パラメーター:
tickStart- ティックスタートtickEnd- ティックエンドitems- 進捗状況ビュー項目
方法の詳細
getDescription
進行状況の説明を取得します。- 戻り値:
- 進捗状況の説明
setDescription
進行状況の説明を設定します。項目内でテキスト項目として使用されます。- パラメーター:
description- 進捗状況の説明
setSpinner
使用する明示的なスピナーを設定します。- パラメーター:
spinner- 使用するスピナー
start
public void start()ランタイムロジックを開始します。すでに開始されている進行状況への呼び出しは効果がありません。stop
public void stop()ランタイムロジックを停止します。drawInternal
クラスからコピーされた説明:BoxView場合によっては、ボックス上部の境界でこのビューとタイトルの周囲にボックスを描画します。定義されている場合は、draw functionも呼び出します。- オーバーライド:
- クラス
BoxViewのdrawInternal - パラメーター:
screen- スクリーン
tickAdvance
public void tickAdvance(int count) tickValueを指定されたカウントだけ進めます。負のカウントの場合は後方へ進むことに注意してください。- パラメーター:
count- ティック値を進めるカウント
setTickValue
public void setTickValue(int value) 目盛りの値を設定します。値がそれぞれtickStartまたはtickEndより低い場合、または高い場合、tickValueは下限 / 上限に設定されます。つまり、tickValueは常に範囲内に保たれます。- パラメーター:
value- 設定する新しいティック値
getState
このProgressViewの状態を取得します。- 戻り値:
- ビューの進行状況