[]
デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Inputman.GcStepper

GcStepper クラス

階層

  • GcStepper

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

  • const gcStepper = new GC.InputMan.GcStepper({
    steps: [
        {
            target: () => document.getElementById('form1'),
            label: 'step1',
        },
        {
            target: () => document.getElementById('form2'),
            label: 'step2',
        },
    ]
});

    引数

    • el: HTMLElement

      ホストされているコントロール要素。

    • config: GcStepperConfig

      GcStepperの設定情報。

    戻り値 GcStepper

プロパティ

読み取り専用 activeIndex

activeIndex: number

現在のステップのインデックスを取得します。

animation

animation: boolean

アニメーションを有効にするかどうかを取得または設定します。​

読み取り専用 componentName

componentName: string

コンポーネント名（'GcStepper'）を取得します。

enabled

enabled: boolean

コントロールやオブジェクトを有効にするかどうかを示す値を設定または取得します。

headerPosition

headerPosition: StepperHeaderPosition

ヘッダー領域の位置を取得または設定します。

height

height: number | string

コントロールの高さを設定もしくは取得します。

labelPosition

labelPosition: StepperLabelPosition

ラベルの位置を取得または設定します。

読み取り専用 length

length: number

総ステップ数を取得します。

linear

linear: boolean

線形モードであるかどうかを取得または設定します。

orientation

orientation: StepperOrientation

方向を取得または設定します。

readOnly

readOnly: boolean

コントロールを読み取り専用モードにするかどうかを取得または設定します。

stepType

stepType: StepperStepType

ステップ識別子の表示タイプを取得または設定します。

読み取り専用 steps

steps: IStepperStep[]

​​すべてのステップオブジェクトを取得します。​​

visible

visible: boolean

コントロールをページに表示するかどうかを示す値を設定または取得します。

width

width: number | string

コントロールの幅を設定もしくは取得します。

メソッド

addEventListener

  • addEventListener(eventName: GcStepperEvent, func: (sender: this, eventArgs?: object): void): void

  • 指定したイベントが発生したときに実行する処理を設定します。

    function stepChangedHandler(sender, args){
    console.log("Step Changed.");
}
gcStepper.addEventListener(GC.InputMan.GcStepperEvent.StepChanged, stepChangedHandler);

    引数

    • eventName: GcStepperEvent

      イベントの種類を表す文字列（大文字と小文字を区別しません）

    • func: (sender: this, eventArgs?: object): void

      イベントが発生したときに実行する処理

        • (sender: this, eventArgs?: object): void

        • 引数

          • sender: this
          • オプション eventArgs: object

          戻り値 void

    戻り値 void

destroy

  • destroy(): void

  • 現在のコントロールを破棄します。

    戻り値 void

getHost

  • getHost(): HTMLElement

  • GcStepperのhost要素を取得します。

    戻り値 HTMLElement

goTo

  • goTo(index: number): void

  • 指定されたステップに移動します。

    引数

    • index: number

      指定されたステップのインデックス。

    戻り値 void

next

  • next(): void

  • 次のステップに移動します。

    戻り値 void

previous

  • previous(): void

  • 前のステップに移動します。

    戻り値 void

removeEventListener

  • removeEventListener(eventName: GcStepperEvent, func?: (sender: this, eventArgs?: object): void): void

  • addEventListenerで登録したイベントを削除します。

    gcStepper.removeEventListener(GC.InputMan.GcStepperEvent.StepChanged, stepChangedHandler);

    引数

    • eventName: GcStepperEvent

      イベントの種類を表す文字列（大文字と小文字を区別しません）

    • オプション func: (sender: this, eventArgs?: object): void

      コントロールから削除するイベント処理

        • (sender: this, eventArgs?: object): void

        • 引数

          • sender: this
          • オプション eventArgs: object

          戻り値 void

    戻り値 void

イベント

StepChanged

StepChanged: (sender: GcStepper, args: StepperStepChangedEventArgs): void

ステップ切り替えが完了した後に発生します。​​

param

イベントをトリガーしたGcStepperオブジェクト。

param

イベントパラメータ。

型宣言

StepChanging

StepChanging: (sender: GcStepper, args: StepperStepChangingEventArgs): void

​​ステップの切り替え前に発生します。​​

param

イベントをトリガーしたGcStepperオブジェクト。

param

イベントパラメータ。

型宣言