[]
        
(Showing Draft Content)

Inputman.GcTipNotifier

GcTipNotifier クラス

階層

  • GcTipNotifier

コンストラクタ

constructor

プロパティ

direction

direction: TipDirection

ツールチップを表示する方向を設定または取得します。

参照:setDirection

directionPriority

directionPriority: TipDirection[]

ツールチップを表示する方向の優先順位を設定または取得します。

参照:setDirectionPriority

failMessage

failMessage: string

検証が失敗したときにツールチップに表示するメッセージを設定または取得します。

参照:setFailMessage

position

position: TipPosition

ツールチップを表示する詳細位置を設定または取得します。

参照:setPosition

successMessage

successMessage: string

検証が成功したときにツールチップに表示するメッセージを設定または取得します。

参照:setSuccessMessage

template

template: string

ツールチップのHTMLのテンプレートを設定または取得します。

参照:setTemplate

メソッド

destroy

  • destroy(): void
  • ツールチップのすべての通知スタイルを削除します。

    gcTipNotifier.destroy();
    gcTipNotifier = null;
    

    戻り値 void

onClear

  • onClear(): void
  • ツールチップを非表示にします。

    gcTipNotifier.onClear();
    

    戻り値 void

onFail

  • onFail(): void
  • 検証が失敗した場合のツールチップを表示します。通常は背景が赤色のツールチップが表示されます。

    gcTipNotifier.onFail();
    

    戻り値 void

onSuccess

  • onSuccess(): void
  • 検証が失敗した場合のツールチップを表示します。通常は背景が緑色のツールチップが表示されます。

    gcTipNotifier.onSuccess();
    

    戻り値 void

refresh

  • refresh(): void
  • gcTipNotifierをリフレッシュします。その後、gcTipNotifierはツールチップの表示位置を更新します。

    gcTipNotifier.refresh();
    

    戻り値 void

setDirection

  • ツールチップを表示する方向を設定します。
    参照:direction

    gcTipNotifier.setDirection(GC.InputMan.TipDirection.top);
    

    引数

    戻り値 void

setDirectionPriority

  • ツールチップを表示する方向の優先順位を設定します。 表示する場所に画面上で十分なスペースが無い場合は、優先順位の方向に表示します。
    参照:directionPriority

    gcTipNotifier.setDirectionPriority([GC.InputMan.TipDirection.top , GC.InputMan.TipDirection.bottom]);
    

    引数

    戻り値 void

setFailMessage

  • setFailMessage(value: string): void
  • 検証が失敗したときにツールチップに表示するメッセージを設定します。
    参照:failMessage

    gcTipNotifier.setFailMessage('your input is incorrect.');
    

    引数

    • value: string

    戻り値 void

setPosition

  • ツールチップを表示する詳細位置を設定します。
    参照:position

    gcTipNotifier.setPosition(GC.InputMan.TipPosition.start);
    

    引数

    戻り値 void

setSuccessMessage

  • setSuccessMessage(value: string): void
  • 検証が成功したときにツールチップに表示するメッセージを設定します。
    参照:successMessage

    gcTipNotifier.setSuccessMessage("your input is correct.");
    

    引数

    • value: string

    戻り値 void

setTemplate

  • setTemplate(value: string): void
  • ツールチップのHTMLのテンプレートを設定します。
    参照:template

    gcTipNotifier.setTemplate('<div style="color:green;font-family:Segoe UI;font-size:10px;">{!message}</div>');
    

    引数

    • value: string

    戻り値 void