Inputman.GcInputManBase

GcInputManBase クラス

階層

GcInputManBase

コンストラクタ

constructor

メソッド

イベント

コンストラクタ

constructor

new GcInputManBase(inputEl: HTMLInputElement | HTMLTextAreaElement, config?: GcInputManBaseConfig): GcInputManBase

引数
- inputEl: HTMLInputElement | HTMLTextAreaElement
  
  コントロールをホストするHTML要素
- オプション config: GcInputManBaseConfig
  
  コントロールを初期化するときに設定するプロパティ設定
戻り値 GcInputManBase

プロパティ

autoDropDown

autoDropDown: boolean

コントロールがフォーカスを取得すると、自動的にドロップダウンを開くかどうかを設定します。

参照：setAutoDropDown

autoScale

autoScale: boolean

テキストが入力幅から見きれてしまうときに、テキストを入力幅に合わせて縮小するかどうかを設定します。

参照：setAutoScale

読み取り専用 componentName

componentName: string

コンポーネントの名称を取得します。例：'GcTextBox', 'GcNumber', 'GcMask'

container

container: HTMLElement

コントロールを配置しているコンテナを設定します。コントロールの下部にドロップダウンを表示するために十分なスペースがあるかどうかをチェックし、ドロップダウンを反転してコントロールの上部に表示するかどうかを決定します。

参照：setContainer

copiedMessage

copiedMessage: string

コピーボタンを押下した後にツールチップで表示するテキストを設定もしくは取得します。

copyMessage

copyMessage: string

コピーボタンのマウスオーバーでツールチップで表示するテキストを設定もしくは取得します。

dropDownButtonVisible

dropDownButtonVisible: boolean

ドロップダウンボタンを動的に表示または非表示するかどうかの値を設定します。

参照：setDropDownButtonVisible

読み取り専用 dropDownWindow

dropDownWindow: IDropDownContainer

このコントロールのドロップダウンウィンドウを取得します。ドロップダウンがない場合は undefined を返し、複数のドロップダウンがある場合は最後のドロップダウンを返します。

参照：getDropDownWindow

enabled

enabled: boolean

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

参照：getEnabled 参照：setEnabled

floatingLabelDirection

floatingLabelDirection: FloatingLabelDirection

フローティングラベルの表示方向を設定もしくは取得します。

floatingLabelText

floatingLabelText: string

フローティングラベルの表示テキストを設定もしくは取得します。

floatingLabelType

floatingLabelType: FloatingLabelType

フローティングラベルの表示パターンを設定もしくは取得します。

height

height: number | string

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

helpContent

helpContent: string

ヘルプボタンのマウスオーバーでツールチップで表示するテキストを設定もしくは取得します。

maxHeight

maxHeight: number | string

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

maxWidth

maxWidth: number | string

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

minHeight

minHeight: number | string

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

minScaleFactor

minScaleFactor: number

テキストを縮小するときの最小倍率を設定します。

参照：setMinScaleFactor

minWidth

minWidth: number | string

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

readOnly

readOnly: boolean

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

参照：getReadOnly 参照：setReadOnly

showClearButton

showClearButton: boolean

クリアボタンを表示するかどうかを設定します。

参照：setShowClearButton

showCopyButton

showCopyButton: boolean

コピーボタンを表示するかどうかを設定もしくは取得します。

showHelpButton

showHelpButton: boolean

ヘルプボタンを表示するかどうかを設定もしくは取得します。

tabIndex

tabIndex: number

コントロールのtabIndexを取得または設定します。

visible

visible: boolean

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

参照：setVisible

width

width: number | string

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

メソッド

autoScaleText

autoScaleText(): void

テキストが入力幅から見きれてしまうときに、入力幅に合わせてテキストを調整します。

戻り値 void

clear

clear(): void

コントロールの内容をクリアします。

戻り値 void

createDropDown

createDropDown(dropDownButtonAlignment?: DropDownButtonAlignment, showDropDown?: boolean): IDropDownContainer

ドロップダウンオブジェクトをInputManのコントロールに追加します。

