GlideModal - クライアント

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:6分
  • GlideModal API は、コンテンツオーバーレイを表示するためのメソッドを提供します。

    これらのメソッドは、クライアント側の JavaScript を使用できる任意の場所のスクリプトで使用します。これらのメソッドは、ほとんどの場合 [クライアント] チェックボックスがオンになっている UI アクションから呼び出されます。

    これは、 GlideWindow および GlideDialogWindow API のフル機能で置き換えるものです。
    図 : 1. オーバーレイの例
    オーバーレイの例

    GlideModal - GlideModal(文字列 id, ブール値 readOnly, 数値の幅)

    GlideModalV3 クラスのインスタンスを作成します。

    表 : 1. パラメーター
    名前 タイプ 説明
    ID 文字列 モーダルにロードする UI ページ。
    readOnly ブーリアン モーダルで [閉じる] ボタンを非表示にするかどうかを示すフラグ。
    有効な値:
    • true:モーダルに [閉じる] ボタンを表示しません。
    • false:モーダルに [閉じる] ボタンを表示します。

    デフォルト値:false

    width 番号 モーダルの幅 (ピクセル単位)。

    デフォルト:

    最大幅:900 ピクセル

    注:
    また、 GlideModal - setWidth(数値の幅) メソッドを使用してモーダル幅を設定することもできます。

    GlideModal - get (文字列 ID)

    ID で GlideModal オブジェクトを取得します。

    表 : 2. パラメーター
    名前 タイプ 説明
    ID 文字列 GlideModal オブジェクトの要素 ID。
    表 : 3. 返される内容
    タイプ 説明
    GlideModal オブジェクト。

    GlideModal - getPreference(文字列名)

    指定した設定 (プロパティ) の値を返します。

    モーダルを作成するアクションを呼び出すと、通常は GlideModal - setPreference(文字列名, 文字列値) メソッドを使用してモーダルに必要な設定も作成されます。UI ページのクライアントスクリプトは、このメソッドを使用してこれらの設定を消費します。

    表 : 4. パラメーター
    名前 タイプ 説明
    name 文字列 取得する設定値の名前。この値は GlideModal - setPreference(文字列名, 文字列値) メソッドを使用してモーダルで事前に設定する必要があります。
    表 : 5. 返される内容
    タイプ 説明
    文字列 指定された設定の値。

    この例は、設定を行い、指定されたモーダルからその設定を取得する簡単なケースを示しています。

    var gm = new GlideModal('UI_dialog_name');
    //Sets the dialog title
    gm.setTitle('Show title');
    
    //sets the value of the preference table
    gm.setPreference('table', 'incident');
    
    //gets the value of the preference table
    var title = gm.getPreference('table');

    GlideModal - render()

    モーダルで UI ページを表示します。

    表 : 6. パラメーター
    名前 タイプ 説明
    なし
    表 : 7. 返される内容
    タイプ 説明
    なし
    var gm = new GlideModal("UI_dialog_name");
    
    //Sets the dialog title
    gm.setTitle('Show title');		      	
    gm.setWidth(550);
    
    //Opens the dialog
    gm.render();

    GlideModal - renderWithContent(オブジェクト html)

    指定された HTML コンテンツを含むモーダルを表示します。

    renderWithContent() メソッドは render() メソッドに代わるもので、レンダリングする UI ページを要求しません。

    表 : 8. パラメーター
    名前 タイプ 説明
    html オブジェクト モーダルに表示する HTML コンテンツ。
    表 : 9. 返される内容
    タイプ 説明
    なし

    GlideModal - renderWithContent(文字列 html)

    指定された HTML コンテンツを含むモーダルを表示します。

    renderWithContent() メソッドは render() メソッドに代わるもので、レンダリングする UI ページを要求しません。

    表 : 10. パラメーター
    名前 タイプ 説明
    html 文字列 モーダルに表示する HTML コンテンツ。
    表 : 11. 返される内容
    タイプ 説明
    なし

    GlideModal - setPreference(文字列名, 文字列値)

    現在のフォームの指定されたフィールドを指定された値に設定します。

    表 : 12. パラメーター
    名前 タイプ 説明
    name 文字列 更新するフォームフィールドの名前。

    このフィールドが現在のフォームに存在しない場合、要求は無視されます。

    value 文字列 指定されたフォームフィールドに格納する値。
    表 : 13. 返される内容
    タイプ 説明
    なし
    var gm = new GlideModal('UI_dialog_name');
    //Sets the dialog title
    gm.setTitle('Show title'); 
    gm.setPreference('table', 'task'); 			
    gm.setPreference('name', 'value');        	
    
    //Opens the dialog
    gm.render();

    GlideModal - setPreferenceAndReload(配列プロパティ)

    プロパティを設定し、モーダルを再ロードします。

    表 : 14. パラメーター
    名前 タイプ 説明
    プロパティ アレイ 設定する名前と値のペアのアレイ。
    表 : 15. 返される内容
    タイプ 説明
    なし

    GlideModal - setTitle(文字列タイトル)

    モーダルのタイトルを設定します。

    表 : 16. パラメーター
    名前 タイプ 説明
    title 文字列 表示するタイトル
    表 : 17. 返される内容
    タイプ 説明
    なし
    var dialog = new GlideModal('UI_dialog_name');
    
    //Sets the dialog title
    dialog.setTitle('Show title');
    dialog.setPreference('name', 'value');
     			      	        
    //Opens the dialogdialog.render(); 
    

    GlideModal - setWidth(数値の幅)

    モーダルの幅をピクセル単位で設定します。

    また、 GlideModal - GlideModal(文字列 id, ブール値 readOnly, 数値の幅) メソッドを使用して最初にモーダルをインスタンス化するときに、モーダルの幅を設定することもできます。

    表 : 18. パラメーター
    名前 タイプ 説明
    width 番号 モーダルの幅として設定するピクセル数。

    最大:900 ピクセル

    表 : 19. 返される内容
    タイプ 説明
    なし
    var dialog = new GlideModal('UI_dialog_name');
    
    //Sets the dialog title
    dialog.setTitle('Show title'); 
    dialog.setPreference('name', 'value'); 			      	
    dialog.setWidth(550);
    
    //Opens the dialog
    dialog.render();

    GlideModal - switchView(文字列 newView)

    ビューを変更し、モーダルを再ロードします。

    表 : 20. パラメーター
    名前 タイプ 説明
    newView 文字列 使用するビュー。
    表 : 21. 返される内容
    タイプ 説明
    なし