プライマリ・コンテンツに移動
Oracle® Application Express APIリファレンス
リリース5.0
E67397-01
  目次へ移動
目次
索引へ移動
索引

前
 
次
 

29 JavaScript API

このセクションでは、Oracle Application Expressに付属する、すべてのページで使用可能なJavaScriptのファンクションおよびオブジェクトについて説明します。これらのファンクションおよびオブジェクトを使用することで、クライアント側の機能(ページ要素の表示/非表示、XML HTTP Asynchronous JavaScriptおよびXML (Ajax)リクエストの作成など)を提供できます。

apexネームスペースの使用

apex.confirmファンクションは、確認を表示し、ユーザーの選択に応じてページを送信するか、ページの送信をキャンセルします。apex.submitファンクションは、現在のページを送信します。

グローバル変数

apexネームスペースは、Application Expressのグローバル変数およびファンクションを格納します。

  • apex.gPageContext$ - 現在のページ・コンテキストを格納するApplication Express変数。現在のページ・コンテキストは、そのページがデスクトップか、jQuery Mobileページかによって異なります。デスクトップの場合は、文書レベルに設定されます。jQuery Mobileの場合、ページは実際にはブラウザのDOMのDIV要素として表され、複数ページのDIVをブラウザのDOMに同時にロードできるので、これは現在のページを表すDIV要素に設定されます。

    これを使用してjQueryセレクタのコンテキストを設定し、セレクタが正しいページのコンテキスト内で確実に実行されるようにします。

    次に例を示します。

    jQuery( ".my_class", apex.gPageContext$ );
    

    これは、現在のページ・コンテキストで、CSSクラスがmy_classのすべての要素を選択します。

apex.confirmファンクションについて

apex.confirmファンクションは、確認を表示し、ユーザーの選択に応じてページを送信するか、ページの送信をキャンセルします。このファンクションには、2つのシグネチャがあります。

apex.confirm(pMessage, pRequest)

確認にメッセージ(pMessage)を表示し、ユーザーの選択に応じてページ設定リクエスト値(pRequest)を送信するか、またはページ送信を取り消します。

パラメータ

pMessage (string)
pRequest (string)

この例では、確認ダイアログ・ボックスに「Delete Department」というテキストが表示されます。ユーザーが削除を選択すると、REQUESTの値が'DELETE'の現在のページが送信されます。

apex.confirm('Delete Department', 'DELETE');

apex.confirm(pMessage, pOptions)

メッセージ(pMessage)を表示する確認画面を表示し、ユーザーの選択に基づいて、pOptionsによって指定したリクエスト値を設定するページを送信するか、またはページの送信をキャンセルします。

パラメータ

pMessage (string)
pOptions (Object)
where pOptions contains one to any of the following properties:
submitIfEnter - If you only want to confirm when the ENTER key has been pressed, call apex.confirm in the event callback and pass the event object as this parameter.
request - The request value to set (defaults to null)
set - Object conatining name/value pairs of items to be set on the page prior to submission(defaults to null).
showWait - Flag to control if a 'Wait Indicator' icon is displayed, which can be useful when running long page operations (Defaults to false).

戻り値

Boolean - submitIfEnterオプションが指定されている場合、ブール値を戻します。[Enter]キーが押されていなければTRUE、[Enter]キーが押されていればFALSEを戻します。submitIfEnterが指定されていない場合、戻り値はありません。

この例では、「Save Department?」というテキストの確認メッセージが表示されます。ユーザーが保存を選択すると、REQUEST値がSAVEのページが送信され、2つのページ・アイテム値が設定されます(P1_DEPTNO10P1_EMPNO5433)。

apex.confirm("Save Department?", {
  request:"SAVE",
  set:{"P1_DEPTNO":10, "P1_EMPNO":5433}
  });

apex.submitファンクションについて

apex.submitファンクションは、現在のページを送信します。このファンクションには、2つのシグネチャがあります。

apex.submit(pOptions)

このファンクションは、pOptionsで指定したオプションを使用してページを送信します。

パラメータ

pOptions (Object)
where pOptions contains one to any of the following properties:
submitIfEnter - If you only want to submit when the ENTER key has been pressed, call apex.submit in the event callback and pass the event object as this parameter.
request - The request value to set (defaults to null)
set - Object conatining name/value pairs of items to be set on the page prior to submission(defaults to null).
showWait - Flag to control if a 'Wait Indicator' icon is displayed, which can be useful when running long page operations (Defaults to false).

戻り値

Boolean - submitIfEnterオプションが指定されている場合、ブール値を戻します。[Enter]キーが押されていなければTRUE、[Enter]キーが押されていればFALSEを戻します。submitIfEnterが指定されていない場合、戻り値はありません。

この例では、REQUESTの値が'DELETE'のページを送信します。2つのページ・アイテム値P1_DEPTNO10P1_EMPNO5433に設定されています。送信中は、待機アイコンがユーザーへのインジケータとして表示されます。

apex.submit({
  request:"DELETE",
set:{"P1_DEPTNO":10, "P1_EMPNO":5433}});

apex.submit(pRequest)

このファクションは、ページを送信して、Application Express Requestの値pRequestを設定します。

パラメータ

pRequest (String)

REQUESTの値が'DELETE'の現在のページを送信します。

apex.submit( 'DELETE' );

apex.daネームスペース

このネームスペースは、Oracle Application Expressのすべての動的アクション・ファンクションを保持します。

apex.da.resume (pCallback, pErrorOccurred)

このファンクションは動的アクションの実行を再開します。動的アクションの実行は、アクションの「結果を待機」属性がチェックされていれば一時停止できます。「結果を待機」はAjaxベース動的アクションと使用されるように設計された動的アクション・プラグインの標準属性です。プラグインがこの属性を示すと、プラグインJavaScriptコードの関連場所でこのファンクションを呼び出すことで、実行を再開する必要があります。そうしないと、アクションが動的アクションの実行をブレークします。

パラメータ

pCallback (ファンクション) - this.resumeCallbackプロパティから使用可能なコールバック・ファンクションを参照する、必須パラメータです。

pErrorOccurred (ブール) - エラーが発生したかどうかをフレームワークに示す、必須パラメータです。エラーが発生し、アクションの「エラー時に実行停止」属性がチェックされている場合、動的アクションの実行は停止します。

戻り値

なし

例1

エラーが発生していない(たとえば、Ajaxベース・アクションの正常なコールバックから)ことを示すアクションの実行を再開します。

apex.da.resume( lResumeCallback, false );

例2

エラーが発生した(たとえば、Ajaxベース・アクションのエラーのコールバックから)ことを示すアクションの実行を再開します。アクションの状態

「エラー時に実行停止」属性がチェックされている場合、動的アクションの実行は停止します。

apex.da.resume( lResumeCallback, true );

apex.debugネームスペース

このネームスペースは、Oracle Application Expressのすべてのデバッグ・ファンクションを格納します。

ログ・レベルの定数

LOG_LEVEL

apex.debug.LOG_LEVEL = {
        OFF: 0,
        ERROR: 1,
        WARN: 2,
        INFO: 4,
        APP_TRACE: 6,
        ENGINE_TRACE: 9
    };

表29-1 LOG_LEVELの説明

説明

OFF: 0

ロギングは無効です。

ERROR: 1

エラー・ログ・レベル。

WARN: 2

警告ログ・レベル。

INFO: 4

情報ログ・レベル。

APP_TRACE: 6

アプリケーション・トレース・ログ・レベル。

ENGINE_TRACE: 9

エンジン・トレース・ログ・レベル。


apex.debug.error(...*)

エラー・メッセージをログに記録します。errorファンクションは、サーバーからまたはapex.debug.setLevelを使用して設定されたログ・レベルに関係なく常にエラーを書き込みます。メッセージは、使用可能な場合、ブラウザの組込みコンソール・ロギングを使用して書き込まれます。サポートされている場合、console.traceがコールされます。古いブラウザでは、コンソール・オブジェクトやその機能の一部がサポートされていないこともあります。

パラメータ

表29-2 debug.error( ...* )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

...*

引数

必須


コンソールにログが出力される任意の数のパラメータ。


例1

この例では、メッセージ"Update Failed"をコンソールに出力します。

apex.debug.error("Update Failed"); 

例2

この例では、例外メッセージをコンソールに出力します。

apex.debug.error("Exception: ", ex); 

apex.debug.getLevel()

デバッグ・ログ・レベルを戻すメソッド。デバッグ・ログ・レベルは非表示のアイテム"#pdebug"と同期がとられます。

戻り値

ログ・レベルを整数の1から9、またはデバッグ・ログが無効になっていることを示す0 (ゼロ)として戻します。戻り値の意味は、「ログ・レベルの定数」を参照してください。

パラメータ

なし

この例では、ログ・レベルを取得し、先頭に"Level"を付け、コンソールにログを出力します。

apex.debug.log("Level=", apex.debug.getLevel()); 

apex.debug.info(...*)

情報メッセージをログに記録します。レベルをINFOに設定したapex.debug.messageと同様です。

パラメータ

表29-3 debug.info( ...* )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

...*

引数

必須


コンソールにログが出力される任意の数のパラメータ。


例1

この例では、ログ・レベルがINFO以上の場合に、情報メッセージをコンソールに出力します。

apex.debug.info("Command successful"); 

apex.debug.log(...*)

メッセージをログに記録します。レベルを最高レベルに設定したapex.debug.messageと同様です。

パラメータ

表29-4 debug.log( ...* )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

...*

引数

必須


コンソールにログが出力される任意の数のパラメータ。


例1

この例では、現在のログ・レベルに関係なく、ログ・レベルを取得してコンソールに出力します。

apex.debug.log("Level=", apex.debug.getLevel()); 

apex.debug.message(pLevel,...*)

指定されたデバッグ・ログ・レベルでメッセージをログに記録します。サーバーからまたはapex.debug.setLevelを使用して設定されたログ・レベルは、メッセージを実際に書き込むかどうかを制御します。設定されたログ・レベルがpLevel以上である場合、メッセージは書き込まれます。メッセージは、使用可能な場合、ブラウザの組込みコンソール・ロギングを使用して書き込まれます。古いブラウザでは、コンソール・オブジェクトやその機能の一部がサポートされていないこともあります。

パラメータ

表29-5 debug.message( pLevel )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pLevel

NUMBER

必須


1から9の数値で、レベル1は最も重要であり、レベル9は最も重要ではありません。LOG_LEVELの定数のいずれかを指定できます。0 (ゼロ)などの他の値は、デバッグ・ログを無効にします。

...*

引数

必須


コンソールにログが出力される任意の数のパラメータ。


この例では、ログ・レベルが7以上である場合、メッセージ"Testing"をコンソールに出力します。

apex.debug.message(7,"Testing")); 

apex.debug.setLevel(pLevel)

デバッグ・ログ・レベルを設定するメソッド。指定されたレベル以下のログ・メッセージがコンソール・ログに書き込まれます。デバッグ・ログ・レベルは、サーバーから取得される非表示のアイテム#pdebugと同期がとられるため、このファンクションをコールする必要はほとんどありません。

パラメータ

表29-6 debug.setlevel( pLevel )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pLevel

NUMBER

必須


1から9の数値で、レベル1は最も重要であり、レベル9は最も重要ではありません。LOG_LEVELの定数のいずれかを指定できます。0 (ゼロ)などの他の値は、デバッグ・ログを無効にします。


この例では、ログ・レベルをアプリケーション・トレースに設定します。

apex.debug.setLevel(apex.debug.LOG_LEVEL.APP_TRACE)); 

apex.debug.trace(...*)

トレース・メッセージをログに記録します。レベルをAPP_TRACEに設定したapex.debug.messageと同様です。

パラメータ

表29-7 debug.trace( ...* )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

...*

引数

必須


コンソールにログが出力される任意の数のパラメータ。


例1

この例では、デバッグ・ログ・レベルがAPP_TRACE以上の場合に、ログ・メッセージをコンソールに出力します。

apex.debug.trace("Got click event: ", event); 

apex.debug.warn(...*)

警告メッセージをログに記録します。レベルをWARNに設定したapex.debug.messageと同様です。

パラメータ

表29-8 debug.warn( ...* )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

...*

引数

必須


コンソールにログが出力される任意の数のパラメータ。


例1

この例では、デバッグ・ログ・レベルがWARN以上の場合に、警告メッセージをコンソールに出力します。

apex.debug.warn("Empty string ignored"); 

apex.eventネームスペース

apex.eventネームスペースは、Oracle Application Expressのすべてのイベント関連のファンクションを格納します。

apex.event.trigger(pSelector,pEvent,pData)

