9 JavaScript API

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

このセクションの構成は次のとおりです。

$x(pNd)
$v(pNd)
$s(pNd, pValue)
$u_Carray(pNd)
$u_Narray(pNd)
$nvl(pTest, pDefault)
doSubmit(pRequest)
confirmDelete(pMessage, pRequest)
$x_Style(pNd, pStyle, pString)
$x_Hide(pNd)
$x_Show(pNd)
$x_Toggle(pNd)
$x_Remove(pNd)
$x_Value(pNd,pValue)
$x_UpTill(pNd, pToTag)
$x_ItemRow(pNd,pFunc)
$x_HideItemRow(pNd)
$x_ShowItemRow(pNd)
$x_ToggleItemRow(pNd)
$x_HideAllExcept(pNd,pNdArray)
$x_HideSiblings(pNd)
$x_ShowSiblings(pNd)
$x_Class(pNd,pClass)
$x_SetSiblingsClass(pNd, pClass, pNdClass)
$x_ByClass(pClass, pNd, pTag)
$x_ShowAllByClass(pNd, pClass, pTag)
$x_ShowChildren(pNd)
$x_HideChildren(pNd)
$x_disableItem(pNd, pTest)
$f_get_emptys(pNd, pClassFail, pClass)
$v_Array(pNd)
$f_ReturnChecked(pNd)
$d_ClearAndHide(pNd)
$f_SelectedOptions(pNd)
$f_SelectValue(pNd)
$u_ArrayToString(pArray, pDelim)
$x_CheckImageSrc(pId,pSearch)
$v_CheckValueAgainst(pThis, pValue)
$f_Hide_On_Value_Item(pThis, pThat, pValue)
$f_Show_On_Value_Item(pThis, pThat, pValue)
$f_Hide_On_Value_Item_Row(pThis, pThat, pValue)
$f_Show_On_Value_Item_Row(pThis, pThat, pValue)
$f_DisableOnValue(pThis, pValue, pThat)
$x_ClassByClass(pNd, pClass, pTag, pClass2)
$f_ValuesToArray(pThis, pClass, pTag)
$x_FormItems(pNd, pType)
$f_CheckAll(pThis, pCheck, pArray)
$f_CheckFirstColumn(pNd)
$v_PopupReturn(pValue, pThat)
$x_ToggleWithImage(pThis,pNd)
$x_SwitchImageSrc(pNd, pSearch, pReplace)
$x_CheckImageSrc(pNd, pSearch)
$u_SubString(pText,pMatch)
html_RemoveAllChildren(pNd)
$v_IsEmpty(pThis)
html_SetSelectValue(pId,pValue)
addLoadEvent(pFunction)
$f_Swap(pThis,pThat)
submitEnter(pNd,e)
$f_SetValueSequence(pArray,pMultiple)
$dom_AddTag(pThis, pTag, pText)
$tr_AddTD(pThis,pText)
$dom_AddInput(pThis,pType,pId,pName,pValue)
$dom_MakeParent(p_Node,p_Parent)
$x_RowHighlight(pThis, pColor)
$x_RowHighlightOff(pThis)
$v_Upper(pNd)
$d_Find(pThis,pString,pTags,pClass)
returnInput(p_R, p_D)
setReturn(p_R,p_D)
$f_First_field(pNd)
GetCookie (pName)
SetCookie (pName,pValue)

$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)

$s(pNd, pValue)

DOMノードまたは文字列ID（pNd）を指定すると、このファンクションは、そのApplication Expressアイテムの型を考慮した上で、値を設定します。

パラメータ

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

$u_Carray(pNd)

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

戻り値

pNd (DOM Node | string ID | Array)

パラメータ

Array

$u_Narray(pNd)

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

戻り値

Array (DOM Node | string ID | Array)

パラメータ

Array or first value

$nvl(pTest, pDefault)

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

戻り値

(string | Array)

パラメータ

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

doSubmit(pRequest)

ページを送信して、Application Express Requestの値（pRequest）を設定します。

パラメータ

pRequest (String)

confirmDelete(pMessage, pRequest)

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

パラメータ

pMessage (string)
pRequest (string)

$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）を非表示にします。

戻り値

(DOM node | Array)

パラメータ

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

$x_Show(pNd)

1つのDOMノードまたは配列のDOMノード（pNd）を表示します。

戻り値

