Skip to content
This repository has been archived by the owner on Jan 27, 2020. It is now read-only.

Latest commit

 

History

History
80 lines (79 loc) · 10.7 KB

api_list.md

File metadata and controls

80 lines (79 loc) · 10.7 KB

    日本語  中文  English

efw Javascript API

efw
├─client
│  ├─fire ( eventParams )                             //クライアントからサーバイベントを実行する関数
│  │         ├─server                                 //    サーバURL
│  │         ├─eventId                                //    イベントId
│  │         ├─manualParams                           //    手動パラメータ
│  │         └─success ( eventResult )                //    成功コールバック関数
│  ├─pickup ( paramsFormat , manualParams )           //パラメータ値を取得する関数(fire関数機能の一部分)
│  ├─show ( eventResult )                             //値を画面に表示する関数(fire関数機能の一部分)
│  ├─alert ( message , callback )                     //クライアントでアラートメッセージを表示する関数
│  └─format
│      └─...                                          //後続のefw.server.formatとほぼ同じ機能、その説明をご参照。
└─server
    ├─prepare ( event , requestParams )               //サーバイベントの準備処理関数、サーバ処理カスタマイズ用
    │
    │            event
    │            ├─outOfLogin                         //ログインチェック不要フラグ
    │            ├─include                            //サブイベントを取り込むためのインクルード
    │            │  ├─eventId                         //    サブイベントId
    │            │  └─mergeParamsFormat               //    サブとメインのパラメータフォーマットをマージするフラグ
    │            ├─paramsFormat                       //パラメーターフォーマット
    │            │  └─checkStyle                      //チェックスタイル
    │            │     ├─required                     //    必須入力
    │            │     ├─format                       //    フォーマット
    │            │     ├─display-name                 //    表示名
    │            │     ├─max-length                   //    最大サイズ
    │            │     ├─min                          //    最小値
    │            │     └─max                          //    最大値
    │            └─fire ( requestParams )             //イベント実行関数
    │               ├─eventResult                     //イベント実行結果
    │               │  ├─runat                        //    表示場所
    │               │  ├─withdata                     //    表示データ
    │               │  ├─remove                       //    削除内容
    │               │  └─append                       //    htmlマスク
    │               ├─download                        //ダウンロード
    │               │  ├─file                         //    単独ファイル
    │               │  ├─zip                          //    複数ファイル
    │               │  ├─saveas                       //    保存名称
    │               │  └─deleteafterdownload          //    ダウンロード後元ファイル削除フラグ
    │               └─error                           //エラーオブジェクト
    │                   ├─errorType                   //    エラータイプ
    │                   ├─errorMessage                //    エラーメッセージ
    │                   ├─focusTo                     //    カーソル位置
    │                   ├─elements                    //    複数のエラー項目
    │                   └─canNotContinue              //    継続処理不可フラグ
    │
    ├─finish ( event , requestParams , eventResult )  //サーバイベントの後処理関数、サーバ処理カスタマイズ用
    ├─format
    │  ├─formatNumber ( value , formatter , rounder ) //数字値を指定フォーマットにより文字列に変換する関数
    │  ├─parseNumber ( value , formatter )            //文字列値を指定フォーマットにより数字に変換する関数
    │  ├─formatDate ( value , formatter )             //日付値を指定フォーマットにより文字列に変換する関数
    │  └─parseDate ( value , formatter )              //文字列値を指定フォーマットにより日付に変換する関数
    ├─properties
    │  ├─get ( key , defaultValue )                   //文字列のプロパティを取得する関数
    │  ├─getBoolean ( key , defaultValue )            //ブルーのプロパティを取得する関数
    │  └─getInt ( key , defaultValue )                //数字のプロパティを取得する関数
    ├─session
    │  ├─get ( key )                                  //セッションから情報を取得する関数
    │  └─set ( key , value )                          //セッションに情報を格納する関数
    └─db
       ├─open ( jdbcResourceName )                    //データベース接続を開く関数
       ├─getSingle ( executionParams )                //SELECT文を実行して1つ目のデータを戻す関数
       │              ├─jdbcResourceName              //    jdbcのリソース名
       │              ├─groupId                       //    SQLのグループId
       │              ├─sqlId                         //    SQLのId
       │              ├─params                        //    SQLパラメータ
       │              └─mapping                       //    マッピング
       ├─executeQuery ( executionParams )             //SELECT文を実行する関数
       │  └─executionResult                           //SQL検索結果
       ├─executeUpdate ( executionParams )            //INSERT文、UPDATE文、DELETE文を実行する関数
       ├─execute ( executionParams )                  //任意のSQL文を実行する関数
       ├─commit ( jdbcResourceName )                  //データベースへの更新を有効とする関数
       ├─rollback ( jdbcResourceName )                //データベースへの更新を無効とする関数
       └─closeAll ( )                                 //すべてのデータベース接続をコミットして閉じる関数