jQueryセレクタ、jQueryオブジェクトまたはDOMノードを指定すると、指定したpEventがトリガーされます。pEventは、「クリック」や「変更」のようなブラウザ・イベントですが、「スライド変更」のようなカスタム・イベントでもあります。このファクションは、動的アクション・フレームワークによって処理されるイベントをトリガーする場合にのみ使用する必要があります。そうしないと、アプリケーションにインストールされたプラグインによって登録されたカスタム・イベントや動的アクションですでに公開されているイベントが危険にさらされる可能性があります。

パラメータ

pSelector (jQuery selector | jQuery object | DOM Node)
pEvent (String)
pData (Object)

戻り値

Boolean

apex.item

apex.item APIによって、Application Expressのアイテム関連機能に単一のインタフェースが提供されます。このAPIでApplication Expressアイテム・オブジェクトを戻し、それをアイテム関連のファンクションおよびプロパティにアクセスするために使用できます。

apex.item( pNd )

このAPIでApplication Expressアイテム・オブジェクトを戻し、それをアイテム関連のファンクションおよびプロパティにアクセスするために使用できます。このAPIでApplication Expressアイテム・オブジェクトを戻し、そのアイテムをアイテム関連のファンクションおよびプロパティにアクセスするために使用できます。

プラグイン開発者は、apex.widget.initPageItemをオーバーライドで呼び出すことによって、apex.itemネームスペースに定義された動作の多くをオーバーライドできます。詳細は、apex.widget.initPageItem( pName, pOptions)のドキュメントを参照してください。

パラメータ

表29-9 apex.item( pNd )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pNd

(DOMノード|文字列)

必須


Application Expressのアイテム名またはDOMノード。


戻り値

表29-10「apex.item( pNd )の戻り値」に、このファンクションの戻り値を示します。

表29-10 apex.item( pNd )の戻り値

タイプ 説明

(オブジェクト)

Application Expressのアイテム・オブジェクトを戻し、このオブジェクトが、アイテム固有のファンクションへのアクセスに使用されます。たとえば、getValuesetValueなどです。


これは、単独では使用されず、次に示す各APIで説明されているように、アイテム固有のファンクションおよびプロパティにアクセスするために使用されます。

apex.item( pNd ).addValue( pValue )

複数の値をサポートするApplication Expressアイテムに値を追加します。

パラメータ

表29-11 apex.item( pNd ).addValue( pValue )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pValue

(文字列)

必須


設定される値。


戻り値

なし。

この例では、P1_ITEMと呼ばれるページ・アイテムにおいて、現在選択された値に値100が追加されます。

apex.item( "P1_ITEM" ).addValue('100') ;

apex.item( pNd ).disable()

アイテム・タイプを考慮してApplication Expressのアイテム値を無効にし、編集不可にします。

パラメータ

なし。

戻り値

なし。

この例では、P1_ITEMと呼ばれるページ・アイテムは無効化され、編集不可となります。

apex.item( "P1_ITEM" ).disable() ;

apex.item( pNd ).enable()

アイテム・タイプを考慮してApplication Expressのアイテム値を有効化し、編集可能にします。

パラメータ

なし。

戻り値

なし。

この例では、P1_ITEMと呼ばれるページ・アイテムは有効化され、編集可能となります。

apex.item( "P1_ITEM" ).enable() ;

apex.item( pNd ).getValue()

現在のアイテム・タイプを考慮して、ページにおけるApplication Expressのアイテムの現行値を戻します。これはセッション・ステートからアイテムの現行値を戻すのではなく(同じである可能性もありますが)、現在のページ上にある値を戻します。

アイテム値を戻す.getValue(). $v( pNd )に関連するファンクションは2つあり、この形式でアイテム値は送信されます。これは単一の値か、またはアイテムが複数の値をサポートする場合は、: (コロン)で区切られた値リストとなります。$v2( pNd )ファンクションもあり、これは.getValue()へのショートカットで、単一の値または値の配列のいずれかを戻します。

パラメータ

なし。

戻り値

表29-12 apex.item( pNd ).getValue()の戻り値

名前 説明

(文字列|配列)

単一の文字列値か、アイテムが複数の値をサポートする場合(たとえば「選択リスト」の「複数選択を許可」属性を「はい」または「シャトル」・ネイティブ・アイテム・タイプに設定)は、文字列値の配列のいずれかを戻します。


この例では、P1_ITEMと呼ばれるページ・アイテムの現行値は、アラートで表示されます。

alert( "P1_ITEM value = " +  apex.item( "P1_ITEM" ).getValue()  );

apex.item( pNd ).hide( pHideRow)

アイテム・タイプを考慮して、Application Expressのアイテム値を非表示にします。.hide()ファンクションを使用するときは、次を理解することが重要です。

  • 非表示となっているアイテムが、表のレイアウトを使用しているページ(このページが、「グリッド・レイアウト・タイプ」が「HTML表」に設定されているページ・テンプレートを参照している)でレンダリングされ、非表示にするためのコールで表の行全体の非表示を指定すると(pHideRow = TRUE)、このアイテムに関連するすべてがその行に含まれると見なされ、行全体が非表示になります。

  • 非表示となっているアイテムが、表のレイアウトを使用しているページでレンダリングされ、非表示にするためのコールで表の行全体の非表示を指定しないと(pHideRow = FALSE、または指定しない)、ファンクションは、FOR属性がアイテムのIDに一致する場合に、そのアイテムのラベルを非表示にしようとします。

  • 非表示となっているアイテムが、グリッド・レイアウトを使用しているページ(このページが「グリッド・レイアウト・タイプ」が「固定列数」または「可変列数」に設定されているページ・テンプレートを参照している)でレンダリングされ、このアイテムが既知のIDのある「フィールド・コンテナ」要素を含む「ラベル」・テンプレートを参照している場合(「フィールド・コンテナ」→「「ラベルの前」とアイテム」属性にid="#CURRENT_ITEM_CONTAINER_ID#"のHTML要素が含まれる場合)、このアイテムに関連するすべてが「フィールド・コンテナ」に含まれると見なされ、非表示になります。

パラメータ

表29-13 apex.item( pDN ).hide( pHideRow )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pHideRow

(文字列|配列)

オプション

FALSE

TRUEの場合、表の同じ行(TR)が非表示となります。アイテムが表のレイアウトを使用しているページにある場合(ページが「グリッド・レイアウト・タイプ」が「HTML表」に設定されているページ・テンプレートを参照している場合)にのみ、適用可能です。


戻り値

なし。

この例では、P1_ITEMと呼ばれるページ・アイテムは非表示になります。P1_ITEMがグリッド・レイアウトを使用しているページ上にあり、そのアイテムが、「フィールド・コンテナ」要素と既知のIDが含まれる「ラベル」・テンプレートを参照している場合(詳細については前述のとおり)、このコンテナ要素は非表示になります。その他の場合は、アイテムおよび対応するラベルは非表示になります。

apex.item( "P1_ITEM" ).hide();

この例では、P1_ITEMと呼ばれるページ・アイテムが含まれる表の行全体(TR)が非表示になります(pHideRow = TRUEのため)。表の行全体の非表示は、表のレイアウトを使用するページ上でのみ使用してください。P1_ITEMがグリッド・レイアウトを使用しているページ上にある場合、pHideRow = TRUEの引き渡しが機能せず、正しくない表の行が誤って非表示になり、ページ・レイアウトに悪影響が生じます。

apex.item( "P1_ITEM" ).hide(true);

apex.item( pNd ).isEmpty()

Application Expressのアイテムが空かどうかでTRUEまたはFALSEを戻します(空白、タブ、フォーム・フィードなどの空白文字のみで構成されるアイテム値を空と見なします)。また、アイテム・タイプで「LOV」が使用されているかどうか、および「LOV」で「NULL戻り値」が定義されているかどうかについても考慮します。この場合、「NULL戻り値」は、アイテムが空である場合にアサートするために使用されます。

パラメータ

なし。

戻り値

表29-14 apex.item( pNd ).isEmpty()の戻り値

タイプ 説明

(ブール)

Application Expressのアイテムが空かどうかでTRUEまたはFALSEを戻します。


この例では、P1_ITEMと呼ばれるページ・アイテムが空かどうかを.isEmpty()へのコールによって確認し、空の場合はアラートを表示します。

if( apex.item( "P1_ITEM" ).isEmpty()  ) {
  alert( "P1_ITEM empty!" );
}

apex.item( pNd ).setFocus()

特定のアイテムがどのようにフォーカスを受け取るように設計されているかを考慮し、ユーザーのフォーカスをApplication Expressのアイテムに移動します。

パラメータ

なし。

戻り値

なし。

この例では、ユーザーのフォーカスはP1_ITEMと呼ばれるページ・アイテムに設定されています。

apex.item( "P1_ITEM" ).setFocus();

apex.item( pNd ).setStyle( pPropertyName, pPropertyValue )

特定のアイテムがどのようにスタイル設定されるように設計されているかを考慮し、Application Expressのアイテムにスタイルを設定します。

パラメータ

表29-15 apex.item( pNd ).setStyle( pPropertyName, pPropertyValue )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pPropertyName

(CSSプロパティ名)

必須


設定されるCSSプロパティ名。

pPropertyValue

(CSSプロパティ値)

必須


CSSプロパティを設定するために使用される値。


戻り値

なし。

この例では、CSSプロパティのcolorが、P1_ITEMと呼ばれるページ・アイテムに対してredに設定されています。

apex.item( "P1_ITEM" ).setStyle( "color", "red" );

apex.item( pNd ).setValue(pValue, pDisplayValue, pSuppressChangeEvent)

アイテム・タイプを考慮して、Application Expressのアイテム値を設定します。このファンクションは、ページ上のApplication Expressアイテムの現行値を設定し、アイテムのセッション・ステートにおける現行値は設定しません。これによってコール元は、必要に応じて、設定されるアイテムにchangeイベントを抑止することもできます。

.setValue()へのショートカットについては、$s( pNd, pValue, pDisplayValue, pSuppressChangeEvent )ファンクションに関する説明を参照してください。

パラメータ

表29-16 apex.item (pNd ).setValue( pValue, pDisplayValue, pSuppressChangeEvent)のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pValue

(文字列|配列)

必須


設定される値。複数の値をサポートするアイテムの場合(例: Shuttle)、1つ文字列値配列を渡すことで、複数の値を一度に設定できます。

pDisplayValue

(文字列)

オプション


戻り値が異なる場合に、ページ・アイテムの表示値を設定するために使用されるオプションのパラメータ。たとえば、アイテム・タイプ「ポップアップLOV」の「入力フィールド」属性が「入力不可、表示値の表示と戻り値の格納」の場合、この値で「入力フィールド」が設定されます。このアイテムの非表示の戻り値フィールドを設定するには、pValueの値を使用します。

pSuppressChangeEvent

(ブール)

オプション

FALSE

設定されているアイテムがchangeイベントによってトリガーされないようにするには、TRUEを渡します。


戻り値

なし。

この例では、P1_ITEMと呼ばれるページ・アイテムの値は、10に設定されます。pSuppressChangeEventが渡されていないため、デフォルトの動作である、P1_ITEMをトリガーするchangeイベントが発生します。

apex.item( "P1_ITEM" ).setValue( "10" );

この例でP1_ITEMは、「入力フィールド」属性が「入力不可、表示値の表示と戻り値の格納」となっている「ポップアップLOV」のページ・アイテムであり、「入力フィールド」に設定されます。P1_ITEMの表示値は"SALES"に設定され、非表示の戻り値が10に設定されます。pSuppressChangeEventパラメータにtrueが渡されているため、P1_ITEMに関してchangeイベントはトリガーされません。

apex.item( "P1_ITEM" ).setValue( "10", "SALES", true );

apex.item( pNd ).show( pShowRow )

アイテム・タイプを考慮して、Application Expressのアイテム値を表示します。.show()ファンクションを使用するときは、次を理解することが重要です。

  • 表示となっているアイテムが、表のレイアウトを使用しているページ(このページが、「グリッド・レイアウト・タイプ」が「HTML表」に設定されているページ・テンプレートを参照している)でレンダリングされ、表示するためのコールで表の行全体の表示を指定すると(pShowRow = TRUE)、このアイテムに関連するすべてがその行に含まれると見なされ、行全体が表示されます。

  • 表示となっているアイテムが、表のレイアウトを使用しているページでレンダリングされ、表示するためのコールで表の行全体の表示を指定しないと(pShowRow = FALSE、または指定しない)、ファンクションは、FOR属性がアイテムのIDに一致する場合に、そのアイテムのラベルを表示しようとします。

  • 表示となっているアイテムが、グリッド・レイアウトを使用しているページ(このページが「グリッド・レイアウト・タイプ」が「固定列数」または「可変列数」に設定されているページ・テンプレートを参照している)でレンダリングされ、このアイテムが既知のIDのある「フィールド・コンテナ」要素を含む「ラベル」・テンプレートを参照している場合(「フィールド・コンテナ」→「「ラベルの前」とアイテム」属性にid="#CURRENT_ITEM_CONTAINER_ID#"のHTML要素が含まれる場合)、このアイテムに関連するすべてが「フィールド・コンテナ」に含まれると見なされ、表示になります。

