プライマリ・コンテンツに移動

Oracle® Application Express APIリファレンス リリース5.1 E85937-02 |
| 目次 | 索引

前 | 次 |

# 31.16 非ネームスペースのJavaScript API

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

- $x
- $v
- $v2
- $s
- $u_Narray
- $u_Carray
- $nvl
- $x_Style
- $x_Hide
- $x_Show
- $x_Toggle
- $x_Remove
- $x_Value
- $x_UpTill
- $x_ItemRow
- $x_HideItemRow
- $x_ShowItemRow
- $x_ToggleItemRow
- $x_HideAllExcept
- $x_HideSiblings
- $x_ShowSiblings
- $x_Class
- $x_SetSiblingsClass
- $x_ByClass
- $x_ShowAllByClass
- $x_ShowChildren
- $x_HideChildren
- $x_disableItem
- $f_get_emptys
- $v_Array
- $f_ReturnChecked
- $d_ClearAndHide
- $f_SelectedOptions
- $f_SelectValue
- $u_ArrayToString
- $x_CheckImageSrc
- $v_CheckValueAgainst
- $f_Hide_On_Value_Item
- $f_Show_On_Value_Item
- $f_Hide_On_Value_Item_Row
- $f_Show_On_Value_Item_Row
- $f_DisableOnValue
- $x_ClassByClass
- $f_ValuesToArray
- $x_FormItems
- $f_CheckAll
- $f_CheckFirstColumn
- $x_ToggleWithImage
- $x_SwitchImageSrc
- $x_CheckImageSrc
- $u_SubString
- html_RemoveAllChildren
- html_SetSelectValue
- addLoadEvent
- $f_Swap
- $f_SetValueSequence
- $dom_AddTag
- $tr_AddTD
- $tr_AddTH
- $dom_AddInput
- $dom_MakeParent
- $x_RowHighlight
- $x_RowHighlightOff
- $v_Upper
- $d_Find
- $f_First_field

## 31.16.1 $x

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

パラメータ

    pNd (DOM Node | string ID)

戻り値

    (DOM Node | false)

## 31.16.2 $v

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

パラメータ

    pNd (DOM Node | string ID)

## 31.16.3 $v2

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

パラメータ

    pNd (DOM Node | string ID)

戻り値

    (string|array)

## 31.16.4 $s

DOMノードまたは文字列ID`(pNd)`を指定すると、このファンクションは、そのApplication Expressアイテムの型を考慮に入れて、値を設定します。`pDisplayValue`はオプションです。`"Input Field" = "Not Enterable, Show Display Value and Store Return Value"`属性である、`Popup LOV`タイプのページ・アイテムに使用する場合、`"Input Field"`を設定します。`pValue`の値は非表示の戻り値フィールドに格納されます。`pSuppressChangeEvent`パラメータの指定は任意です。`false`を渡した場合、またはこのパラメータ値を渡さない場合は、変更イベントが生成され、設定されているアイテムを実行します。変更イベントによって設定されているアイテムが実行されるのを防ぐには、`true`を渡します。

パラメータ

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

## 31.16.5 $u_Narray

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

パラメータ

配列または最初の値

戻り値

    Array (DOM Node | string ID | Array)

## 31.16.6 $u_Carray

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

パラメータ

    Array

戻り値

    pNd (DOM Node | string ID | Array)

## 31.16.7 $nvl

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

パラメータ

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

戻り値

    (string | Array)

## 31.16.8 $x_Style

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

パラメータ

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

戻り値

    (DOM node | DOM Array)

## 31.16.9 $x_Hide

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

パラメータ

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

戻り値

    (DOM node | Array)

## 31.16.10 $x_Show

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

パラメータ

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

戻り値

    (DOM node | Array)

## 31.16.11 $x_Toggle

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

パラメータ

    pNd (DOM node | string ID | Array)

戻り値

    (DOM node | Array)

## 31.16.12 $x_Remove

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

パラメータ

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

戻り値

    (DOM Node | Array)

## 31.16.13 $x_Value

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

パラメータ

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

戻り値

なし。

## 31.16.14 $x_UpTill

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

パラメータ

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

戻り値

    (DOM Node | false)

## 31.16.15 $x_ItemRow

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

パラメータ

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

戻り値

なし。

## 31.16.16 $x_HideItemRow

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

パラメータ

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

戻り値

なし。

## 31.16.17 $x_ShowItemRow

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

パラメータ

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

戻り値

なし。

## 31.16.18 $x_ToggleItemRow

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

パラメータ

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

戻り値

なし。

## 31.16.19 $x_HideAllExcept

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

パラメータ

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

戻り値

    (DOM node | DOM Array)

## 31.16.20 $x_HideSiblings

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

パラメータ

    pNd (DOM node | string ID )

戻り値

    (DOM node)

## 31.16.21 $x_ShowSiblings

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

パラメータ

    pNd (DOM node | string ID )

戻り値

    (DOM node)

## 31.16.22 $x_Class

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

パラメータ

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

戻り値

なし。

