[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Input.Popup

Popup クラス

要素をポップアップとして表示するクラス。

ポップアップはowner 要素を持つことができます。その場合、ポップアップは、 Popup.showTrigger プロパティとPopup.hideTrigger プロパティによって 指定されるアクションに基づいて表示または非表示にできるリッチツールチップとして動作します。

オーナー要素を持たないポップアップはダイアログのように動作します。画面の中央に配置され、show メソッドを使用して表示されます。

Popup を閉じるには、Popup.hide メソッドを呼び出します。

または、Popup 内に'wj-hide'文字列で始まるクラスを持つクリック可能な 要素がある場合は、その要素がクリックされるとPopup は非表示になります。 さらに、そのクラス名にPopup.dialogResult プロパティが設定され、 呼び出し元が適切なアクションを実行できます。

たとえば、次のPopup は、ユーザーが［OK］または［キャンセル］ボタンを クリックすると非表示になり、Popup.dialogResult プロパティが 'wj-hide-cancel'または'wj-hide-ok'のいずれかに設定されます。

<button id="btnPopup">ポップアップを表示します。</button>
<wj-popup owner="#btnPopup" style="padding:12px">
  <p>下のいずれかのボタンを押して、ポップアップを非表示にします。</p>
  <hr/>
  <button class="wj-hide-ok" ng-click="handleOK()">OK</button>
  <button class="wj-hide-cancel">キャンセル</button>
</wj-popup>

次の例では、Popup コントロールを使用して所有者の要素とダイアログにアタッチされているポップアップを実装する方法を示しています。

Input/Popup/PopupsWithOwnerElements/purejs

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

  • new Popup(element: any, options?: any): Popup

  • Popup クラスの新しいインスタンスを初期化します。

    引数

    • element: any

      コントロールをホストするDOM要素、またはホスト要素のCSS セレクター（例: '#theCtrl'）。

    • オプション options: any

      コントロールの初期化データを含むJavaScriptオブジェクト。

    戻り値 Popup

プロパティ

content

content: HTMLElement

このPopup に含まれるHTML要素を取得または設定します。

dialogResult

dialogResult: any

Popup を非表示にした後に、そのコンテンツを処理するために使用できる値を取得または設定します。

このプロパティは、Popup が表示されたときにnullに設定され、ボタンクリックイベントに 応答して、またはhide メソッドの呼び出しの中で設定できます。

dialogResultEnter

dialogResultEnter: any

Popup 表示中にユーザーが［Enter］キーを押したときにdialogResult として 使用される値を取得または設定します。

ユーザーが［Enter］を押し、dialogResultEnter プロパティがnullでない場合、 ポップアップは、すべての子要素が有効な状態かどうかをチェックします。 有効な状態の場合は、ポップアップが閉じ、dialogResult プロパティが dialogResultEnter プロパティの値に設定されます。

fadeIn

fadeIn: boolean

Popup を表示するときにフェードインアニメーションを使用する かどうかを決定する値を取得または設定します。

このプロパティのデフォルト値はtrueです。

fadeOut

fadeOut: boolean

Popup を非表示にするときにフェードアウトアニメーションを使用する かどうかを決定する値を取得または設定します。

このプロパティのデフォルト値はtrueです。

hideTrigger

hideTrigger: PopupTrigger

Popup を非表示にするアクションを取得または設定します。

デフォルトでは、showTrigger プロパティはPopupTrigger.Blur に設定されており、 フォーカスを失った場合、またはEscキーを押した時にポップアップが非表示になります。

hideTrigger プロパティをPopupTrigger.Click に設定すると、ポップアップはオーナ要素を クリックする場合、またはEscキーを押した時非表示になります。

hideTrigger プロパティをPopupTrigger.None に設定すると、 Popupはhide メソッドを 呼び出します。

hostElement

hostElement: HTMLElement

コントロールをホストしているDOM要素を取得します。

isDisabled

isDisabled: boolean

コントロールが無効かどうかを判定する値を取得または設定します。

無効化されたコントロールは、マウスイベントやキーボードイベントを取得できません。

isDraggable

isDraggable: boolean

ポップアップをそのヘッダーでマウスによって ドラッグできるかどうかを示す値を取得または設定します。

ヘッダーは '.wj-dialog-header' のCSSセレクターによって識別されます。 ダイアログに 'wj-dialog-header'クラスの要素が含まれていない場合、ユーザーはポップアップをドラッグできません。

ポップアップをドラッグ可能にする場合は、 '.wj-dialog-header' CSSセレクタの cursorプロパティを設定することができます。次に例を示しています。

<style>
  .wj-popup {
    width: 30%;
  }
  .wj-dialog-header {
    cursor: move;
  }
</style>

このプロパティのデフォルト値は false です。

isTouching

isTouching: boolean

現在、コントロールがタッチイベントを処理しているかどうかを示す値を取得します。

isUpdating

isUpdating: boolean

コントロールが現在更新中かどうかを示す値を取得します。

isVisible

isVisible: boolean

Popup が現在表示されているかどうかを決定する値を取得します。

modal: boolean

Popup をモーダルダイアログとして表示するかどうかを決定する値を 取得または設定します。

モーダルダイアログは、Popup がページ内の他のコンテンツより目立つように、 暗い背景が付けられます。

ダイアログを完全にモーダルにするには、Popup.hideTrigger プロパティを PopupTrigger.None に設定して、ユーザーが背景をクリックしても ダイアログを閉じることができないようにします。この場合は、Popup.hide メソッドが呼び出されるか、 ユーザーが［Esc］キーを押した場合にのみ、ダイアログが閉じられます。

このプロパティのデフォルト値は false です。

owner

owner: HTMLElement

Popup を所有する要素を取得または設定します。

オーナーがnullの場合、ポップアップはダイアログとして動作します。 ダイアログは、画面の中央に配置され、 show メソッドを使用して表示する必要があります。

removeOnHide

removeOnHide: boolean

Popup　が非表示になっているときにPopup　要素を DOMから削除するか非表示にするかを決定する値を取得または設定します。

このプロパティのデフォルト値はtrueです。

rightToLeft

rightToLeft: boolean

要素内のコントロールを右から左のレイアウトでホストするかどうかを示す値を取得します。

showTrigger

showTrigger: PopupTrigger

Popup を表示するアクションを取得または設定します。

デフォルトでは、showTrigger プロパティはPopupTrigger.Click に設定されており、 オーナー要素をクリックすると、ポップアップが表示されます。

showTrigger プロパティをPopupTrigger.None に設定すると、 ポップアップはshow メソッドを呼び出すのみで表示されます。

メソッド

addEventListener

  • addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void

  • このControl が所有する要素にイベントリスナーを追加します。

    コントロールは、アタッチされているリスナーとそのハンドラのリストを保持し、 コントロール が破棄されているときにそれらを簡単に削除すること ができます（dispose と removeEventListener ) メソッドを参照してください）。

    イベントリスナーを削除しないと、メモリリークが発生する可能があります。

    デフォルトでは passive パラメータはfalseに設定されています。これはイベントハンドラが event.preventDefault() を呼び出すことを意味します。 タッチイベントまたはマウスホイールイベントにpassiveハンドラを追加する場合は、このパラメータをtrueに設定するとアプリケーションのパフォーマンスが向上します。

    passive　イベントリスナーの詳細については、「Improving scrolling performance with passive listeners」を参考してください。

    引数

    • target: EventTarget

      イベントのターゲット要素。

    • type: string

      イベントを指定する文字列。

    • fn: any

      イベントが発生したときに実行する関数。

    • オプション capture: boolean

      リスナーがターゲット要素によって処理される前にコントロールによって処理される必要があるかどうかを示します。

    • オプション passive: boolean

      ハンドラーが preventDefault() を呼び出さないことを示します。

    戻り値 void