パラメータ

表29-17 apex.item ( pNd ).show( pShowRow )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pShowRow

(文字列|配列)

オプション

FALSE

TRUEの場合、表の同じ行(TR)が表示となります。アイテムが表のレイアウトを使用しているページにある場合(ページが「グリッド・レイアウト・タイプ」が「HTML表」に設定されているページ・テンプレートを参照している場合)にのみ、適用可能です。


戻り値

なし。

この例では、P1_ITEMと呼ばれるページ・アイテムが表示されます。P1_ITEMがグリッド・レイアウトを使用しているページ上にあり、そのアイテムが、「フィールド・コンテナ」要素と既知のIDが含まれる「ラベル」・テンプレートを参照している場合(詳細については前述のとおり)、このコンテナ要素は表示されます。その他の場合には、アイテムおよび対応するラベルが表示されます。

apex.item( "P1_ITEM" ).show();

この例では、P1_ITEMと呼ばれるページ・アイテムが含まれる表の行全体(TR)が表示されます(pShowRow = TRUEのため)。表の行全体の表示は、表のレイアウトを使用するページ上でのみ使用してください。P1_ITEMがグリッド・レイアウトを使用しているページ上にある場合、pShowRow = TRUEの引き渡しが機能せず、正しくない表の行が誤って表示され、ページ・レイアウトに悪影響が生じます。

apex.item( "P1_ITEM" ).show(true);

apex.langネームスペース

このネームスペースは、Oracle Application Expressのローカライズ関連のファンクションに使用します。

apex.lang.addMessages ( pMessages )

getMessageおよびformatファンクションで使用するメッセージを追加します。複数回コールできます。追加メッセージがマージされます。「JavaScriptで使用」が「はい」に設定されているアプリケーション・テキスト・メッセージ全部を使用して自動的にコールされるため、通常、このファンクションをコールする必要はありません。

パラメータ

表29-18 apex.lang.addMessages( ...* )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pMessages

{オブジェクト}

必須


プロパティがメッセージ・キーのオブジェクトで、値はローカライズされたメッセージ・テキストです。


この例では、メッセージを追加します。

apex.lang.addMessages({
  APPLY_BUTTON_LABEL: "Apply"
});

apex.lang.clearMessages ( pMessages )

すべてのメッセージを削除します。

パラメータ

なし。

この例では、すべてのメッセージを削除します。

apex.lang.clearMessages()

apex.lang.format ( pPattern, ...* )

formatMessageと同じですが、メッセージ・パターンが直接指定される(すでにローカライズされている、またはローカライズされることになっていない)ことを除きます。キーではありません。「apex.lang.formatMessage ( pKey, ...* )」を参照してください。

パラメータ

表29-19 apex.lang.format( pPattern, ...*)のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pPattern

{文字列}

必須


1つ以上のパラメータ(%0から%9)を含むメッセージ・パターン。


{...*}

オプション


メッセージ・パラメータ(%0から%9)ごとに1つのオプションの置換値。文字列でない引数は文字列に変換されます。


戻り値

表29-20 apex.lang.format( pPattern, ...*)の戻り値

タイプ 説明

{文字列}

ローカライズされた書式設定済のメッセージ・テキスト。


この例では、totalCost変数が34.00であるとすれば、Total cost: $34.00を戻します。

apex.lang.format("Total cost: $%0", orderTotal);

apex.lang.formatMessage ( pKey, ...* )

メッセージの書式を設定します。メッセージのパラメータ(%0から%9)は対応するファンクションの引数で置換されます。単一の%を含めるには、%%を使用します。置換引数はHTMLエスケープされます。

パラメータ

表29-21 apex.lang.formatMessage( pKey, ...*)のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pKey

{文字列}

必須


キーは、getMessageと同様に、ローカライズされたメッセージ・テキストの参照に使用されます。


{...*}

オプション


メッセージ・パラメータ(%0から%9)ごとに1つのオプションの置換値。


戻り値

表29-22 apex.lang.formatMessage( pKey, ...*)の戻り値

タイプ 説明

{文字列}

ローカライズされた書式設定済のメッセージ・テキスト。キーが見つからない場合、そのキーが戻されます。


この例では、PROCESS_STATUSメッセージ・テキストが"Process %0%% complete"であり、progress変数の値が60である場合、"Process 60% complete"を戻します。

apex.lang.formatMessage("PROCESS_STATUS", progress);

apex.lang.formatMessageNoEscape ( pKey, ...* )

formatMessageと同じですが、置換引数がHTMLエスケープされないことを除きます。安全であると認識される必要があるか、安全なコンテキストで使用される必要があります。「apex.lang.formatMessage ( pKey, ...* )」を参照してください。

パラメータ

表29-23 apex.lang.formatMessageNoEscape( pKey, ...*)のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pKey

{文字列}

必須


キーは、getMessageと同様に、ローカライズされたメッセージ・テキストの参照に使用されます。


{...*}

オプション


メッセージ・パラメータ(%0から%9)ごとに1つのオプションの置換値。


戻り値

表29-24 apex.lang.formatMessageNoEscape( pKey, ...*)の戻り値

タイプ 説明

{文字列}

ローカライズされた書式設定済のメッセージ・テキスト。キーが見つからない場合、そのキーが戻されます。


この例では、CONFIRMメッセージ・テキストが"You entered %0"であり、inputValue変数の値が"<ok>"の場合、"You entered <ok>"を戻します。この文字列は、XSS脆弱性を回避するためにHTMLエスケープが実行されるコンテキストで使用する必要があります。

apex.lang.formatMessageNoEscape("CONFIRM", inputValue);

apex.lang.formatNoEscape ( pPattern, ...* )

formatと同じですが、置換引数がHTMLエスケープされないことを除きます。安全であると認識される必要があるか、安全なコンテキストで使用される必要があります。「apex.lang.format ( pPattern, ...* )」を参照してください。

パラメータ

表29-25 apex.lang.formatNoEscape( pPattern, ...*)のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pPattern

{文字列}

必須


1つ以上のパラメータ(%0から%9)を含むメッセージ・パターン。


{...*}

オプション


メッセージ・パラメータ(%0から%9)ごとに1つのオプションの置換値。


戻り値

表29-26 apex.lang.formatNoEscape( pPattern, ...*)の戻り値

タイプ 説明

{文字列}

ローカライズされた書式設定済のメッセージ・テキスト。キーが見つからない場合、そのキーが戻されます。


この例では、inputValue変数の値が"<ok>"の場合、"You entered <ok>"を戻します。この文字列は、XSS脆弱性を回避するためにHTMLエスケープが実行されるコンテキストで使用する必要があります。

apex.lang.formatNoEscape("You entered %0", inputValue);

apex.lang.getMessage ( pKey )

指定されたキーに関連付けられたメッセージを戻します。キーは、addMessagesで追加されたメッセージで検索されます。

パラメータ

表29-27 apex.lang.getMessage( pKey)のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pKey

{文字列}

必須


メッセージ・キー。


戻り値

表29-28 apex.lang.getMessage( pKey)の戻り値

タイプ 説明

{文字列}

ローカライズされたメッセージ・テキスト。キーが見つからない場合、そのキーが戻されます。


この例では、キーOK_BTN_LABELのローカライズされたテキストが"OK"の場合、"OK"を戻します。

apex.lang.getMessage("OK_BTN_LABEL");

apex.navigationネームスペース

apex.navigationネームスペースは、Oracle Application Expressのポップアップおよびリダイレクト関連のファンクションを格納します。

apex.navigation.dialog(pUrl,pOptions,pCssClasses,pTriggeringElement)

指定されたページをダイアログで開きます。モバイルUIの場合、ページはmobile.changePageコールでロール'dialog'を使用してロードされます。デスクトップUIの場合、モーダル・ページがjQuery UIダイアログ・ウィジェットを使用してiframeにロードされます。デスクトップUIの場合、非モーダル・ページがポップアップ・ブラウザ・ウィンドウにロードされます。名前_self、_parentおよび_topは使用できません。ウィンドウ名は、他のアプリケーションと共有できないように一意にします。あらゆる手段を尽くしてそのウィンドウをフォーカスします。

パラメータ

pUrl {String} the url of the page to load.
pOptions {Object} object to identify the attributes of the dialog, with the following properties:
    title - the title of the dialog. The default is the name of the page.
    height - height of dialog content area, in pixels, default is 500.
    width - width of window content area, in pixels, default 500.
    maxWidth - maximum width of window content area, in pixels, default 1500.
    modal - true or false. Default is true.
    dialog_attributes - optional attribute, to allow the setting of any additional options supported by the underlying dialog implementation.
For example, to define jQuery UI Dialog attribute resizable:
    
    resizable:false
    
    See Also: See jQuery UI documentation of Dialog widget for all other available options for a modal dialog in a desktop user interface.
    http://api.jqueryui.com/
    
    See jQuery Mobile documentation of Dialog widget for all other available options for a modal dialog in a mobile user interface.
    http://jquerymobile.com/
 
pCssClasses {String} to identify the CSS classes, if any, to be applied to the dialog, and appended on to the dialogClass attribute
pTriggeringElement {String} jQuery selector to identify APEX page element opening the dialog

戻り値

Not applicable.

apex.navigation.dialog(url, {
    title:'About',
    height:'480',
    width:'800',
    maxWidth:'1200',
    modal:true,
    resizable:false },
    'a-Dialog--uiDialog',
    $('#myregion_static_id'));

apex.navigation.dialog.cancel(plsModal)

ダイアログ・ウィンドウを閉じます。

パラメータ

pIsModal {Boolean} to identify whether the dialog is modal.

戻り値

Not applicable.

apex.navigation.dialog.close(plsModal,pAction)

操作を実行して、ダイアログ・ウィンドウを閉じます。

パラメータ

pIsModal {Boolean} to identify whether the dialog is modal.
pAction {String, Function, Object} can be
    -) a URL which will trigger a redirect in the parent page
    -) a function to redirect to a different dialog page
    -) false to cancel the dialog
    -) an object of page items and values which will be exposed in the 'Dialog Closed dynamic action event

戻り値

Not applicable.

モーダル・ダイアログ・ページ間のチェーンを処理するには、次のようにします。

apex.navigation.dialog.close(true, function( pDialog ) {
    apex.navigation.dialog(url, {
        title:'About',
        height:'480',
        width:'800',
        maxWidth:'1200',
        modal:true,
        dialog:pDialog,
        resizable:false },
        'a-Dialog--uiDialog',
        $('#myregion_static_id'));
 
});

apex.navigation.dialog.fireCloseHandler(pHandler$,pAction)

ダイアログのオープン時に、registerCloseHandlerで登録されたダイアログの"close"内部イベントを起動します。

パラメータ

pOptions {Object} pOptions has to contain the following attributes
    "handler$" jQuery object where the event will be registered for.
    "dialog" DOM/jQuery/... object of the current dialog instance which will be passed into the open dialog call if the existing dialog should be re-used.
    "closeFunction" Function which is used to close the dialog.

戻り値

Not applicable.

apex.navigation.dialog.registerCloseHandler(pOptions)

ダイアログの"close"内部イベントを登録します。イベントはfireCloseEventによってトリガーされ、pActionで渡された値に応じて次のように動作します。

  • 既存のダイアログを再利用し、別のダイアログ・ページにナビゲートします

  • コール元の別のページにナビゲートします

  • ダイアログを取り消します

  • ダイアログを閉じ、"apexafterclosedialog"イベントをトリガーします

パラメータ

pOptions {Object} pOptions has to contain the following attributes
    "handler$" jQuery object where the event will be registered for.
    "dialog" DOM/jQuery/... object of the current dialog instance which will be passed into the open dialog call if the existing dialog should be re-used.
    "closeFunction" Function which is used to close the dialog.

戻り値

Not applicable.

apex.navigation.openInNewWindow(pUrl,pWindowName,pOptions)