var gcTextBox = new GC.InputMan.GcTextBox(document.getElementById("input"));
var gcTextBoxDropDown = gcTextBox.createDropDown(GC.InputMan.DropDownButtonAlignment.RightSide);
var gcTextBoxDropDownList = new GC.InputMan.GcListBox(gcTextBoxDropDown.getElement(), {
items:  ["item0", "item1", "item2", "item3", "item4", "item5", "item6", "item7"],
});

引数

オプション dropDownButtonAlignment: DropDownButtonAlignment

ドロップダウンボタンの表示位置を設定します。
オプション showDropDown: boolean

戻り値 IDropDownContainer

deselectAll

deselectAll(): void

コントロールの文字列選択を解除します。

戻り値 void

getDisplayText

getDisplayText(): string

コントロールがフォーカスを持っていないときに表示される文字列を取得します。

戻り値 string

フォーカスを持っていないときに表示される文字列。

getDropDownWindow

getDropDownWindow(): IDropDownContainer

このコントロールのドロップダウンウィンドウを取得します。ドロップダウンがない場合は undefined を返し、複数のドロップダウンがある場合は最後のドロップダウンを返します。
参照：dropDownWindow

戻り値 IDropDownContainer

このコントロールのドロップダウンウィンドウを取得します。

getEnabled

getEnabled(): boolean

コントロールやオブジェクトを有効にするかどうかを示す値を取得します。
参照：enabled

戻り値 boolean

有効にする場合はtrue、それ以外はfalse。

getIsOverwrite

getIsOverwrite(): boolean

現在の編集モードが上書きに設定されているかどうかを取得します。

戻り値 boolean

上書きモードはtrue、挿入モードはfalse。

getLayoutElement

getLayoutElement(): HTMLElement

InputManのレイアウト要素を取得します。

戻り値 HTMLElement

InputManのレイアウト要素。この要素は通常、コントロールのサイズ設定に使用しますが、スタイル設定には使用しません。

getOriginalInputElement

getOriginalInputElement(): HTMLInputElement | HTMLTextAreaElement

オリジナルの入力要素を取得します。

戻り値 HTMLInputElement | HTMLTextAreaElement

オリジナルの入力要素

getReadOnly

getReadOnly(): boolean

コントロールを読み取り専用モードにするかどうかを取得します。
参照：readOnly

戻り値 boolean

読み取り専用の場合はtrue、それ以外はfalse。

getSelectedText

getSelectedText(): string

選択されているテキストの文字列を取得します。

var gcTextBox1 = FindIMControl("gcTextBox1");
gcTextBox1.setText("InputManJS");

var start = 0;
var length = 8;

gcTextBox1.setSelectionStart(start);
gcTextBox1.setSelectionLength(length);

var selText = gcTextBox1.getSelectedText();
alert(selText);

戻り値 string

選択されている文字列。

getSelectionLength

getSelectionLength(): number

選択されたテキストの文字数を取得します。

var gcTextBox1 = FindIMControl("gcTextBox1");
gcTextBox1.setText("InputManJS");

var start = gcTextBox1.getSelectionStart();
var length = gcTextBox1.getSelectionLength();

alert("選択開始位置：" + start + "\r\n" + "選択された文字数：" + length);

戻り値 number

選択されたテキストの文字数。

getSelectionStart

getSelectionStart(): number

選択されたテキストの開始点を取得します。

var gcTextBox1 = FindIMControl("gcTextBox1");
gcTextBox1.setText("InputManJS");

var start = gcTextBox1.getSelectionStart();
var length = gcTextBox1.getSelectionLength();

alert("選択開始位置：" + start + "\r\n" + "選択された文字数：" + length);

戻り値 number

開始点。

getText

getText(): string

コントロールの現在のテキストを取得します。

戻り値 string

コントロールのテキスト。

getUIInputElement

getUIInputElement(): HTMLInputElement | HTMLTextAreaElement

InputManのUIの入力要素を取得します。

戻り値 HTMLInputElement | HTMLTextAreaElement

