画面部品で共通のJavaScript APIを、以下に示します。
- getPropertyメソッド
メソッド | getProperty(name) |
引数 | name [String] | プロパティ名 |
戻り値 | [任意] | プロパティ値 |
例外 | 引数が省略された場合、または空文字列が指定された場合、エラーになります。(RCF11006) |
説明 | プロパティ値を取得します。 スタイルプロパティを取得する場合は、getStyleメソッドを利用してください。 |
- setPropertyメソッド
メソッド | setProperty(name,value) |
引数 | name [String] | プロパティ名 |
value [任意] | プロパティ値 |
戻り値 | なし |
例外 | 以下の場合にエラーとなります。 引数が省略された場合(RCF11006) nameに空文字列が指定された場合(RCF11006) nameに存在していないプロパティ名を指定した場合(RCF11008) 変更不可のプロパティを指定した場合(RCF11002)
|
説明 | プロパティ値を設定します。 スタイルプロパティを設定する場合は、setStyleメソッドを利用してください。 |
- getDataProviderメソッド
メソッド | getDataProvider(name) |
引数 | name [String] | プロパティ名 |
戻り値 | [任意] (データプロバイダの種類による) | データプロバイダ |
例外 | 以下の場合にエラーとなります。 |
説明 | 部品のプロパティを操作するデータプロバイダを取得します。 |
- getStyleメソッド
メソッド | getStyle(name) |
引数 | name [String] | スタイルプロパティ名 |
戻り値 | [任意] | プロパティ値 |
例外 | なし |
説明 | スタイルの値を取得します。 ブラウザによって取得できる値が異なる場合があります。 RCF.addInitializedListenerに設定した関数内で実行した場合、正しい値が取得できないことがあります。 |
- setStyleメソッド
メソッド | setStyle(name,value) |
引数 | name [String] | スタイルプロパティ名 |
value [任意] | プロパティ値 |
戻り値 | なし |
例外 | なし |
説明 | スタイルを設定します。 指定できないスタイルプロパティ名および指定できない値が設定された場合は、表示に反映されません。 RCF.addInitializedListenerに設定した関数内で使用した場合、正しく動作しません。 |
- showメソッド
メソッド | show() |
引数 | なし |
戻り値 | なし |
例外 | なし |
説明 | 部品を可視化します。 さらにこの部品にshowイベントが発行され、onShowイベントリスナが呼ばれます。 |
- hideメソッド
メソッド | hide() |
引数 | なし |
戻り値 | なし |
例外 | なし |
説明 | 部品を不可視化します。 さらにこの部品にhideイベントが発行され、onHideイベントリスナが呼ばれます。 |
- isVisibleメソッド
メソッド | isVisible() |
引数 | なし |
戻り値 | [Boolean] | 部品の可視状態 true:可視化 false:不可視化 |
例外 | なし |
説明 | 部品の可視状態を取得します。 Internet Explorer 9 標準、Internet Explorer 10 標準、およびInternet Explorer 11 標準以外のInternet Explorerでは、コンテナ部品などの親要素の可視状態は戻り値には反映されません。親要素の可視状態と組み合わせて判定してください。 |