指定されたURLを新しい名前付きウィンドウまたはタブで開きます(ブラウザ/ブラウザのユーザー・プリファレンス設定によってウィンドウを使用するかタブを使用するかを制御することもあります)。その名前のウィンドウがすでに存在する場合は、それを再利用します。名前_self、_parentおよび_topは使用できません。ウィンドウ名は、他のアプリケーションと共有できないように一意にします。あらゆる手段を尽くしてそのウィンドウをフォーカスします。


注意:

FirefoxおよびIEでは、タブがブラウザ・ウィンドウで現在アクティブなタブでない場合、そのタブはフォーカスされません。そのため、favorTabbedBrowsingがTRUEでない場合、このAPIではフォーカスされる可能性が高まるようにURLを新しいウィンドウで開くことを強制します。


注意:

Operaの場合、フォーカスが機能するように、「詳細設定」/「コンテンツ」 > 「JavaScriptオプション」: 「ウィンドウの強制前面表示を許可する」を選択する必要があります。


注意:

ポップアップ・ブロッカーによる抑制を回避するには、リンクまたはボタンのクリック・イベント・ハンドラからこのファンクションをコールします。

パラメータ

pUrl {String} the url of the page to load.
pWindowName {String} the name of the window (optional) The default is "_blank"
pOptions {Object} optional object with the following properties:
    favorTabbedBrowsing  - {Boolean} if true don't try to force a new window for the benefit of being able to focus it. This option only affects Firefox and IE.

戻り値

Returns the window object of the named window or null if for some reason the window isn't opened.

apex.navigation.openInNewWindow(url, "MyWindow");

apex.navigation.popup(pOptions)

指定されたURLを、一般的に名前付きの新しいポップアップ・ウィンドウで開きます。その名前のウィンドウがすでに存在する場合は、それを再利用します。名前が指定されていない場合または名前が"_blank"の場合は、新しい名前なしポップアップ・ウィンドウが開きます。名前_self、_parentおよび_topは使用できません。ウィンドウ名は、他のアプリケーションと共有できないように一意にします。


注意:

ポップアップ・ブロッカーによる抑制を回避するには、リンクまたはボタンのクリック・イベント・ハンドラからこのファンクションをコールします。

パラメータ

pOptions {Object} an object with the following optional properties:
    url - the page url to open in the window. The default is "about:blank"
    name - the name of the window. The default is "_blank", which opens a new unnamed window.
    height - height of window content area in pixels. Default 600
    width - width of window content area in pixels. Default 600
    scroll - "yes" or "no" Default is "yes"
    resizeable - "yes" or "no" Default is "yes"
    toolbar - "yes" or "no" Default is "no"
    location - "yes" or "no" Default is "no"
    statusbar - "yes" or "no" Default is "no" This controls the status feature
    menubar - "yes" or "no" Default is "no"

戻り値

Not applicable.

apex.navigation.popup ({
    url: "about:blank",
     name: "_blank",
     width: 400,
     height: 400,
     scroll: "no",
     resizable: "no",
     toolbar: "yes" });

apex.navigation.popup.close(pItem,pValue)

親ウィンドウ内のアイテム(pItem)の値を(pValue)に設定してから、ポップアップ・ウィンドウを閉じます。

パラメータ

pItem (DOM node | string ID)
pValue (string)

戻り値

Not applicable.

apex.navigation.redirect(pUrl)

指定されたページ(pUrl)を現在のウィンドウで開きます。

パラメータ

pWhere {String} the url of the page to open in the current window

戻り値

Not applicable.

apex.server namespace

apex.serverネームスペースは、Oracle Application Expressのサーバー部分と通信するためのすべてのAjaxファンクションを格納します。

apex.server.plugin(pAjaxIdentifier,pData,pOptions)

このファンクションは、プラグインに定義されているPL/SQL Ajaxファンクションをコールします。このファンクションは、jQuery.ajaxファンクションのラッパーであり、Application Expressに固有の追加機能に加えて、jQueryファンクションで提供されるすべての設定をサポートします。

パラメータ

表29-29 apex.server.plugin(pAjaxIdentifier,pData,pOptions)のパラメータ

パラメータ タイプ オプション/必須 説明

pAjaxIdentifier

(文字列)

必須

PL/SQLパッケージapex_plugin.get_ajax_identifierによって戻される値を使用して、プラグインを特定します。

pData

{オブジェクト}

オプション

Ajaxリクエストとともに送信される追加の値を送信するためにオプションで使用可能なオブジェクト。タイプにjQueryセレクタ、jQueryオブジェクト、DOMオブジェクトまたはアイテム名の配列を選択できる特別な属性pageItemsによって、URLに含む必要のあるページ・アイテムが指定されます。ただし、wwv_flow.showプロシージャによって提供される追加のパラメータを設定することもできます(たとえば、スカラー・パラメータx01 - x10および配列f01 - f20を設定できます)。

pOptions

{オブジェクト}

オプション

Ajaxによって使用される追加のオプションを設定するためにオプションで使用可能なオブジェクト。次に示すApplication Expressに固有のオプションの属性がサポートされます。

refreshObject: apexbeforerefreshイベントおよびapexafterrefreshイベントを起動するDOM要素を特定するjQueryセレクタ、jQueryオブジェクトまたはDOMオブジェクト。

refreshObjectData: apexbeforerefreshイベントおよびapexafterrefreshイベントをトリガーするコードによって内部で渡されるデータを指定して、これらのイベントに定義されたすべてのハンドラがこのデータにアクセスできるようにします。「リフレッシュ前」イベントまたは「リフレッシュ後」イベントに定義された動的アクションでは、JavaScriptからthis.dataプロパティを使用してこのデータにアクセスできます。カスタムjQueryイベント・ハンドラの場合、イベント・ハンドラのpDataパラメータを介してこのデータにアクセスできます。

clear: apexbeforerefreshイベントの起動後、実際のAjaxコールがトリガーされる前に、DOMをクリアするために使用されるJavaScriptファンクション。

loadingIndicator: ロード・インジケータの横に表示する必要のあるDOM要素を指定するjQueryセレクタ、jQueryオブジェクトまたはDOMオブジェクト。loadingIndicatorは、jQueryオブジェクトとしてロード・インジケータを取得するファンクションにすることもでき、作成されたロード・インジケータにjQuery参照を戻す必要があります。次に例を示します。

function( pLoadingIndicator ) {
    return pLoadingIndicator.prependTo ( apex.jQuery( "td.shuttleControl", gShuttle ))
}

loadingIndicatorPosition: ロード・インジケータの表示位置を定義する6つのオプション。loadingIndicatorに渡される値がファンクションでない場合にのみ考慮されます。

  • before: loadingIndicatorによって定義されるDOM要素の前に表示します。

  • after: loadingIndicatorによって定義されるDOM要素の後に表示します。

  • prepend: loadingIndicatorによって定義されるDOM要素の先頭の内側に表示します。

  • append: loadingIndicatorによって定義されるDOM要素の末尾の内側に表示します。

  • centered: loadingIndicatorによって定義されるDOM要素の中央に表示します。

  • page: ページの中央に表示します。

参照: 使用可能な他のすべての属性については、jQuery.ajaxに関するjQueryドキュメントを参照してください。dataType属性は、デフォルトでjsonに設定されます。

http://docs.jquery.com/


戻り値

表29-30 戻り値

タイプ 説明

{オブジェクト}

jqXHRオブジェクトを戻します。

参照: このオブジェクトの詳細は、jQueryドキュメントを参照してください。

http://docs.jquery.com/


apex.server.pluginへのこのコールによって、スカラー値x01test (apex_application.g_x01を使用してPL/SQLからアクセス可能)に設定され、セッション・ステートにページ・アイテムのP1_DEPTNOおよびP1_EMPNOの値が(jQueryセレクタ構文を使用して)設定されます。apexbeforerefreshイベントおよびapexafterrefreshイベントを起動する要素として、P1_MY_LISTアイテムが使用されます。P1_MY_LISTは、横にロード・インジケータが表示される要素として使用されます。成功のコールバックはスタブ・アウトされ、コールが正常に戻された際に起動される独自のコードを開発者が追加するために使用されます。lAjaxIdentifierの値は、サーバーのPL/SQL API apex_plugin.get_ajax_identifierによって戻される値に設定する必要があります。

成功のコールバックに対するpDataパラメータには、コールから送信されるすべてのレスポンスが含まれます。

apex.server.plugin ( lAjaxIdentifier, {
    x01: "test",
    pageItems: "#P1_DEPTNO,#P1_EMPNO"
    }, {
    refreshObject:     "#P1_MY_LIST",
    loadingIndicator:  "#P1_MY_LIST",
    success: function( pData ) { ... do something here ... }
    } );

apex.server.pluginUrl( pAjaxIdentifier, pData )

このファンクションは、プラグインに定義されているPL/SQL Ajaxファンクションに対してGETリクエストを発行するためのURLを戻します。

パラメータ

表29-31 apex.server.pluginUrl( pAjaxIdentifier, pData)のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pAjaxIdentifier

(文字列)

必須


PL/SQLパッケージapex_plugin.get_ajax_identifierによって戻される値を使用して、プラグインを特定します。

pData

{オブジェクト}

オプション


URLに含む追加の値を設定するためにオプションで使用可能なオブジェクト。タイプにjQueryセレクタ、jQueryオブジェクト、DOMオブジェクトまたはアイテム名の配列を選択できる特別な属性pageItemsによって、URLに含むページ・アイテムが指定されます。wwv_flow.showプロシージャによって提供される追加のパラメータを設定することもできます(たとえば、スカラー・パラメータx01 - x10および配列f01 - f20を設定できます)。


戻り値

表29-32 戻り値

タイプ 説明

(文字列)

GETリクエストを発行するためのURL。


apex.server.pluginUrlへのこのコールによって、プラグインに定義されているPL/SQL Ajaxファンクションに対してGETリクエストを発行するためのURLが戻され、スカラー値x01test (apex_application.g_x01を使用してPL/SQLからアクセス可能)に設定され、セッション・ステートにページ・アイテムのP1_DEPTNOおよびP1_EMPNOの値が(jQueryセレクタ構文を使用して)設定されます。lAjaxIdentifierの値は、サーバーのPL/SQL API apex_plugin.get_ajax_identifierによって戻される値に設定する必要があります。

var lUrl = apex.server.pluginUrl ( lAjaxIdentifier, {
  x01: "test",
  pageItems: "#P1_DEPTNO,#P1_EMPNO" } );

apex.server.process( pName, pData, pOptions )

このファンクションは、ページ・レベルまたはアプリケーション・レベルで定義されたPL/SQLオンデマンド(Ajaxコールバック)プロセスをコールします。このファンクションは、jQuery.ajaxファンクションのラッパーであり、Application Expressの追加機能を提供するとともに、jQueryファンクションで提供されるすべての設定をサポートします。

パラメータ

表29-33 apex.server.processのパラメータ

名前 タイプ オプション/必須 説明

pName

(文字列)

必須

コールするPL/SQLオンデマンド・ページ・プロセスまたはPL/SQLオンデマンド・アプリケーション・プロセスの名前。

pData

{オブジェクト}

オプション

Ajaxリクエストとともに送信される追加の値を送信するためにオプションで使用可能なオブジェクト。タイプにjQueryセレクタ、jQueryオブジェクト、DOMオブジェクトまたはアイテム名の配列を選択できる特別な属性pageItemsによって、URLに含むページ・アイテムが指定されます。wwv_flow.showプロシージャによって提供される追加のパラメータを設定することもできます(たとえば、スカラー・パラメータx01 - x10および配列f01 - f20を設定できます)。

pOptions

{オブジェクト}

オプション

Ajaxによって使用される追加のオプションを設定するためにオプションで使用可能なオブジェクト。

これは、次に示すApplication Expressに固有のオプションの属性をサポートします。

refreshObject: apexbeforerefreshイベントおよびapexafterrefreshイベントを起動するDOM要素を特定するjQueryセレクタ、jQueryオブジェクトまたはDOMオブジェクト。

refreshObjectData: apexbeforerefreshイベントおよびapexafterrefreshイベントをトリガーするコードによって内部で渡されるデータを指定して、これらのイベントに定義されたすべてのハンドラがこのデータにアクセスできるようにします。「リフレッシュ前」イベントまたは「リフレッシュ後」イベントに定義された動的アクションでは、JavaScriptからthis.dataプロパティを使用してこのデータにアクセスできます。カスタムjQueryイベント・ハンドラの場合、イベント・ハンドラのpDataパラメータを介してこのデータにアクセスできます。

clear: apexbeforerefreshイベントの起動後、実際のAjaxコールがトリガーされる前に、DOMをクリアするために使用されるJavaScriptファンクション。

