EventRequestオブジェクト
コンポーネント情報 | |
---|---|
version | 7.1 |
since | 7.1 |
イベントリクエストオブジェクト。
イベントを処理するため、ポートレットにイベント要求情報を提供します。
このオブジェクトは、ブラウザからの要求があるたびに生成され、ファンクション・コンテナの handleEvent() 関数の引数として渡されます。
イベントを処理するため、ポートレットにイベント要求情報を提供します。
このオブジェクトは、ブラウザからの要求があるたびに生成され、ファンクション・コンテナの handleEvent() 関数の引数として渡されます。
メソッドの概要
返却値の型 | メソッド名 |
---|---|
Array | getAttributeNames () このリクエストで利用可能な属性名を含む配列型のオブジェクトを返します。 |
Object | getAttribute (String name , Object obj ) 指定された名前の属性値を返します。 |
Array | getParameterNames () すべてのリクエストパラメータ名を返します。 |
String | getParameterValue (String name ) 指定のキーに該当する URL 引数データを返却します。 |
Array | getParameterValues (String name ) 指定のキーに該当する URL 引数データ群を返却します。 |
RequestParameter | getParameter (String name ) 指定の名前をもつリクエストパラメータを返します。 |
String | getPortletMode () ポートレットモードを返します。 |
String | getWindowID () ポートレットのウィンドウIDを返します。 |
String | getWindowState () 現在のポートレットのウィンドウ状態を返します。 |
void | removeAttribute (String name ) このリクエストから属性を削除します。 |
void | setAttribute (String name , Object obj ) このリクエストに属性をセットします。 |
メソッドの詳細
Array getAttributeNames ()
このリクエストで利用可能な属性名を含む配列型のオブジェクトを返します。
返却値
|
Object getAttribute (String name , Object obj )
指定された名前の属性値を返します。
指定された名前が存在しない場合は、第2引数で指定されたObjectを返します。
パラメータ
返却値
|
Array getParameterNames ()
すべてのリクエストパラメータ名を返します。
配列の各要素は、パラメータ名を表す String です。
返却値
|
String getParameterValue (String name )
指定のキーに該当する URL 引数データを返却します。
キーは、フォームのコントロール名称(name 属性)を指定します。 返却値は指定キーに該当するデータ(文字列)です。 該当するデータが配列の場合は、先頭のデータを返却します。 指定キーに該当する URL 引数が1つも存在しない場合はnullを返却します。
パラメータ
返却値
|
Array getParameterValues (String name )
指定のキーに該当する URL 引数データ群を返却します。
キーは、フォームのコントロール名称(name 属性)を指定します。 返却値は指定キーに該当するデータ(文字列)の個数と同等の要素を持つ配列です。 指定キーに該当する URL 引数が1つも存在しない場合は空の配列を返却します。
パラメータ
返却値
|
RequestParameter getParameter (String name )
指定の名前をもつリクエストパラメータを返します。
パラメータ
返却値
|
String getPortletMode ()
ポートレットモードを返します。
取得可能なポートレットモードは、ポートレットに依存します。 ポートレットプログラミングガイドを参照してください。
返却値
|
String getWindowID ()
ポートレットのウィンドウIDを返します。
返却値
|
String getWindowState ()
現在のポートレットのウィンドウ状態を返します。
返却される値は以下のいずれかとなります。
返却値
|
void removeAttribute (String name )
このリクエストから属性を削除します。
属性はリクエストがコンテナ内で処理されている間だけ維持されるにすぎないので、 通常、このメソッドは必要ありません。
パラメータ
返却値
|
void setAttribute (String name , Object obj )
このリクエストに属性をセットします。
パラメータ
返却値
|