(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ノード（pNd）を削除します。

戻り値

(DOM Node | Array)

パラメータ

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

$x_Value(pNd,pValue)

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

戻り値

該当なし

パラメータ

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

$x_UpTill(pNd, pToTag)

このファンクションは、DOMノード（pNd）から開始して、ノード名のタグ（pToTag）が検出されるまでDOMツリーの上位の方にカスケードします。

戻り値

(DOM Node | false)

パラメータ

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

$x_ItemRow(pNd,pFunc)

DOMノードまたはDOMノードの配列を指定すると、このファンクションは、そのDOMノードまたはDOMノードの配列を含む行全体を表示するか、非表示にするか、または切り替えます。これは、ページ・アイテムを使用する場合に最も役立ちます。

戻り値

該当なし

パラメータ

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

$x_HideItemRow(pNd)

ページ・アイテム名を指定すると、このファンクションは、そのアイテムを保持している行全体を非表示にします。ほとんどの場合、これはアイテムおよびそのラベルです。

戻り値

該当なし

パラメータ

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

$x_ShowItemRow(pNd)

ページ・アイテム名を指定すると、このファンクションは、そのアイテムを保持している行全体を表示します。ほとんどの場合、これはアイテムおよびそのラベルです。

戻り値

該当なし

パラメータ

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

$x_ToggleItemRow(pNd)

ページ・アイテム名（pNd）を指定すると、このファンクションは、そのアイテムを保持している行全体を切り替えます。ほとんどの場合、これはアイテムおよびそのラベルです。

戻り値

該当なし

パラメータ

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

$x_HideAllExcept(pNd,pNdArray)

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

戻り値

(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つのクラス名に設定します。

戻り値

該当なし

パラメータ

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

$x_SetSiblingsClass(pNd, pClass, pNdClass)

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

戻り値

(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ノードをすべて表示します。

戻り値

該当なし

パラメータ

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

$x_ShowChildren(pNd)

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

戻り値

該当なし

パラメータ

pNd (DOM node | string ID)

$x_HideChildren(pNd)

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

戻り値

該当なし

パラメータ

pNd (DOM node | string ID)

$x_disableItem(pNd, pTest)

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

戻り値

該当なし

パラメータ

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ノードの内容を消去し、そのノードを非表示にします。

戻り値

該当なし

パラメータ

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）で区切った文字列を戻します。

戻り値

該当なし

パラメータ

pArray (pArray)
pDelim (String)

$x_CheckImageSrc(pId,pSearch)

イメージ（pId）のsource属性に、部分文字列（pSearch）が含まれているかどうかをチェックします。このファンクションでは、部分文字列（pSearch）が検出されるとtrueが戻り、検出されない場合は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)

戻り値

(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)

戻り値

(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）が指定されている場合は、その配列を対象のチェック・ボックスとして使用します。

戻り値

該当なし

パラメータ

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

$f_CheckFirstColumn(pNd)

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

戻り値

DOM node Array

パラメータ

pNd (DOM node | String)

$v_PopupReturn(pValue, pThat)

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

戻り値

該当なし

パラメータ

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

$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が戻り、検出されない場合は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をすべて削除します。

戻り値

該当なし

パラメータ

pNd (DOM node | string ID)

$v_IsEmpty(pThis)

フォーム要素が空かどうかでtrueまたはfalseを戻します。空白、タブ、フォーム・フィードなどの空白文字は、空とみなされます。

戻り値

[true | false]

パラメータ

pThis (DOM Node | String)

html_SetSelectValue(pId,pValue)

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

戻り値

該当なし

パラメータ

pId (DOM node | String)
pValue (String)

addLoadEvent(pFunction)

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

戻り値

該当なし

パラメータ

pFunction (Javascript Function)

$f_Swap(pThis,pThat)

2つのフォーム要素（pThis、pThat）のフォーム値を交換します。

戻り値

該当なし

パラメータ

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

submitEnter(pNd,e)

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

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

戻り値

該当なし

パラメータ

pNd (DOM node | String | Array)

$f_SetValueSequence(pArray,pMultiple)

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

戻り値

該当なし

パラメータ

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）に設定します。グローバル変数gCurrentRowはpThisに設定されます。

戻り値

該当なし

パラメータ

pThis (DOM node | String)
pColor(String)

$x_RowHighlightOff(pThis)

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

戻り値

該当なし

パラメータ

pThis (DOM Element | String)

$v_Upper(pNd)

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

戻り値

該当なし

パラメータ

pNd (DOM Node | String)

$d_Find(pThis,pString,pTags,pClass)

DOMノード（pThis）の子ノードで、そのinnerHTMLがpStringのいずれかのインスタンスに一致するものを非表示にします。子ノードを絞り込むには、タグ名（pTag）またはクラス名（pClass）を指定します。子ノードは、表示するように設定されると、ブロック・レベル要素に設定されることに注意してください。

戻り値

該当なし

パラメータ

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

returnInput(p_R, p_D)

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

戻り値

該当なし

パラメータ

p_R (DOM node | String)
p_R (DOM node | String)

setReturn(p_R,p_D)

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

戻り値

該当なし

パラメータ

p_R
p_D

$f_First_field(pNd)

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

戻り値

true (if successful)

パラメータ

pNd

GetCookie (pName)

Cookie名（pName）の値を戻します。

戻り値

該当なし

パラメータ

pName (String)

SetCookie (pName,pValue)

Cookie（pName）を指定の値（pValue）に設定します。

戻り値

該当なし

パラメータ

pName (String)
pValue (String)