InputManのUIの入力要素

getUseClipboard

getUseClipboard(): boolean

クリップボードにアクセスすることを許可するかどうかを設定します。

戻り値 boolean

getVisible

getVisible(): boolean

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

戻り値 boolean

selectAll

selectAll(): void

コントロールの文字列をすべて選択します。

戻り値 void

setAutoDropDown

setAutoDropDown(v: boolean): void

コントロールがフォーカスを取得すると、自動的にドロップダウンを開くかどうかを設定します。
参照：autoDropDown
```
gcTextBox.setAutoDropDown(true);
```
引数
- v: boolean
  
  自動的にドロップダウンを開く場合はtrue、それ以外はfalse。
戻り値 void

setAutoScale

setAutoScale(value: boolean): void

テキストが入力幅から見きれてしまうときに、テキストを入力幅に合わせて縮小するかどうかを設定します。
参照：autoScale 参照：minScaleFactor

引数
- value: boolean
  
  テキストが入力幅から見きれてしまうときに、テキストを入力幅に合わせて縮小するかどうかを表す値
戻り値 void

setContainer

setContainer(el: HTMLElement): void

コントロールを配置しているコンテナを設定します。コントロールの下部にドロップダウンを表示するために十分なスペースがあるかどうかをチェックし、ドロップダウンを反転してコントロールの上部に表示するかどうかを決定します。
参照：container
```
gcTextBox.setContainer(div);
```
引数
- el: HTMLElement
  
  ドロップダウンの表示場所はデフォルトではブラウザ領域で決定されます。ポップアップなどのダイアログ領域内で使用する場合は、本引数にダイアログのコンテナ要素を指定します。
戻り値 void

setDropDownButtonVisible

setDropDownButtonVisible(value: boolean): void

ドロップダウンボタンを動的に表示または非表示にします。
参照：dropDownButtonVisible
```
gcTextBox.setDropDownButtonVisible(false);
```
引数
- value: boolean
  
  ドロップダウンボタンを表示する場合はtrue、非表示にする場合はfalse。
戻り値 void

setEditMode

setEditMode(v: EditMode): void

コントロールの編集モードを設定します。

引数
- v: EditMode
  
  編集モードを示す値（EditMode列挙体）。
戻り値 void

setEnabled

setEnabled(v: boolean): void

コントロールやオブジェクトを有効にするかどうかを示す値を設定します。
参照：enabled

引数
- v: boolean
  
  有効にする場合はtrue、それ以外はfalse。
戻り値 void

setExitOnEnterKey

setExitOnEnterKey(value: ExitKey): void

フォーカスの移動方法を変更します。

var gcTextBox1 = FindIMControl("gcTextBox1");
gcTextBox1.setExitOnEnterKey(InputMan.ExitKey.Enter);

引数

value: ExitKey

戻り値 void

setExitOnLastChar

setExitOnLastChar(v: boolean): void

コントロールへの入力が終了したときに、自動的に次のコントロールへフォーカスを移動するかどうかを設定します。

引数
- v: boolean
  
  入力完了時に次のコントロールへフォーカスを移動する場合はtrue、それ以外はfalse。
戻り値 void

setExitOnLeftRightKey

setExitOnLeftRightKey(v: ExitOnLeftRightKey): void

矢印キーを使ったフォーカスの移動方法を設定します。

引数
- v: ExitOnLeftRightKey
  
  矢印キーを使ったフォーカスの移動方法を示す値（ExitOnLeftRightKey列挙体）。
戻り値 void

setFocus

setFocus(): void

コントロールにフォーカスを移動します。

戻り値 void

setMinScaleFactor

setMinScaleFactor(value: number): void

テキストを縮小するときの最小倍率を設定します。
参照：minScaleFactor 参照：autoScale

引数
- value: number
  
  最小倍率。
戻り値 void

setReadOnly

setReadOnly(v: boolean): void

コントロールを読み取り専用モードにするかどうかを設定します。
参照：readOnly

引数
- v: boolean
  
  読み取り専用の場合はtrue、それ以外はfalse。