applyTemplate

  • applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement

  • コントロールの新しいインスタンスにテンプレートを適用し、ルート要素を返します。

    このメソッドはテンプレート化されたコントロールのコンストラクターによって呼び出され、 テンプレートのパーツを対応するコントロールメンバにバインドする役割を持ちます。 以下のサンプルコードは、InputNumber コントロールのインスタンスにテンプレートを適用します。 このテンプレートには、'wj-part'属性が'input'、'btn-inc'、および'btn-dec'に設定された要素を含める必要があります。 コントロールのメンバである'_tbx'、'_btnUp'、'_btnDn'には、これらの要素への参照が割り当てられます。

    this.applyTemplate('wj-control wj-inputnumber', template, {
  _tbx: 'input',
  _btnUp: 'btn-inc',
  _btnDn: 'btn-dec'
}, 'input');

    引数

    • classNames: string

      コントロールのホスト要素に追加するクラスの名前。

    • template: string

      コントロールのテンプレートを定義するHTML文字列。

    • parts: Object

      パーツ変数とその名前のディクショナリー。

    • オプション namePart: string

      ホスト要素にちなんで名付けられたパーツの名前。 これにより、コントロールがフォームで使用されたときにデータをどのように送信するかが決まります。

    戻り値 HTMLElement