loadingIndicator: ロード・インジケータの横に表示する必要のあるDOM要素を指定するjQueryセレクタ、jQueryオブジェクトまたはDOMオブジェクト。loadingIndicatorは、jQueryオブジェクトとしてロード・インジケータを取得するファンクションにすることもでき、作成されたロード・インジケータにjQuery参照を戻す必要があります。次に例を示します。

function( pLoadingIndicator ) {
  return lLoadingIndicator.prependTo ( apex.jQuery(
"td.shuttleControl", gShuttle ))
}

loadingIndicatorPosition: ロード・インジケータの表示位置を定義する6つのオプション。loadingIndicatorに渡される値がファンクションでない場合にのみ考慮されます。

before: loadingIndicatorによって定義されるDOM要素の前に表示します

after: loadingIndicatorによって定義されるDOM要素の後に表示します

prepend: loadingIndicatorによって定義されるDOM要素の先頭の内側に表示します

append: loadingIndicatorによって定義されるDOM要素の末尾の内側に表示します

centered: loadingIndicatorによって定義されるDOM要素の中央に表示します。

page: ページの中央に表示します。

参照: 使用可能な他のすべての属性については、jQuery.ajaxに関するjQueryドキュメントを参照してください。dataType属性は、デフォルトでjsonに設定されます。

このオブジェクトの詳細は、jQueryドキュメントを参照してください。

http://docs.jquery.com/


戻り値

表29-34 戻り値

タイプ 説明

{オブジェクト}

jqXHRオブジェクトを戻します。

このオブジェクトの詳細は、jQueryドキュメントを参照してください。

http://docs.jquery.com/


apex.server.processへのこのコールによって、MY_PROCESSというオンデマンド・プロセスがコールされ、スカラー値x01test (apex_application.g_x01を使用してPL/SQLからアクセス可能)に設定され、セッション・ステートにページ・アイテムのP1_DEPTNOおよびP1_EMPNOの値が(jQueryセレクタ構文を使用して)設定されます。成功のコールバックはスタブ・アウトされ、コールが正常に戻された際に起動される独自のコードを開発者が追加するために使用されます。

注意: 成功のコールバックに対するpDataパラメータには、コールから送信されるすべてのレスポンスが含まれます。

apex.server.process ( "MY_PROCESS", {
  x01: "test",
  pageItems: "#P1_DEPTNO,#P1_EMPNO"
  }, {
 success: function( pData ) { ... do something here ... }
  } );

apex.server.url( pData ) (pPage)

このファンクションは、現在のページに対してGETリクエストを発行するためのURLを戻します。

パラメータ

表29-35 apex.server.url( pData, pPage)のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pData

{オブジェクト}

オプション


URLに含む追加の値を設定するためにオプションで使用可能なオブジェクト。タイプにjQueryセレクタ、jQueryオブジェクト、DOMオブジェクトまたはアイテム名の配列を選択できる特別な属性pageItemsによって、URLに含むページ・アイテムが指定されます。wwv_flow.showプロシージャによって提供される追加のパラメータを設定することもできます(たとえば、スカラー・パラメータx01 - x10および配列f01 - f20を設定できます)。

pPage

{文字列}

オプション


戻されるURLにページIDを設定するためにオプションで使用可能な現在のページのページID。


戻り値

表29-36 戻り値

タイプ 説明

(文字列)

GETリクエストを発行するためのURL。


apex.server.urlへのこのコールによって、このページに定義されているDELETEファンクションに対してGETリクエストを発行するためのURLが戻され、スカラー値x01test (apex_application.g_x01を使用してPL/SQLからアクセス可能)に設定され、セッション・ステートにページ・アイテムのP1_DEPTNOおよびP1_EMPNOの値が(jQueryセレクタ構文を使用して)設定されます。

apex.server.url ({
    p_request: "DELETE",
    x01: "test",
    pageItems: "#P1_DEPTNO,#P1_EMPNO" });

apex.storageネームスペース

apex.storageネームスペースは、Oracle Application Expressのすべての記憶域関連ファンクションを格納します。

apex.storage.getCookie(pName)

Cookie名(pName)の値を戻します。

戻り値

Not applicable.

パラメータ

pName (String)

apex.storage.setCookie(pName,pValue)

Cookie (pName)を指定の値(pValue)に設定します。

戻り値

Not applicable.

パラメータ

pName (String)
pValue (String)

apex.utilネームスペース

apex.utilネームスペースは、Oracle Application Expressの汎用ユーティリティ・ファンクションを格納します。

apex.util.showSpinner

ユーザー処理が実行されていることを示すスピン・アラートをレンダリングするファンクション。アラートは、スクリーン・リーダーなどの支援テクノロジが処理ステータスへの注意を喚起されるようにARIAアラートとして定義されます。

パラメータ

表29-37 util.showSpinnerのパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pContainer

{オブジェクト}

オプション

$("body")

スピナーを中央に置くコンテナを特定するオプションのjQueryセレクタ、jQueryまたはDOMオブジェクト。渡されない場合、スピナーはページ全体の中央に配置されます。

pOptions

{オブジェクト}

オプション

Processing

"alert"オプション(非表示でも、支援テクノロジで使用可能なアラート・テキスト)があるオプションのオブジェクト。デフォルトは、Processingです。


戻り値

表29-38 戻り値

タイプ 説明

{オブジェクト}

スピナーのjQueryオブジェクト。


スピナーを表示するには、次のようにします。

var lSpinner$ = apex.util.showSpinner( $( "#container_id" ) );

スピナーを削除するには、次のようにします。

 lSpinner$.remove();

apex.util.delayLinger

delayLingerシングルトンは、点滅する進捗インジケータ(スピナーなど)の問題を解決します。しばらく時間がかかるAjaxリクエスト(および後続のユーザー・インタフェースの更新)などのプロセスの場合、何かが発生していることをユーザーに知らせることが重要です。問題は、非同期プロセスが高速の場合、進捗インジケータを必要としないことです。ユーザーは、ユーザー・インタフェースの更新を瞬時に体験します。ごく短時間の非同期プロセスに進捗インジケータを表示して非表示にすると、ユーザーが完全に理解する時間がないほど瞬間的にコンテンツが表示されることになります。良くても、邪魔なものとなり、悪ければ、何かおかしいとか、何か重要なことを見逃したのではないかとユーザーは考えます。インジケータが表示されてすぐにプロセスは終了することもあるため、進捗インジケータを遅らせるだけでは問題の解決になりません。リクエストがすでに終了していたとしても、せめて短くても認識できる程度の時間、インジケータを表示する必要があります。

このオブジェクトを使用すると、このようなapex.util.delayLingerなどの進捗実装による進捗表示の期間の管理が簡単になります。apex.serverネームスペースのファンクションなどのOracle Application Expressの組込み進捗インジケータの多くは、すでにdelayLingerを内部的に使用しているため、このAPIが必要となるのは、実行時間が長い独自のカスタム非同期処理についてのみです。

apex.util.delayLinger.start

このファンクションは、潜在的に実行時間が長い非同期プロセスが起動する際にコールします。各コールが指定されたpScopeNameで始まるには、対応するコールが同じpScopeNameで終わるようにする必要があります。別のpScopeName引数が指定されたコールは互いに干渉しません。

終了するためのコールの前に、同じpScopeNameに対して開始するためのコールが複数あってもかまいませんが、最初のコールのpActionのみが1回しかコールされません。

パラメータ

表29-39 apex.util.delayLinger.startファンクションのパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pScopeName

文字列



進捗インジケータごとに一意の名前。

pAction

ファンクション



進捗インジケータを表示するためにコールするファンクション。


apex.util.delayLinger.finish

このファンクションは、潜在的に実行時間が長い非同期プロセスが終了する際にコールします。各コールが指定されたpScopeNameで始まるには、対応するコールが同じpScopeNameで終わるようにする必要があります。pActionは、対応する開始pActionがコールされた場合のみ、1回コールされます。終了するためのコールが複数ある場合、最後のコールのpActionのみがコールされます。

パラメータ

表29-40 apex.util.delayLinger.finishファンクションのパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pScopeName

文字列



進捗インジケータごとに一意の名前

pAction

ファンクション



進捗インジケータを表示するためにコールするファンクション


var lSpinner$, lPromise;
lPromise = doLongProcess();
apex.util.delayLinger.start( "main", function() {
    lSpinner$ = util.showSpinner( $( "#container_id" ) );
} );
lPromise.always( function() {
    apex.util.delayLinger.finish( "main", function() {
        lSpinner$.remove();
    } );
} );

apex.widgetネームスペース

apex.widgetネームスペースは、Oracle Application Expressのすべてのウィジェット関連の汎用ファンクションを格納します。

apex.widget.initPageItem( pName, pOptions)

Application Expressのページ・アイテム名やDOMノードを指定すると、異なるコールバックおよびプロパティをページ・アイテムに登録できます。これは、プラグイン・アイテム・タイプに、Application Expressのクライアント側機能に関する組込みページ・アイテムをシームレスに統合するために必要です。

プラグインの実装の詳細は、『Oracle Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド』のプラグインの実装に関する説明を参照してください。

戻り値

なし。

パラメータ

表29-41 apex.widget.initPageItem( pName, pOptions )のパラメータ

名前 タイプ オプション/必須 デフォルト 説明

pName

(DOMノード|文字列)

必須


Application Expressのページ・アイテム名またはDOMノード。

pOptions

(オブジェクト)

必須(個別のプロパティはオプション)


コールバックおよび一部のアイテム固有値を指定するための、多くのプロパティをサポートします。これらのプロパティを指定することで、特定のプロパティに対してApplication Expressのデフォルト動作をオーバーライドできます。

pOptionプロパティの詳細は、表29-42「pOptionsパラメータのプロパティ」を参照してください。

pOptionsには、次のプロパティの1つを含めることができます。

  • getValue()

  • setValue( pValue, pDisplayValue )

  • enable()

  • disable()

  • show()

  • hide()

  • addValue()

  • nullValue()

  • setFocusTo

  • setStyleTo

  • afterModify()

  • loadingIndicator( pLoadingIndicator$ )


表29-42 pOptionsパラメータのプロパティ

名前 説明

getValue()

アイテム値を取得するためのファンクションを指定します(これによって、デフォルトのページ・アイテムの処理がオーバーライドされます)。アイテムが値を正しく戻すようにするということは、たとえばアイテムでWhen条件を評価するための「動的アクション」、またはアイテムの値を取得するためにJavaScriptファンクション$vをコールする場合などに、Application Expressのクライアント側機能に関する特定のアイテムが動作しているということです。

このファンクションを定義する方法の詳細は、「apex.item( pNd ).getValue()」を参照してください。

注意: Application Expressのそのアイテムのデフォルト処理が動作しているかどうかを最初にチェックする必要があります(動作している場合はこれを指定する必要がありません)。アイテム値が正確に戻されているかどうかを確認するために、apex.item( pNd ).getValue();をコールしてチェックできます。

setValue( pValue, pDisplayValue )

アイテム値を設定するためのファンクションを指定します(これによって、ページ・アイテムのデフォルトの処理がオーバーライドされます)。アイテムが値を正しく設定できるようにするということは、たとえば「動的アクション」の「値の設定」アクションを使用してアイテム値を設定する場合や、JavaScriptファンクション$sをコールしてアイテムの値を設定する場合などに、Application Expressのクライアント側機能に関する特定のアイテムが動作しているということです。

注意: このファンクションが定義されている場合でも、デフォルト処理によって常に.afterModify()ファンクションおよびpSuppressChangeEventパラメータと関連するロジックが処理されるため、プラグイン開発者が関係する範囲外となります。

このファンクションを定義する方法の詳細は、「apex.item( pNd ).setValue(pValue, pDisplayValue, pSuppressChangeEvent)」を参照してください。

注意: Application Expressのそのアイテムのデフォルト処理が動作しているかどうかを最初にチェックする必要があります(動作している場合はこれを指定する必要がありません)。アイテム値が正確に設定されているかどうかを確認するために、apex.item( pNd ).setValue( pValue );をコールしてチェックできます。

enable()

アイテムを有効化するためのファンクションを指定します(これによって、デフォルトのページ・アイテムの処理がオーバーライドされます)。これは、有効化も必要な複合要素からアイテムが構成されている場合、または再利用しようとする独自の有効化メソッドをすでに保有しているウィジェットにアイテムが基づいている場合などに、役立つ可能性があります。アイテムを正しく有効化できるようにするということは、たとえばアイテムを有効化するために「動的アクション」の「有効化」アクションを使用する場合に、Application Expressのクライアント側機能に関する特定のアイテムが動作していることになります

