概要

イベント発生時の処理を定義します。

eventDefの子要素として定義した場合、レイアウトに対するイベント処理を記述します。

componentの子要素として定義した場合、GUIオブジェクトのイベント処理を記述します。

  • タグの記述例
      1
      2
      3
      4
    
    <component id="ch_defaultBt">
      <event id="onclick" type="local" start="ch_text_init" >
      </event>
    </component>

event

  • 属性一覧
属性名概要必須形式デフォルト値
idGUIオブジェクトから発生するイベント名
component要素で指定したGUIオブジェクトから発生するイベント名を記述する
string
remoteUrl通信リクエスト先のURL
URLはコンテナHTMLからの相対パスを指定する
string
type処理の種別

remote(リモート処理) : サーバ通信を伴う処理
local(ローカル処理) : サーバ通信を伴わない処理

ローカル処理の場合、before属性とafter属性は無視される
enum"remote"
async非同期通信を有効にする

true : 有効
false : 無効
booleantrue
ref参照用イベント定義名
eventRef要素のイベント定義名を設定することで、eventRef要素の子要素として定義されたheader要素、param要素、result要素が参照できる
string
startイベント発生直後に呼び出される関数名
以下の引数が渡される

boolean param.stopProcess: trueを指定すると後続の処理をすべて中止してイベント処理を終了する
function
beforeHTTP要求送信直前に呼び出される関数名
以下の引数が渡される
string param.sendXML: 送信されるXML文字列
XMLHttpRequest param.xhr: XMLHttpRequestオブジェクト
boolean param.stopProcess: trueを指定すると後続の処理をすべて中止してイベント処理を終了する
function
after応答メッセージ受信直後に呼び出される関数名
以下の引数が渡される
DOM param.recvDOM: DOM型の受信XML
XMLHttpRequest param.xhr: XMLHttpRequestオブジェクト
boolean param.stopProcess: trueを指定すると後続の処理をすべて中止してイベント処理を終了する
function
finishイベント処理終了直前に呼び出される関数
引数なし
function
timeout通信タイムアウト時間[ms]
タイムアウト時はonTimeoutError属性で指定した関数を呼び出し、後続の処理をすべて中止してイベント処理を終了する
number
onTimeoutErrorタイムアウト発生時に呼び出される関数名
引数なし
function
confirmDialogレイアウト定義XMLに定義したcomfirmDialogのGUIオブジェクト名を定義する
この属性を定義することで、レイアウト定義XMLに定義したcomfirmDialogを表示する
start関数とbefore関数の間のタイミングで呼び出される
string
endDialogレイアウト定義XMLに定義したendDialogのGUIオブジェクト名を定義する
この属性を定義することで、レイアウト定義XMLに定義したendDialogを表示する
finish関数後のタイミングで呼び出される
string
  • 子要素一覧
要素名概要繰り返し
headerHTTP要求時に付与するHTTPヘッダを定義する0..*
paramリモートイベント発生時にサーバに送信する要求メッセージを定義する0..1
resultリモートイベント発生時にサーバに受信する応答メッセージを定義する0..1
descコメント0..1