beginUpdate

  • beginUpdate(): void

containsFocus

  • containsFocus(): boolean

  • このコントロールにフォーカスのある要素が含まれているかどうかをチェックします。

    戻り値 boolean

deferUpdate

  • deferUpdate(fn: Function): void

  • beginUpdate/endUpdate ブロック内で関数を実行します。

    この関数の実行が完了するまでコントロールは更新されません。 このメソッドは、関数が例外を生成した場合でも endUpdate が呼び出されるようにします。

    引数

    • fn: Function

      実行する関数。

    戻り値 void

endUpdate

  • endUpdate(): void

focus

  • focus(): void

  • このコントロールにフォーカスを設定します。

    戻り値 void

getTemplate

  • getTemplate(): string

  • コントロールのインスタンスの作成に使用されたHTMLテンプレートを取得します。

    このメソッドは、クラス階層をさかのぼってコントロールのテンプレートを指定する最も近い祖先を探します。 たとえば、ComboBox コントロールのプロトタイプを指定した場合、 そのプロトタイプによってDropDown 基本クラスで定義されたテンプレートがオーバーライドされます。

    戻り値 string

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean

  • オブジェクトが指定されたプロパティを持つかどうかを判定します。

    引数

    • v: PropertyKey

      プロパティの名前。

    戻り値 boolean

hide

  • hide(dialogResult?: any): void

  • Popup を非表示にします。

    引数

    • オプション dialogResult: any

      Popup　を閉じる前に　dialogResult　プロパティに割り当てられる オプションの値。

    戻り値 void

initialize

  • initialize(options: any): void

  • 指定したオブジェクトからプロパティをコピーしてコントロールを初期化します。

    このメソッドを使用すると、各プロパティの値をコードで設定する代わりにプレーンなデータオブジェクトを使用してコントロールを初期化できます。

    例: 

    grid.initialize({
  itemsSource: myList,
  autoGenerateColumns: false,
  columns: [
    { binding: 'id', header: 'Code', width: 130 },
    { binding: 'name', header: 'Name', width: 60 }
  ]
});
// これは以下と同等です。
grid.itemsSource = myList;
grid.autoGenerateColumns = false;
// など

    初期化データは適用時に型チェックされます。 初期化オブジェクトに不明なプロパティ名または無効なデータ型が含まれている場合、このメソッドは例外をスローします。

    引数

    • options: any

      初期化データを含むオブジェクト。

    戻り値 void

invalidate

  • invalidate(fullUpdate?: boolean): void

  • 非同期更新を発生させるため、コントロールを無効にします。

    引数

    • オプション fullUpdate: boolean

      内容だけでなくコントロールのレイアウトも更新するかどうか。

    戻り値 void

isPrototypeOf

  • isPrototypeOf(v: Object): boolean

  • オブジェクトが別のオブジェクトのプロトタイプチェーンに存在するかどうかを判定します。

    引数

    • v: Object

      プロトタイプチェーンが判定される別のオブジェクト。

    戻り値 boolean

onGotFocus

onHidden

  • hidden イベントを発生させます。

    引数

    戻り値 void

onHiding

onRefreshed

onRefreshing

onShowing

onShown

  • shown イベントを発生させます。

    引数

    戻り値 void

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean

  • 指定されたプロパティが列挙可能かどうかを判断します。

    引数

    • v: PropertyKey

      プロパティの名前。

    戻り値 boolean