注意: このファンクションが定義されている場合でも、デフォルト処理によって常に.afterModify()ファンクションと関連するロジックが処理されるため、プラグイン開発者が関係する範囲外となります。

このファンクションを定義する方法の詳細は、「apex.item( pNd ).enable()」を参照してください。

注意: Application Expressのそのアイテムのデフォルト処理が動作しているかどうかを最初にチェックする必要があります(動作している場合はこれを指定する必要がありません)。アイテムが正しく有効化されているかどうかを確認するために、apex.item( pNd ).enable();をコールしてチェックできます。

disable()

アイテムを無効化するためのファンクションを指定します(これによって、デフォルトのページ・アイテムの処理がオーバーライドされます)。これは、無効化も必要な複合要素からアイテムが構成されている場合、または再利用しようとする独自の無効化メソッドをすでに保有しているウィジェットにアイテムが基づいている場合などに、役立つ可能性があります。アイテムを正しく無効化できるようにするということは、たとえばアイテムを無効化するために「動的アクション」の「無効化」アクションを使用する場合に、Application Expressのクライアント側機能関連の特定のアイテムが動作していることになります。

注意: このファンクションが定義されている場合でも、デフォルト処理によって常に.afterModify()ファンクションと関連するロジックが処理されるため、プラグイン開発者が関係する範囲外となります。

このファンクションを定義する方法の詳細は、「apex.item( pNd ).disable()」を参照してください。

注意: Application Expressのそのアイテムのデフォルト処理が動作しているかどうかを最初にチェックする必要があります(動作している場合はこれを指定する必要がありません)。アイテムが正しく無効化されているかどうかを確認するために、apex.item( pNd ).disable();をコールしてチェックできます。

show()

アイテムを表示するためのファンクションを指定します(これによって、デフォルトのページ・アイテムの処理がオーバーライドされます)。これは、表示も必要な複合要素からアイテムが構成されている場合、または再利用しようとする独自の表示メソッドをすでに保有しているウィジェットにアイテムが基づいている場合などに、役立ちます。アイテムを正しく表示できるようにするということは、たとえば「動的アクション」の「表示」アクションを使用する場合に、Application Expressのクライアント側機能に関する特定のアイテムが動作してアイテムを表示するということです。

このファンクションを定義する方法の詳細は、「apex.item( pNd ).show( pShowRow )」を参照してください。

注意: Application Expressのそのアイテムのデフォルト処理が動作しているかどうかを最初にチェックする必要があります(動作している場合はこれを指定する必要がありません)。アイテムが正しく表示されているかどうかを確認するために、apex.item( pNd ).show();をコールしてチェックできます。

hide()

アイテムを非表示にするためのファンクションを指定します(これによって、デフォルトのページ・アイテムの処理がオーバーライドされます)。これは、非表示も必要な複合要素からアイテムが構成されている場合、または再利用しようとする独自の非表示メソッドをすでに保有しているウィジェットにアイテムが基づいている場合などに、役立つ可能性があります。アイテムを正しく非表示にできるようにするということは、たとえば「動的アクション」の「非表示」アクションを使用する場合に、Application Expressのクライアント側機能に関する特定のアイテムが動作してアイテムを非表示にするということです。

このファンクションを定義する方法の詳細は、「apex.item( pNd ).hide( pHideRow)」を参照してください。

注意: Application Expressのそのアイテムのデフォルト処理が動作しているかどうかを最初にチェックする必要があります(動作している場合はこれを指定する必要がありません)。アイテムが正しく非表示になっているかどうかを確認するために、apex.item( pNd ).hide();をコールしてチェックできます。

addValue()

アイテムが複数の値をサポートする場合、アイテムに値を追加するためのファンクションを指定します。現在、これに依存するApplication Expressのクライアント側の機能はありません。デフォルトのページ・アイテム処理もありません。

注意: このファンクションが定義されている場合でも、デフォルト処理によって常に.afterModify()ファンクションと関連するロジックが処理されるため、プラグイン開発者が関係する範囲外となります。

このファンクションを定義する方法の詳細は、「apex.item( pNd ).addValue( pValue )」を参照してください。

nullValue

アイテムがnullかどうかの判断に使用される値を指定します。これは、アイテムが「LOV」の定義をサポートする場合、開発者がアイテムの「NULL戻り値」を定義できる場合、およびアイテムがnullまたは空の場合にアサートするため、これをデフォルトのアイテム処理で認識する必要がある場合に使用されます。これは、次の手順に従って行います。

  1. プラグイン定義のレンダリング・ファンクションから、ページがロードされる際に起動する、アイテム初期化JavaScriptコードの一部としてp_item.lov_null_valueに格納される値を送信します。次に例を示します。

    /* Assumes that you have some JavaScript function called 'com_your_company_your_item' that accepts 2 parameters, the first being the name of the item and the second being an object storing properties (say pOptions) required by the item's client side code. */
    apex_javascript.add_onload_code (
        p_code => 'com_your_company_your_item('||
                   apex_javascript.add_value(
                       apex_plugin_util.page_item_names_to_jquery(p_item.name)||', {'||
                           apex_javascript.add_attribute('lovNullValue', p_item.lov_null_value, false, false)||
                   '});' );
    
  2. 次に、com_your_company_your_item( pName, pOptions )の実装において、pOptions.lovNullValueプロパティに、特定のアイテムの「NULL戻り値」に値を定義します。これは、nullValueプロパティを設定するためのapex.widget.initPageItemへのコールに使用できます。

    nullValueプロパティを設定すると、たとえばアイテムに関するis nullまたはis not nullのwhen条件を正しく評価するための「動的アクション」において、またはアイテムがnullかどうかを判断するためにJavaScriptファンクションapex.item( pNd ).isEmpty()をコールする場合に、Application Expressのクライアント側機能に関する特定のアイテムが動作していることになります

    このAPIの詳細は、「apex.item( pNd ).isEmpty()」を参照してください。

setFocusTo

apex.item( pNd ).setFocus() APIを使用してアイテムにフォーカスを設定する際に、フォーカスを受けとるための要素を指定します。これは、jQueryセレクタ、jQueryまたはDOM要素を識別するDOMオブジェクト、または要素を参照するjQueryオブジェクトを戻すファンクションとして定義できます。これは、アイテムが複合要素から構成され、アイテム名と一致するIDがある要素にフォーカスが移動する(デフォルトの動作)必要がない場合に、役立つ可能性があります。たとえば、属性Input FieldNot enterable, Show Display Value and Store Return Valueに設定されている場合、ネイティブ・アイテム・タイプPopup LOVは、アイテム名と一致するIDのある主な要素として無効化された入力フィールドと、入力の隣のポップアップ選択アイコンをレンダリングします。この場合、無効化された入力に移動するためのフォーカスが不要であるため、setFocusToアイテムのプロパティを使用して、ポップアップ選択アイコンに設定します。

アイテムがフォーカスを正しく設定できるようにするということは、たとえば「動的アクション」のSet Focusアクションを使用してアイテムへのフォーカスを設定する場合、関連するアイテムに直接移動するために検証エラーのメッセージに表示されるGo to Errorリンクにユーザーが従う場合、またはアイテムがページにおける最初のアイテムで、開発者がページ・レベルの属性Cursor FocusFirst item on pageに設定した場合などに、Application Expressのクライアント側機能に関する特定のアイテムが動作していることになります。

このAPIの詳細は、「apex.item( pNd ).setFocus()」を参照してください。

注意: Application Expressのそのアイテムのデフォルト処理が動作しているかどうかを最初にチェックする必要があります(動作している場合はこれを指定する必要がありません)。このページでページ属性Cursor FocusFirst item on pageに設定されている場合、ページの最初のアイテムとしてこのアイテムを追加してからこのページを実行することによって、これをチェックできます。アイテムがフォーカスされます。

setStyleTo

apex.item( pNd ).setStyle() APIを使用してアイテムにスタイルを設定する際に、スタイルを受け取るための要素を指定します。これは、jQueryセレクタ、jQueryまたはDOM要素を識別するDOMオブジェクト、または要素を参照するjQueryオブジェクトを戻すファンクションとして定義できます。これは、アイテムが複合要素から構成され、要素にスタイルが設定される必要がない場合に、あるいはアイテム名と一致するIDのある要素のみから構成されている場合(デフォルトの動作)に、役立ちます。アイテムがスタイルを正しく設定できるようにするということは、たとえば「動的アクション」のSet Styleアクションを使用してアイテムにスタイルを追加する場合に、Application Expressのクライアント側機能に関する特定のアイテムが動作していることになります。

注意: このプロパティが定義されている場合でも、デフォルト処理によって常に.afterModify()ファンクションと関連するロジックが処理されるため、プラグイン開発者が関係する範囲外となります。

このAPIの詳細は、apex.item( pNd ).setStyle()に関するドキュメントを参照してください。

注意: Application Expressのそのアイテムのデフォルト処理が動作しているかどうかを最初にチェックする必要があります(動作している場合はこれを指定する必要がありません)。アイテムがスタイルを正確に設定しているかどうかを確認するために、apex.item( pNd ).setStyle( pPropertyName, pPropertyValue );をコールしてチェックできます。

afterModify()

アイテムが変更された後で、呼び出されるファンクションを指定します。これは、たとえばjQuery Mobileなどの一部のフレームワークでウィジェットの変更の有無が通知される必要があるときに(例: 値が設定されたり、これらがネイティブ制御と拡張制御の両方を同期するために無効化されたなど)役立ちます。これを行うためのフックが、このコールバックによって提供されます。

loadingIndicator( pLoadingIndicator$ )

アイテムの一部のページのリフレッシュ中に、アイテムのロード・インジケータが表示される方法を標準化するファンクションを指定します。このファンクションは、最初のパラメータとしてpLoadingIndicator$パラメータを渡す必要があり、ロード・インジケータに関してDOM要素への参照があるjQueryオブジェクトを含んでいます。次にこのファンクションはアイテムのページにおける適切なDOM要素にロード・インジケータを追加し、ロード・インジケータへjQueryオブジェクト参照をも戻すため(これへの参照がフレームワークにあるようなもの)、コールが完了するとこれを削除可能です。

これはたとえば、アイテムがCascading LOVであって「カスケードLOV親アイテム」が変更される場合、またはサーバー側の「動的アクション」(例: Set Value - SQL Statement)の1つを使用することによってアイテムの値を設定する場合に使用されます。


次の例では、利用可能なすべてのコールバックおよびプロパティが渡されたapex.widget.initPageItemへのコールを示しています。

apex.widget.initPageItem( "P100_COMPANY_NAME", {
    getValue:   function() {
        var lValue;
        // code to determine lValue based on the item type.
        return lValue;
    },
    setValue:   function( pValue, pDisplayValue ) {
        // code that sets pValue and pDisplayValue (if required), for the item type
    },
    enable:     function() {
        // code that enables the item type
    },
    disable:    function() {
        // code that disables the item type
    },
    show:       function() {
        // code that shows the item type
    },
    hide:       function() {
        // code that hides the item type
    },
    addValue:   function( pValue ) {
        // code that adds pValue to the values already in the item type
    },
    nullValue:  "<null return value for the item>",
    setFocusTo: $( "<some jQuery selector>" ),
    setStyleTo: $( "<some jQuery selector>" ),    
    afterModify:        function(){
        // code to always fire after the item has been modified (value set, enabled, etc.)
    },
    loadingIndicator:   function( pLoadingIndicator$ ){
        // code to add the loading indicator in the best place for the item
        return pLoadingIndicator$;
    }
});

非ネームスペースのJavascript API

この項には、Oracle Application Expressのその他すべての非ネームスペースのAPIが含まれています(非常によく使用されるファンクションへのショートカットを含む)。

$x(pNd)

DOMノードまたは文字列ID (pNd)を指定すると、このファンクションは、その要素がページ上に存在する場合はDOMノードを戻し、存在しない場合はFALSEを戻します。

戻り値

(DOM Node | false)

パラメータ

pNd (DOM Node | string ID)

$v(pNd)

DOMノードまたは文字列ID (pNd)を指定すると、このファンクションは、Application Expressアイテムがポストされた場合と同じ形式で、その値を戻します。

パラメータ

pNd (DOM Node | string ID)

$v2(pNd)

DOMノードまたは文字列ID(pNd)を指定すると、このファンクションは、Application Expressアイテムの値を文字列または配列として戻します。ページ・アイテムに、シャトル、チェックボックス、複数選択リストなど、複数の値が含まれる場合は配列が戻され、そうでない場合は文字列が戻されます。

戻り値

(string|array)

パラメータ

pNd (DOM Node | string ID)

$s(pNd, pValue, pDisplayValue, pSuppressChangeEvent)

DOMノードまたは文字列ID(pNd)を指定すると、このファンクションは、そのApplication Expressアイテムの型を考慮に入れて、値を設定します。pDisplayValueはオプションです。「入力フィールド」属性が「入力不可、表示値の表示と戻り値の格納」である、「ポップアップLOV」タイプのページ・アイテムに使用する場合、「入力フィールド」を設定します。pValueの値は非表示の戻り値フィールドに格納されます。pSuppressChangeEventパラメータの指定は任意です。FALSEを渡した場合、またはこのパラメータ値を渡さない場合は、変更イベントが生成され、設定されているアイテムを実行します。変更イベントによって設定されているアイテムが実行されるのを防ぐには、TRUEを渡します。

パラメータ

pNd (DOM Node | string ID)
pValue  (String | Array)
pDisplayValue(String)
pSuppressChangeEvent(Boolean)

$u_Narray(pNd)

DOMノード、文字列IDまたは配列(pNd)を指定すると、このファンクションは、pNdが配列でも、要素が1つしかなく、その要素の値が戻される場合には単一値を戻し、それ以外の場合は配列を戻します。1つまたは複数のDOMノードに対応可能なDOMベースの機能を作成する場合に使用されます。

戻り値

Array (DOM Node | string ID | Array)

パラメータ

Array or first value

$u_Carray(pNd)

指定されたDOMノード、文字列IDまたは配列(pNd)に対して、このファンクションは配列を戻します。1つまたは複数のDOMノードに対応可能なDOMベースの機能を作成する場合に使用されます。

戻り値

pNd (DOM Node | string ID | Array)

パラメータ

Array

$nvl(pTest, pDefault)

pTestが空またはFALSEの場合はpDefaultを戻し、それ以外の場合はpTestを戻します。

戻り値

(string | Array)

パラメータ

pTest  (String | Array)
pDefault (String | Array)

$x_Style(pNd, pStyle, pString)

DOMノードまたはDOMノード配列(pNd)の特定のスタイル・プロパティ(pStyle)を指定の値(pString)に設定します。

戻り値

(DOM node | DOM Array)

パラメータ

pNd (DOM node | string ID | DOM node Array )
pStyle (String)
pString (String)

$x_Hide(pNd)

1つのDOMノードまたは配列のDOMノード(pNd)を非表示にします。非表示にされているApplication Expressアイテムのタイプも考慮されます。

戻り値

(DOM node | Array)

パラメータ

pNd (DOM node | string ID | DOM node Array )

$x_Show(pNd)

1つのDOMノードまたは配列のDOMノード(pNd)を表示します。非表示にされているApplication Expressアイテムのタイプも考慮されます。

戻り値

(DOM node | Array)

パラメータ

pNd (DOM node | string ID | DOM node Array )

$x_Toggle(pNd)

1つのDOMノードまたは配列のDOMノード(pNd)を切り替えます。

戻り値

(DOM node | Array)

パラメータ

pNd (DOM node | string ID | Array)

$x_Remove(pNd)

1つのDOMノードまたは配列のDOMノードを削除します。

戻り値

(DOM Node | Array)

パラメータ

pNd (DOM node | string ID | DOM node Array)

$x_Value(pNd,pValue)

1つのDOMノードまたは配列のDOMノード(pNd)の値(pValue)を設定します。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID | DOM node Array)
pValue (String)