## 31.16.23 $x_SetSiblingsClass

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

パラメータ

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

戻り値

    (DOM node | false)

## 31.16.24 $x_ByClass

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

パラメータ

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

戻り値

    (Array)

## 31.16.25 $x_ShowAllByClass

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

パラメータ

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

戻り値

なし。

## 31.16.26 $x_ShowChildren

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

パラメータ

    pNd (DOM node | string ID)

戻り値

なし。

## 31.16.27 $x_HideChildren

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

パラメータ

    pNd (DOM node | string ID)

戻り値

なし。

## 31.16.28 $x_disableItem

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

パラメータ

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

戻り値

なし。

## 31.16.29 $f_get_emptys

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

パラメータ

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

戻り値

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

## 31.16.30 $v_Array

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

パラメータ

    pId (DOM Node | string ID)

戻り値

    (Array)

## 31.16.31 $f_ReturnChecked

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

パラメータ

    pId (DOM node | string ID)

戻り値

    (Array)

## 31.16.32 $d_ClearAndHide

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

パラメータ

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

戻り値

なし。

## 31.16.33 $f_SelectedOptions

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

パラメータ

    pNd (DOM node | string ID)

戻り値

    (DOM Array)

## 31.16.34 $f_SelectValue

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

パラメータ

    pNd (DOM node | string ID)

戻り値

    (DOM Array | String)

## 31.16.35 $u_ArrayToString

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

パラメータ

    pArray (pArray)
    pDelim (String)

戻り値

なし。

## 31.16.36 $x_CheckImageSrc

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

パラメータ

    pId (DOM Node | String)
    pSearch (pSearch)

戻り値

    (true | false)

## 31.16.37 $v_CheckValueAgainst

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

パラメータ

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

戻り値

    (true | false)

## 31.16.38 $f_Hide_On_Value_Item

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

パラメータ

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

戻り値

    (true | false)

## 31.16.39 $f_Show_On_Value_Item

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

パラメータ

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

戻り値

    (true | false)

## 31.16.40 $f_Hide_On_Value_Item_Row

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

パラメータ

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

戻り値

    (true | false)

## 31.16.41 $f_Show_On_Value_Item_Row

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

パラメータ

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

戻り値

    (true | false)

## 31.16.42 $f_DisableOnValue

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

パラメータ

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

戻り値

    (true | false)

## 31.16.43 $x_ClassByClass

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

パラメータ

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

戻り値

    (DOM node | DOM node Array)

## 31.16.44 $f_ValuesToArray

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

パラメータ

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

戻り値

なし。

## 31.16.45 $x_FormItems

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

パラメータ

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

戻り値

    DOM node Array

## 31.16.46 $f_CheckAll

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

パラメータ

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

戻り値

なし。

## 31.16.47 $f_CheckFirstColumn

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

パラメータ

    pNd (DOM node | String)

戻り値

    DOM node Array

## 31.16.48 $x_ToggleWithImage

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

パラメータ

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

戻り値

    (DOM Node)

## 31.16.49 $x_SwitchImageSrc

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

パラメータ

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

戻り値

    (DOM node | false)

## 31.16.50 $x_CheckImageSrc

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

パラメータ

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

戻り値

    (true | fales)

## 31.16.51 $u_SubString

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

パラメータ

    pText (String)
    pMatch (String)

戻り値

    (true | false)

## 31.16.52 html_RemoveAllChildren

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

パラメータ

    pNd (DOM node | string ID)

戻り値

なし。

## 31.16.53 html_SetSelectValue

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

パラメータ

    pId (DOM node | String)
    pValue (String)

戻り値

なし。

## 31.16.54 addLoadEvent

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

パラメータ

    pFunction (Javascript Function)

戻り値

なし。

## 31.16.55 $f_Swap

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

パラメータ

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

戻り値

なし。

## 31.16.56 $f_SetValueSequence

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

パラメータ

    pArray (Array)
    pMultiple (Number)

戻り値

なし。

## 31.16.57 $dom_AddTag

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

パラメータ

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

戻り値

    DOM node

## 31.16.58 $tr_AddTD

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

パラメータ

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

戻り値

    (DOM node)

## 31.16.59 $tr_AddTH

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

パラメータ

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

戻り値

    DOM node

## 31.16.60 $dom_AddInput

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

パラメータ

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

戻り値

    (DOM node)

## 31.16.61 $dom_MakeParent

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

パラメータ

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

戻り値

    (DOM node)

## 31.16.62 $x_RowHighlight

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

パラメータ

    pThis (DOM node | String)
    pColor(String)

戻り値

なし。

## 31.16.63 $x_RowHighlightOff

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

パラメータ

    pThis (DOM Element | String)

戻り値

なし。

## 31.16.64 $v_Upper

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

パラメータ

    pNd (DOM Node | String)

戻り値

なし。

## 31.16.65 $d_Find

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

パラメータ

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

戻り値

なし。

## 31.16.66 $f_First_field

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

パラメータ

    pNd

戻り値

    true (if successful)