戻り値 void

setSelectedText

setSelectedText(v: string): void

選択するテキストの文字列を設定します。

var gcTextBox1 = FindIMControl("gcTextBox1");
gcTextBox1.setText("InputManJS");

var start = 0;
var length = 8;

gcTextBox1.setSelectionStart(start);
gcTextBox1.setSelectionLength(length);

gcTextBox1.setSelectedText("Spread");

引数

v: string

選択するテキスト。

戻り値 void

setSelectionLength

setSelectionLength(length: number): void

選択するテキストの文字数を設定します。

var gcTextBox1 = FindIMControl("gcTextBox1");
gcTextBox1.setText("InputManJS");

var start = 0;
var length = 8;

gcTextBox1.setSelectionStart(start);
gcTextBox1.setSelectionLength(length);

var selText = gcTextBox1.getSelectedText();
alert(selText);

引数

length: number

選択するテキストの文字数。

戻り値 void

setSelectionStart

setSelectionStart(start: number): void

選択されたテキストの開始点を設定します。

var gcTextBox1 = FindIMControl("gcTextBox1");
gcTextBox1.setText("InputManJS");

var start = 0;
var length = 8;

gcTextBox1.setSelectionStart(start);
gcTextBox1.setSelectionLength(length);

var selText = gcTextBox1.getSelectedText();
alert(selText);

引数

start: number

開始点。

戻り値 void

setShowClearButton

setShowClearButton(v: boolean): void

クリアボタンを表示するかどうかを設定します。

引数
- v: boolean
  
  クリアボタンを表示する場合はtrue、それ以外はfalse。
  
  参照：showClearButton
戻り値 void

setText

setText(value: string): void

コントロールにテキストを設定します。

引数
- value: string
  
  コントロールのテキスト。
戻り値 void

setUseClipboard

setUseClipboard(v: boolean): void

クリップボードにアクセスすることを許可するかどうかを設定します。

引数
- v: boolean
  
  アクセスを許可する場合はtrue、それ以外はfalse。
戻り値 void

setVisible

setVisible(v: boolean): void

コントロールをページに表示するかどうかを示す値を設定します。
参照：visible

引数
- v: boolean
  
  表示する場合はtrue、それ以外はfalse。
戻り値 void

setWatermarkDisplayNullText

setWatermarkDisplayNullText(v: string): void

コントロールにフォーカスがなく未入力のときの代替テキストを設定します。

引数
- v: string
  
  代替テキスト。
戻り値 void

setWatermarkNullText

setWatermarkNullText(v: string): void

コントロールにフォーカスがあり未入力のときの代替テキストを設定します。

引数
- v: string
  
  代替テキスト。
戻り値 void

イベント

EditStatusChanged

EditStatusChanged(callback: (sender: GcInputManBase): void): void

編集モードが、[Insert]キー等によって挿入または上書きに切り変わったときに発生します。
```
var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function (sender) {
    alert("Edit Status Changed.");
};

// イベントリスナーを追加します。
gcTextBox1.onEditStatusChanged(callback);

// イベントリスナーを削除します。
gcTextBox1.removeEditStatusChanged(callback);
```
引数
- callback: (sender: GcInputManBase): void
  
  イベントハンドラ
  - - (sender: GcInputManBase): void
    - 引数
      - sender: GcInputManBase
        
        イベントが発生したコントロールのオブジェクト
      戻り値 void
戻り値 void

FocusOut

FocusOut(callback: (sender: this): void): void

コントロールがフォーカスを失ったときに発生します。

var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function (sender) {
    alert("Focus Out.");
};

// イベントリスナーを追加します。
gcTextBox1.onFocusOut(callback);

// イベントリスナーを削除します。
gcTextBox1.removeFocusOut(callback);

引数

callback: (sender: this): void

イベントハンドラ
- - (sender: this): void
  - 引数
    - sender: this
      
      イベントが発生したコントロールのオブジェクト
    戻り値 void

戻り値 void

Input