$x_UpTill(pNd, pToTag)

このファンクションは、DOMノード(pNd)から開始して、ノード名のタグ(pToTag)が検出されるまでDOMツリーの上位の方にカスケードします。オプションのpToClassが指定されている場合、祖先ノードはpToTagと同じノード名を持ち、pToClassと同じクラスである必要があります。

戻り値

(DOM Node | false)

パラメータ

pNd  (DOM Node | string ID) 
String (pToTag) 
String (pToClass ) 

$x_ItemRow(pNd,pFunc)

DOMノードまたはDOMノードの配列を指定すると、このファンクションは、そのDOMノードまたはDOMノードの配列を含む行全体を表示するか、非表示にするか、または切り替えます。これは、ページ・アイテムを使用する場合に最も役立ちます。このファンクションは、含まれるtr要素を明示的に検索するため、表のレイアウトでのみ機能します。

戻り値

Not applicable.

パラメータ

pNd (DOM Node | string ID | Dom node Array) 
pFunc ['TOGGLE','SHOW','HIDE'] (String )

$x_HideItemRow(pNd)

ページ・アイテム名を指定すると、このファンクションは、そのアイテムを保持している行全体を非表示にします。ほとんどの場合、これはアイテムおよびそのラベルです。このファンクションは、含まれるtr要素を明示的に検索するため、表のレイアウトでのみ機能します。

戻り値

Not applicable.

パラメータ

pNd (DOM Node | string ID | DON node Array)

$x_ShowItemRow(pNd)

ページ・アイテム名を指定すると、このファンクションは、そのアイテムを保持している行全体を表示します。ほとんどの場合、これはアイテムおよびそのラベルです。このファンクションは、含まれるtr要素を明示的に検索するため、表のレイアウトでのみ機能します。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID | DOM note Array)

$x_ToggleItemRow(pNd)

ページ・アイテム名(pNd)を指定すると、このファンクションは、そのアイテムを保持している行全体を切り替えます。ほとんどの場合、これはアイテムおよびそのラベルです。このファンクションは、含まれるtr要素を明示的に検索するため、表のレイアウトでのみ機能します。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID | DOM node ray)

$x_HideAllExcept(pNd,pNdArray)

pNdArrayから参照されているすべてのDOMノードを非表示にし、pNdで参照されているDOMノードを表示します。これは、pNdpNdArrayのノードでもある場合に最も役立ちます。

戻り値

(DOM node | DOM Array)

パラメータ

pNd (DOM node | string ID | DOM node Array) 
pNdArray (DOM node | String | Array)

$x_HideSiblings(pNd)

指定されたpNdの兄弟ノードをすべて非表示にします。

戻り値

(DOM node)

パラメータ

pNd (DOM node | string ID )

$x_ShowSiblings(pNd)

指定されたDOMノード(pNd)の兄弟DOMノードをすべて表示します。

戻り値

(DOM node)

パラメータ

pNd (DOM node | string ID )

$x_Class(pNd,pClass)

1つのDOMノードまたは配列のDOMノードを1つのクラス名に設定します。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID | DOM node Array)
pClass (String)

$x_SetSiblingsClass(pNd, pClass, pNdClass)

ノード(pNd)のすべての兄弟DOMノードのクラス(pClass)を設定します。pNdClassがNULLでない場合、pNdpNdClassに設定されます。

戻り値

(DOM node | false)

パラメータ

pNd (DOM Nnde | string ID)
pClass (String)
pThisClass (String)

$x_ByClass(pClass, pNd, pTag)

指定されたクラス名(pClass)に基づいて、DOMノードの配列を戻します。pNdパラメータが提示されている場合、戻される要素はすべてそのDOMノードの子になります。pTagパラメータも指定すると、戻り値が絞り込まれて、そのタグ・タイプのノードのみが戻されます。

戻り値

(Array)

パラメータ

pClass (String)
pNd  (DOM node | string ID)
pTag (String)

$x_ShowAllByClass(pNd, pClass, pTag)

DOMノード(pNd)の子で、特定のクラス(pClass)およびタグ(pTag)を持つDOMノードをすべて表示します。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID)
pClass (String)
pTag (String)

$x_ShowChildren(pNd)

DOMノード(pNd)の子のDOMノードをすべて表示します。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID)

$x_HideChildren(pNd)

DOMノード(pNd)の子のDOMノードをすべて非表示にします。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID)

$x_disableItem(pNd, pTest)

1つのアイテムまたは配列のアイテムを、(pTest)に基づいて無効または有効にします。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID | DOM node array)
a (true | false)

$f_get_emptys(pNd, pClassFail, pClass)

1つのアイテムまたは配列のアイテムが空かどうかをチェックし、空のすべてのアイテムについてそのクラスをpClassFailに設定します。空でないすべてのアイテムについては、クラスをpClassに設定します。

戻り値

false, Array  Array of all items that are empty (false | Array)

パラメータ

pNd (DOM node | string ID | DOM node Array)
Sting (pClassFail)
Sting (pClass)

$v_Array(pNd)

アイテムの値を配列として戻します。複数選択およびチェック・ボックスで役立ちます。

戻り値

(Array)

パラメータ

pId (DOM Node | string ID)

$f_ReturnChecked(pNd)

アイテムの値を配列として戻します。ラジオ・アイテムおよびチェック・ボックスで役立ちます。

戻り値

(Array)

パラメータ

pId (DOM node | string ID)

$d_ClearAndHide(pNd)

1つのDOMノードまたは配列のDOMノードの内容をクリアし、そのノードを非表示にします。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID | DOM node array)

$f_SelectedOptions(pNd)

選択アイテム(pNd)の選択されたオプションのDOMノードを戻します。

戻り値

(DOM Array)

パラメータ

pNd (DOM node | string ID)

$f_SelectValue(pNd)

選択アイテム(pNd)の選択されたオプションの値を戻します。

戻り値

(DOM Array | String)

パラメータ

pNd (DOM node | string ID)

$u_ArrayToString(pArray, pDelim)

指定された配列(pArray)について、その値を指定の区切り文字(pDelim)で区切った文字列を戻します。

戻り値

Not applicable.

パラメータ

pArray (pArray)
pDelim (String)

$x_CheckImageSrc(pId,pSearch)

イメージ(pId)のsource属性に、部分文字列(pSearch)が含まれているかどうかをチェックします。ファンクションは、部分文字列(pSearch)が見つかった場合、TRUEを戻します。部分文字列(pSearch)が見つからない場合、FALSEを戻します。

戻り値

(true | false)

パラメータ

pId (DOM Node | String)
pSearch (pSearch)

$v_CheckValueAgainst(pThis, pValue)

ページ・アイテム(pThis)の値と、一連の値(pValue)を照合します。値が一致すると、このファンクションはTRUEを戻します。

戻り値

(true | false)

パラメータ

pThis (DOM node | string ID)
pValue (Number | String | Array)

$f_Hide_On_Value_Item(pThis, pThat, pValue)

ページ・アイテム(pThis)の値と値(pValue)を照合します。一致した場合は、DOMノード(pThat)が非表示に設定されます。一致しなかった場合は、DOMノード(pThat)が表示されるように設定されます。

戻り値

(true | false)

パラメータ

pThis (DOM node | string ID)
pThat  (DOM node | string ID | DOM node Array )
pValue (Number | String | Array)

$f_Show_On_Value_Item(pThis, pThat, pValue)

ページ・アイテム(pThis)の値と値(pValue)を照合します。一致した場合は、DOMノード(pThat)が表示に設定されます。一致しなかった場合は、DOMノード(pThat)が非表示にされるように設定されます。

戻り値

(true | false)

パラメータ

pThis (DOM node | string ID)
pThat  (DOM node | string ID | DOM node Array )
pValue (Number | String | Array)

$f_Hide_On_Value_Item_Row(pThis, pThat, pValue)

アイテム(pThis)の値(pValue)をチェックします。一致した場合、このファンクションは、表内の(pThat)を保持する行を非表示にします。一致しなかった場合は、その行を表示します。

戻り値

(true | false)

パラメータ

pThis (DOM node | string ID)
pThat  (DOM node | string ID | DOM node Array )
pValue (Number | String | Array)

$f_Show_On_Value_Item_Row(pThis, pThat, pValue)

アイテム(pThis)の値(pValue)をチェックします。一致した場合、このファンクションは、表内の(pThat)を保持する行を表示します。一致しなかった場合は、その行を非表示にします。

戻り値

(true | false)

パラメータ

pThis (DOM node | string ID)
pThat  (DOM node | string ID | DOM node Array )
pValue (Number | String | Array)

$f_DisableOnValue(pThis, pValue, pThat)

アイテム(pThis)の値(pValue)をチェックします。一致した場合、このファンクションは、そのアイテムまたは配列のアイテム(pThat)を無効にします。一致しなかった場合は、アイテムを有効にします。

戻り値

(true | false)

パラメータ

pThis (DOM node | string ID)
pValue (String)
pThat  (DOM node | string ID | DOM node Array )

$x_ClassByClass(pNd, pClass, pTag, pClass2)

配列のノードをクラスによって選択し、そのクラス属性を設定します。