removeEventListener

  • removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

  • このControl が所有する要素にアタッチされている1つまたは複数のイベントリスナーを解除します。

    引数

    • オプション target: EventTarget

      イベントのターゲット要素。 nullの場合、すべてのターゲットにアタッチされているリスナーが解除されます

    • オプション type: string

      イベントを指定する文字列。 nullの場合、すべてのイベントにアタッチされているリスナーが解除されます。

    • オプション fn: any

      削除するハンドラ。 nullの場合は、すべてのハンドラが削除されます。

    • オプション capture: boolean

      リスナーがキャプチャリスナーかどうか。 nullの場合、キャプチャリスナーと非キャプチャリスナーの両方が解除されます。

    戻り値 number

show

  • show(modal?: boolean, handleResult?: Function): void

  • Popup を表示します。

    引数

    • オプション modal: boolean

      ポップアップをモーダルダイアログとして表示するかどうか。 指定した場合、その値がmodal プロパティに設定されます。

    • オプション handleResult: Function

      ポップアップが非表示になると、コールバックが呼び出されます。 コールバックが指定されている場合は、パラメータとしてポップアップを受け取ります。

      handleResult コールバックを使用すると、 hidden イベントにハンドラを アタッチしなくても、呼び出し元がモーダルダイアログの結果を処理できます。 たとえば、 以下のコードは、CollectionView 内の現在の項目を編集するための ダイアログを表示します。 編集結果は、 Popup.dialogResult 値に応じてコミット またはキャンセルされます。 次に例を示します。

      $scope.editCurrentItem = function () {
  $scope.data.editItem($scope.data.currentItem);
  $scope.itemEditor.show(true, function (e) {
    if (e.dialogResult == 'wj-hide-ok') {
      $scope.data.commitEdit();
    } else {
      $scope.data.cancelEdit();
    }
  });
}

    戻り値 void

toLocaleString

  • toLocaleString(): string

  • 現在のロケールを使用して文字列に変換された日付を返します。

    戻り値 string

toString

  • toString(): string

  • オブジェクトの文字列表現を返します。

    戻り値 string

valueOf

  • valueOf(): Object

  • 指定されたオブジェクトのプリミティブ値を返します。

    戻り値 Object

静的 disposeAll

  • disposeAll(e?: HTMLElement): void

  • HTML要素に含まれるすべてのWijmoコントロールを破棄します。

    引数

    • オプション e: HTMLElement

      コンテナー要素。

    戻り値 void

静的 getControl

  • getControl(element: any): Control

  • 指定したDOM要素でホストされているコントロールを取得します。

    引数

    • element: any

      コントロールをホストするDOM要素、またはホスト要素のCSS セレクター（例: '#theCtrl'）。

    戻り値 Control

静的 invalidateAll

  • invalidateAll(e?: HTMLElement): void

  • 指定したHTML要素に含まれるすべてのWijmoコントロールを無効化します。

    このメソッドは、コントロールの表示状態やサイズを変更する 動的なパネルをアプリケーションで使用している場合に使用します。 たとえば、スプリッタ、アコーディオン、およびタブコントロールは通常、 その中の要素の表示状態を変更します。この場合、その要素に含まれるコントロールに通知しないと、 それらのコントロールが適切に機能しなくなる可能性があります。 これが起こる場合は、動的コンテナーで適切なイベントを処理し、 Control.invalidateAll メソッドを呼び出してコンテナー内のWijmoコントロールの レイアウト情報が適切に更新されるようにする必要があります。

    引数

    • オプション e: HTMLElement

      コンテナー要素。nullに設定すると、ページ上に存在するすべてのWijmoコントロールが無効化されます。

    戻り値 void

静的 refreshAll

  • refreshAll(e?: HTMLElement): void

  • HTML要素で存在するすべてのWijmoコントロールを更新する。

    コントロールが時間おいて更新される代わりに直ちに更新されること以外はinvalidateAll メソッドと同様です。

    引数

    • オプション e: HTMLElement

      コンテナー要素。nullに設定すると、ページ上に存在するすべてのWijmoコントロールが無効化されます。

    戻り値 void

イベント

gotFocus

gotFocus: Event

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

hidden

hidden: Event

Popup が非表示になる後に発生します。

hiding

hiding: Event

Popup が非表示になる前に発生します。

lostFocus

lostFocus: Event

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

refreshed

refreshed: Event

コントロールが内容を更新した後で発生します。

refreshing

refreshing: Event

コントロールが内容を更新する直前に発生します。

showing

showing: Event

Popup が表示される前に発生させます。

shown

shown: Event

Popup が表示された後に発生させます。