Input(callback: (sender: this, args: InputArgs): void): void

キー入力などの操作によりコントロールのテキストが変更されたときに直ちに発生します。
```
var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function (sender) {
    alert("Input.");
};

// イベントリスナーを追加します。
gcTextBox1.onInput(callback);

// イベントリスナーを削除します。
gcTextBox1.removeInput(callback);
```
引数
- callback: (sender: this, args: InputArgs): void
  
  イベントハンドラ
  - - (sender: this, args: InputArgs): void
    - 引数
      - sender: this
        
        イベントが発生したコントロールのオブジェクト
      - args: InputArgs
      戻り値 void
戻り値 void

InvalidInput

InvalidInput(callback: (sender: this): void): void

コントロールに入力が許可されていない文字をキーボードから入力、またはクリップボードからコピーしたときに発生します。
```
var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function (sender) {
    alert("Invalid Input.");
};

// イベントリスナーを追加します。
gcTextBox1.onInvalidInput(callback);

// イベントリスナーを削除します。
gcTextBox1.removeInvalidInput(callback);
```
引数
- callback: (sender: this): void
  
  イベントハンドラ
  - - (sender: this): void
    - 引数
      - sender: this
        
        イベントが発生したコントロールのオブジェクト
      戻り値 void
戻り値 void

KeyDown

KeyDown(callback: (sender: this, args?: CustomEventArgs): void): void

コントロールにフォーカスがあるときにキーが押されると発生します。
```
var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function (sender) {
    alert("Key Down.");
};

// イベントリスナーを追加します。
gcTextBox1.onKeyDown(callback);

// イベントリスナーを削除します。
gcTextBox1.removeKeyDown(callback);
```
引数
- callback: (sender: this, args?: CustomEventArgs): void
  
  イベントハンドラ
  - - (sender: this, args?: CustomEventArgs): void
    - 引数
      - sender: this
        
        イベントが発生したコントロールのオブジェクト
      - オプション args: CustomEventArgs
        
        イベントデータ
      戻り値 void
戻り値 void

KeyExit

KeyExit(callback: (sender: this): void): void

キーボードでフォーカスを移動した時に発生します。

var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function (sender) {
    alert("Key Exit.");
};

// イベントリスナーを追加します。
gcTextBox1.onKeyExit(callback);

// イベントリスナーを削除します。
gcTextBox1.removeKeyExit(callback);

引数

callback: (sender: this): void

イベントハンドラ
- - (sender: this): void
  - 引数
    - sender: this
      
      イベントが発生したコントロールのオブジェクト
    戻り値 void

戻り値 void

KeyUp

KeyUp(callback: (sender: this, args?: CustomEventArgs): void): void

コントロールにフォーカスがあるときにキーが離されると発生します。
```
var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function (sender) {
    alert("Key Up.");
};

// イベントリスナーを追加します。
gcTextBox1.onKeyUp(callback);

// イベントリスナーを削除します。
gcTextBox1.removeKeyUp(callback);
```
引数
- callback: (sender: this, args?: CustomEventArgs): void
  
  イベントハンドラ
  - - (sender: this, args?: CustomEventArgs): void
    - 引数
      - sender: this
        
        イベントが発生したコントロールのオブジェクト
      - オプション args: CustomEventArgs
        
        イベントデータ
      戻り値 void
戻り値 void

SpinDown

SpinDown(callback: (sender: this): void): void

スピン機能を使ってコントロールの値を減少させたときに発生します。

var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function (sender) {
    alert("Spin Down.");
};

// イベントリスナーを追加します。
gcTextBox1.onSpinDown(callback);

// イベントリスナーを削除します。
gcTextBox1.removeSpinDown(callback);

引数

callback: (sender: this): void

イベントハンドラ
- - (sender: this): void
  - 引数
    - sender: this
      
      イベントが発生したコントロールのオブジェクト
    戻り値 void

戻り値 void

SpinUp

SpinUp(callback: (sender: this): void): void

スピン機能を使ってコントロールの値を増加させたときに発生します。