戻り値

(DOM node | DOM node Array)

パラメータ

pNd (DOM node | string ID)
pClass (String)
pTag (String)
pClass2 (String)

$f_ValuesToArray(pThis, pClass, pTag)

クラス属性が(pClass)、ノード名が(pTag)のDOMノード(pThis)に含まれるフォーム・アイテムの値を収集して、配列を戻します。

戻り値

No applicable.

パラメータ

pThis (DOM node | string ID)
pCLass (String)
pTag (String)

$x_FormItems(pNd, pType)

特定のタイプ(pType)のDOMノード(pThis)に含まれているフォーム入力アイテムをすべて戻します。

戻り値

DOM node Array

パラメータ

pNd (DOM node | string ID)
pType (String)

$f_CheckAll(pThis, pCheck, pArray)

DOMノード(pThis)に含まれるすべてのチェック・ボックスを選択または選択解除(pCheck)します。DOMノードのチェック・ボックスの配列(pArray)が指定されている場合は、その配列を対象のチェック・ボックスとして使用します。

戻り値

Not applicable.

パラメータ

pThis (DOM node | string ID)
pCheck (true | fales)
pArray (DOM node array)

$f_CheckFirstColumn(pNd)

このファンクションは、表の最初の列にあるすべてのチェック・ボックスを、コール先のチェック・ボックス(pNd)の選択状態に基づいて設定します。これは、表形式のフォームで役立ちます。

戻り値

DOM node Array

パラメータ

pNd (DOM node | String)

$x_ToggleWithImage(pThis,pNd)

イメージ要素(pThis)およびDOMノード(pNd)を指定すると、このファンクションは、DOMノード(pNd)の表示状態を切り替えます。イメージ要素(pThis)のsrc属性はリライトされます。イメージのsrcは、プラスの部分文字列がマイナスの部分文字列で置換されるか、またはマイナスの部分文字列がプラスの部分文字列で置換されます。

戻り値

(DOM Node)

パラメータ

pThis (DOM Node | string ID)
pNd (DOM Nnde | string iD | DOM node Array)

$x_SwitchImageSrc(pNd, pSearch, pReplace)

イメージ(pId)のsrc属性に部分文字列(pSearch)が含まれているかどうかをチェックします。その部分文字列が検出されると、このファンクションはイメージのsrc属性全体を(pReplace)で置換します。

戻り値

(DOM node | false)

パラメータ

pNd (DOM node | string ID)
pSearch (String)
pReplace (String)

$x_CheckImageSrc(pNd, pSearch)

イメージ(pNd)のsource属性に、部分文字列(pSearch)が含まれているかどうかをチェックします。ファンクションは、部分文字列(pSearch)が見つかった場合、TRUEを戻します。部分文字列(pSearch)が見つからない場合、FALSEを戻します。

戻り値

(true | fales)

パラメータ

pNd  (DOM node | string ID)
pSearch (String)

$u_SubString(pText,pMatch)

文字列(pText)に部分文字列(pMatch)が含まれるかどうかで、TRUEまたはFALSEを戻します。

戻り値

(true | false)

パラメータ

pText (String) 
pMatch (String)

html_RemoveAllChildren(pNd)

DOMメソッドを使用して、DOMノード(pND)の子のDOMをすべて削除します。

戻り値

Not applicable.

パラメータ

pNd (DOM node | string ID) 

html_SetSelectValue(pId,pValue)

選択アイテム(pId)の値(pValue)を設定します。値が検出されない場合、このファンクションは最初のオプションを選択します(通常はNULLを選択します)。

戻り値

Not applicable.

パラメータ

pId (DOM node | String)
pValue (String)

addLoadEvent(pFunction)

onloadファンクション(func)を追加します。すでに指定されたonloadファンクションが存在している場合でも、そのファンクションは上書きされません。

戻り値

Not applicable.

パラメータ

pFunction (Javascript Function)

$f_Swap(pThis,pThat)

2つのフォーム要素(pThispThat)のフォーム値を交換します。

戻り値

Not applicable.

パラメータ

pThis (DOM Node | String)
pThat (DOM Node | String)

$f_SetValueSequence(pArray,pMultiple)

フォーム・アイテムの配列(pArray)に(pMultiple)の倍数の連番を設定します。

戻り値

Not applicable.

パラメータ

pArray (Array) 
pMultiple (Number)

$dom_AddTag(pThis, pTag, pText)

innerHTMLを(pText)に設定し、html要素(pTag)をDOMノード(pThis)の子ノードとして挿入します。

戻り値

DOM node

パラメータ

pThis (DOM node | string ID ) 
pTag (String)
pText (String)

$tr_AddTD(pThis,pText)

表のセルを表の行(pThis)に追加します。内容を(pText)に設定します。

戻り値

(DOM node)

パラメータ

pThis (DOM node | string ID)
pText (String)

$tr_AddTH(pThis,pText)

表のセルを表の行(pThis)に追加します。内容を(pText)に設定します。

戻り値

DOM node

パラメータ

pThis (DOM node | string ID)
pTest (String)

$dom_AddInput(pThis,pType,pId,pName,pValue)

ID (pId)および名前(pName)の値をpValueに設定して、htmlフォーム入力要素(pType)をDOMノード(pThis)の子ノードとして挿入します。

戻り値

(DOM node)

パラメータ

pThis (DOM node | string ID)
pType (String)
pId (String)
pName (String)
pValue (String)

$dom_MakeParent(p_Node,p_Parent)

DOMノード(p_Node)をDOMノード(p_Parent)の子にしてから、DOMノード(pNode)を戻します。

戻り値

(DOM node)

パラメータ

p_This (DOM node | string ID)
p_Parent (DOM node | string ID)

$x_RowHighlight(pThis, pColor)

表の行のDOM要素(pThis)を指定すると、このファンクションは、表のすべてのセルの背景色を(pColor)に設定します。グローバル変数gCurrentRowpThisに設定されます。

戻り値

Not applicable.

パラメータ

pThis (DOM node | String)
pColor(String)

$x_RowHighlightOff(pThis)

表の行のDOMノード(pThis)を指定すると、このファンクションは、表のすべてのセルの背景をNULLに設定します。

戻り値

Not applicable.

パラメータ

pThis (DOM Element | String)

$v_Upper(pNd)

フォーム・アイテム(pNd)の値を大文字にします。

戻り値

Not applicable.

パラメータ

pNd (DOM Node | String)

$d_Find(pThis,pString,pTags,pClass)

DOMノード(pThis)の子ノードで、そのinnerHTMLがpStringのいずれかのインスタンスに一致するものを非表示にします。子ノードを絞り込むには、タグ名(pTag)またはクラス名(pClass)を指定します。子ノードは、表示可能に設定されている場合にブロック・レベル要素に設定されます。

戻り値

Not applicable.

パラメータ

pThis (DOM node | String)
pString (String)
pTags (String 
pClass (String)

$f_First_field(pNd)

ユーザーのフォーカスをフォーム・アイテム(pNd)に移動します。pNdが検出されなかった場合は、ユーザー編集が可能なフィールドで、最初に検出されたフィールドにフォーカスが移動します。

戻り値

true (if successful)

パラメータ

pNd

レガシーJavaScript API

ページのレンダリング時にOracle Application ExpressによってロードされるJavaScriptの合計サイズを削減する作業が開始されました。各ページで提供されなくなったJavaScript機能は、徐々にレガシーJavaScriptファイルに移動され、/i/libraries/apex/legacy.jsで確認できます。

アプリケーションの開発時に、開発者は、レガシーJavaScript機能を含めるかどうかを選択できます。これは、アプリケーションの「共有コンポーネント」の下にある「ユーザー・インタフェース属性」ページで、「レガシーJavaScriptを含める」プロパティを使用して行うことができます。

既存のアプリケーションは、下位互換性を確保するために、このオプションを有効にして移行されます。レガシー・ファイルを含めないようにするには、レガシー・ファイルにリスト表示されているファンクションを確認し、アプリケーションおよび関連するJavaScriptファイルがこれらのファイルを参照していないかを検索する必要があります。これらの機能への参照が見つからなかった場合は、レガシー・ファイルを含めずに、より小さいライブラリの利益を得ることができます。

新しいアプリケーションの開発時は、Desktopユーザー・インタフェース・タイプを使用するすべてのアプリケーションに、デフォルトでレガシー・ファイルが含まれます。「jQuery Mobileスマートフォン」ユーザー・インタフェース・タイプを使用する新しいアプリケーションに、このファイルは含まれません。

このレガシーJavaScriptへの依存性を減らすため、新しいアプリケーションの開発と既存のアプリケーションの開発の両方で、legacy.jsにあるファンクションの使用を継続しないことをお薦めします。

$v_PopupReturn(pValue, pThat) [非推奨]

親ウィンドウ(pThat)内のアイテムの値を(pValue)に設定してから、ポップアップ・ウィンドウを閉じます。


注意:

この関数は非推奨です。この場合は、次を使用します。

apex.navigation.popup(pOptions)

既存のアプリケーションでは、レガシーJavaScriptファイル(legacy.js)が含まれるため、古い機能を引き続き使用できます。このファイルを含めるかどうかの制御方法の詳細は、『Oracle Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド』のデータベース・アプリケーションに関する説明を参照してください。


戻り値

Not applicable.

パラメータ

pValue (string)
pThat (DOM node | string ID)

$v_IsEmpty(pThis) [非推奨]

フォーム要素が空かどうかでTRUEまたはFALSEを戻します(空白、タブ、フォーム・フィードなどの空白文字を空と見なします)。アイテムで指定された任意のNULL値も考慮されます。


注意:

この関数は非推奨です。この場合は、次を使用します。

apex.item( pNd ).isEmpty()

既存のアプリケーションでは、レガシーJavaScriptファイル(legacy.js)が含まれるため、古い機能を引き続き使用できます。このファイルを含めるかどうかの制御方法の詳細は、『Oracle Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド』のデータベース・アプリケーションに関する説明を参照してください。


戻り値

[true | false]

パラメータ

pThis (DOM Node | String)

submitEnter(pNd,e) [非推奨]

テキスト・フィールドで[Enter]が押されたときにページを送信し、リクエスト値をDOMノード(pNd)のIDに設定します。

例: onkeypress="submitEnter(this,event)"


注意:

この関数は非推奨です。この場合は、次を使用します。

apex.submit( { submitIfEnter : event })

submitIfEnter pOptionsプロパティの使用方法の詳細は、apex.submitを参照してください。既存のアプリケーションでは、レガシーJavaScriptファイル(legacy.js)が含まれるため、古いファンクションを引き続き使用できます。このファイルを含めるかどうかの制御方法の詳細は、『Oracle Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド』のデータベース・アプリケーションに関する説明を参照してください。


戻り値

Not applicable.

パラメータ

pNd (DOM node | String | Array)

setReturn(p_R,p_D) [非推奨]

ポップアップからのアイテムの移入に使用できるように、DOMアイテムをグローバル変数returnInput(p_R)およびreturnDisplay(p_D)に設定します。


注意:

このファンクションは非推奨であり、値が非常に制限されるため、かわりの値はありません。

既存のアプリケーションでは、レガシーJavaScriptファイル(legacy.js)が含まれるため、古い機能を引き続き使用できます。このファイルを含めるかどうかの制御方法の詳細は、『Oracle Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド』のデータベース・アプリケーションに関する説明を参照してください。


戻り値

Not applicable.

パラメータ

p_R
p_D

GetCookie (pName) [非推奨]

Cookie名(pName)の値を戻します。


注意:

この関数は非推奨です。この場合は、次を使用します。

apex.storage.getCookie(pName)

既存のアプリケーションでは、レガシーJavaScriptファイル(legacy.js)が含まれるため、古い機能を引き続き使用できます。このファイルを含めるかどうかの制御方法の詳細は、『Oracle Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド』のデータベース・アプリケーションに関する説明を参照してください。


戻り値

Not applicable.

パラメータ

pName (String)

SetCookie (pName,pValue) [非推奨]

Cookie (pName)を指定の値(pValue)に設定します。


注意:

この関数は非推奨です。この場合は、次を使用します。

apex.storage.setCookie(pName,pValue)

既存のアプリケーションでは、レガシーJavaScriptファイル(legacy.js)が含まれるため、古い機能を引き続き使用できます。このファイルを含めるかどうかの制御方法の詳細は、『Oracle Application Expressアプリケーション・ビルダー・ユーザーズ・ガイド』のデータベース・アプリケーションに関する説明を参照してください。


戻り値

Not applicable.

パラメータ

pName (String)
pValue (String)