var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function (sender) {
    alert("Spin Up.");
};

// イベントリスナーを追加します。
gcTextBox1.onSpinUp(callback);

// イベントリスナーを削除します。
gcTextBox1.removeSpinUp(callback);

引数

callback: (sender: this): void

イベントハンドラ
- - (sender: this): void
  - 引数
    - sender: this
      
      イベントが発生したコントロールのオブジェクト
    戻り値 void

戻り値 void

SyncValueToOriginalInput

SyncValueToOriginalInput(callback: (value: boolean | number | string | object, originalInput: HTMLInputElement | HTMLTextAreaElement): void): void

オリジナルの入力要素と値を同期するときに発生します。
デフォルトの実装は次のとおりです。
```
gcDateTime1.onSyncValueToOriginalInput(function(value, originalInput) {
    if(value instanceof Date){
        originalInput.value = value.toISOString();
        return;
    }

    originalInput.value = this.getValue();
});
```
remarks

InputManのコントロールの値が変更された場合、入力された値はオリジナルの入力要素に同期されます。ユーザーがフォームをSubmitした場合、オリジナルの入力要素の値が送信されますが、InputManの入力要素の値は送信されません。 InputManではオリジナルの入力要素と値を同期するデフォルトの処理が実装されていますが、本イベントを利用して同期する値をカスタマイズできます。
引数
- callback: (value: boolean | number | string | object, originalInput: HTMLInputElement | HTMLTextAreaElement): void
  
  値を同期するコールバック
  - - (value: boolean | number | string | object, originalInput: HTMLInputElement | HTMLTextAreaElement): void
    - 引数
      - value: boolean | number | string | object
        
        入力されたデータ
      - originalInput: HTMLInputElement | HTMLTextAreaElement
        
        オリジナルの入力要素
      戻り値 void
戻り値 void

TextChanged

TextChanged(callback: (sender: GcInputManBase): void): void

コントロールのテキストの値が変更された場合に発生します。

var gcTextBox1 = FindIMControl("gcTextBox1");
var callback = function(sender) {
    alert("Text Changed.");
};

// イベントリスナーを追加します。
gcTextBox1.onTextChanged(callback);

// イベントリスナーを削除します。
gcTextBox1.removeTextChanged(callback);

引数

callback: (sender: GcInputManBase): void

イベントハンドラ
- - (sender: GcInputManBase): void
  - 引数
    - sender: GcInputManBase
      
      イベントが発生したコントロールのオブジェクト
    戻り値 void

Inputman.GcInputManBase

GcInputManBase クラス

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

引数

inputEl: HTMLInputElement | HTMLTextAreaElement

オプション config: GcInputManBaseConfig

戻り値 GcInputManBase

プロパティ

autoDropDown

autoScale

読み取り専用 componentName

container

copiedMessage

copyMessage

dropDownButtonVisible

読み取り専用 dropDownWindow

enabled

floatingLabelDirection

floatingLabelText

floatingLabelType

fontSize

height

helpContent

maxHeight

maxWidth

minHeight

minScaleFactor

minWidth

readOnly

showClearButton

showCopyButton

showHelpButton

tabIndex

visible

width

メソッド

autoScaleText

戻り値 void

clear

戻り値 void

createDropDown

引数

オプション dropDownButtonAlignment: DropDownButtonAlignment

オプション showDropDown: boolean

戻り値 IDropDownContainer

deselectAll

戻り値 void

getDisplayText

戻り値 string

getDropDownWindow

戻り値 IDropDownContainer

getEnabled

戻り値 boolean

getIsOverwrite

戻り値 boolean

getLayoutElement

戻り値 HTMLElement

getOriginalInputElement

戻り値 HTMLInputElement | HTMLTextAreaElement

getReadOnly

戻り値 boolean

getSelectedText

戻り値 string

getSelectionLength

戻り値 number

getSelectionStart

戻り値 number

getText

戻り値 string

getUIInputElement

戻り値 HTMLInputElement | HTMLTextAreaElement

getUseClipboard

戻り値 boolean

getVisible