アプリケーション
このドキュメントでは、以下の設定要素の詳細を提供しています。
要件
Reference Framework 2.0 は Nexaweb Platform 4.5.33 以上で稼働します。
Globals
アプリケーション全体で使用するコンポーネントのリストを含む要素 (例:MCO、 マクロ、 データソースまたは全ての名前空間からの全ての要素)
設定
<globals> <mco/> <macro/> </globals>
ショートカットキー
アプリケーション内で使用するショートカットキー定義の一覧を含みます。
設定
<shortcutKeys> <shortcut key="F5" o nCommand="PageManager.loadPage( 'dataIntegration' )" role="ROLE_ADMIN"/> </shortcutKeys>
<shortcutKeys>
アプリケーション内で使用されるためロードされるショートカットキー定義の一覧を含む要素です。
<shortcut>
ユーザーがこのショートカットを利用可能である場合、ショートカットはキーの順番、実施するためのコマンド、命令をするロールを表します。
key
このショートカットに対し、キーの順番を指定します。この属性は任意です。
onCommand
このメニュー項目に対し実施するイベントハンドラを指定します。この属性は任意です。
role
ユーザーがショートカットを利用できるかどうか命令するロールを指定します。この属性は任意です。
ホームページ
ホームページとして使用されるページを設定します。
設定
<homepageConfig> <homepage pageId="homepage" role=""/> </homepageConfig>
<homepageConfig>
ホームページとして使用されるページを設定します。
<homepage>
プリロードのためにファイルは設定可能です。プリロードされたファイルの数はキャッシュのサイズと合致している必要はありません。キャッシュのサイズがプリロードの数より多い場合は、開いたその他ファイルはそのスロットを占めることができます。
pageId
ホームページとして使用するためのページ名を指定します。この属性は任意です。
role
このホームページにアサインされているロールを指定します。セキュリティが有効になっている場合、またユーザーのロールがこのホームページ定義にアサインされているロールと合致している場合、このページはホームページとして使われます。
キャッシュ / xalCache
キャッシュ機能が reference framework に追加されました。
注: Reference Framework のキャッシュを使用するには version 4.5.40 またはそれ以上が必要です。
設定
Reference Framework 設定ファイル nexaweb-reference-framework.xml 内に以下のようにキャッシュを設定します。
<xalCache cacheSize="5"> <cacheSlot path="/XAL/include/IncludeTest.xal" keepInCache=”true”/> <cacheSlot path="/XAL/include/Frag1.xal"/> </xalCache>
<xalCache>
xalCache タグはキャッシュの設定に必要です。タグが設定ファイルに存在していない場合、キャッシュは設定されません。
cacheSize
xalCache タグの cacheSize 属性は、ファイルのキャッシュに利用可能なスロットの最大数を表します。属性が含まれていない場合、キャッシュのデフォルトサイズは 10 です。
キャッシュされるファイルの数がキャッシュのサイズを超える場合、少なくとも、使用頻度の少ないファイルがキャッシュから削除されます。
<cacheSlot>
ファイルは事前ロードのために設定することができます。事前ロードされたファイルの数はキャッシュのサイズに合致している必要はありません。キャッシュのサイズが事前ロード の数より大きい場合、その他の開いたファイルがスロットを占領します。
cacheSlot タグの設定は任意です。ファイルが事前ロードされる必要がない場合、省略されます。
keepInCache
キャッシュされたファイル数がキャッシュサイズを超えた場合、cacheSlot タグの KeepInCache 属性はキャッシュから削除されたファイルを保存することができます。この属性を true に設定をすると、キャッシュから削除されたキャッシュスロットのファイルを保存します。属性が設定されない場合、値が false に設定され、このキャッシュスロットのファイルはキャッシュから削除されます。
NOTE:
keepInCache の キャッシュスロットの数がキャッシュのサイズに合致または超える場合、新しいキャッシュスロットは作成されません。Keep alive付きの事前ロードキャッシュスロットの数がキャッシュのサイズを超える場合、作成されない、キャッシュスロットと関連しているファイルは事前ロードされません。
データサービス (エンコード)
設定
Reference Framework 設定ファイル nexaweb-reference-framework.xm lの一部としてキャッシュは設定されます。
<dataService> <encoding>xml</encoding> <encodeRequest>false</encodeRequest> <encodeResponse>true</encodeResponse> </dataService>
<dataService>
dataService タグによって、クライアントからサーバー Reference Framework のClientDataService へのデータのパス方法、またどのようにデータがサーバーからクライアントに戻ってくるかを設定することができます。
dataService タグは任意です。タグが設定されていない場合、データはエンコーディングなしでサーバーから、またサーバーへデータがパスされます。
<encoding>
encoding タグは、Client Data Serviceを使用している時、リクエストデータ(クライアントからサーバー)と返却オブジェクト (サーバーからクライアント) に使われているエンコーディングの種類を表示します。
有効なEncoding type
object - (または identity) エンコーディング が使用されていないことを意味します
gzip - gzip を使用しデータが圧縮されます
xml - データはXMLとしてパスされます
encoding タグは任意です。デフォルト値は object です。
<encodeRequest>
encodeRequest タグはリクエストデータをエンコードするかどうかを設定する方法を提供します。これは任意のタグです。デフォルト値は true です。
<encodeResponse>
encodeResponse タグは、サーバーから返されるオブジェクトをエンコードするかどうかを設定する方法を提供します。デフォルト値は true です。
メニューグループ
設定
<menuGroups> <menuGroup name="application" text=""> <item image="/images/menu_logout.png" name="logoutMenu" onCommand="SecurityManager.logout()" text="Log Out" tooltip="log out"/> </menuGroup> </menuGroups>
<menuGroups>
アプリケーションメニューバーを設定します。メインメニューまたは子メニューはアクションをバンドルします。
<menuGroup>
ユーザーがショートカットを利用できない場合は、決定を行うキーシークエンス、コマンドを示します。
<item>
メニューリストにあるメニュー項目です。
image
メニュー項目で表示されている画像のソースを指定します。この属性は任意です。
name
メニュー項目を認識するために使用されている名前を指定する。この属性は任意です。
onCommand
このメニュー項目に対しイベントハンドラを指定し実行します。この属性は任意です。
roleEnabled
この項目が有効化どうか命令するロールを指定します。この属性は任意です。
roleVisible
ユーザーがこの項目を見ることができるかどうかを命令する決定するロールを指定します。この属性は任意です。
text
メニュー項目で表示されているテキストを指定します。この属性は任意です。
tooltip
メニュー項目のツールチップで表示されているテキストを指定します。この属性は任意です。
コマンドバー
設定
<commandbar> <button image="/images/bar_cancel.png" name="commandBar.bbClose" onCommand="PageManager.closePage()" tooltip="Close"/> <button image="/images/menu_refresh.png" name="commandBar.bbRefresh" role="ROLE_USER" tooltip="Refresh"/> <button image="/images/bar_print.png" name="commandBar.bbPrint" tooltip="Print"/> </commandbar>
<commandbar>
アプリケーションツールバーを設定します。各コマンドボタンは以前定義されたアクションをバンドルすることができます。
<button>
コマンドバーのボタン項目です。
image
このボタンのために表示されるイメージのソースを指定します。この属性は任意です。
name
ボタンを認識するために使用される名前を指定します。この属性は任意です。
onCommand
イベントハンドラを指定し、このボタンに対し実行します。この属性は任意です。
roleEnabled
この項目が有効かどうか、命令するロールを指定します。この属性は任意です。
roleVisible
ユーザーが、この項目を見ることができるかどうか、命令するロールを指定します。この属性は任意です。
tooltip
ボタンのツールチップで表示されているテキストを指定します。この属性は任意です。
ステータスバー
設定
<statusPanels> <statusPanel horizontalAlignment="left" image="" name="statusBar.bar1" text="Hello, everybody!" width="80%"/> <statusPanel image="" name="statusBar.bar2" text="Ready" width="19%"/> </statusPanels>
<statusPanels>
ホームページのステータスバーを設定します。
<statusPanel>
アプリケーションのステータス情報を表示するパネルです。
image
ステータスパネルに表示されるイメージのソースを指定します。この属性は任意です。
name
ステータスパネルを指定するために使用される名前を指定します。この属性は任意です。
horizontalAlignment
ステータスパネルでテキストを表示するために使用されるアライメントを指定します。この属性は任意です。
width
単位はピクセルで、ステータスパネルの幅。アクティブなレイアウトマネージャで管理されるコンポーネントは、この値を設定すると、その幅が優先される。
イベント
設定
<appEvents> <onAppInit>mco:sampleMco.onAppInit()</onAppInit> <onAppStartup>mco:sampleMco.onAppStartup()</onAppStartup> </appEvents>
<onAppInit>
onAppInit 要素はonAppInit イベントのハンドラを含む要素です。これは有効な mco 構文を含まないといけない任意要素になります。
onAppInit イベントは、設定ファイルが読まれた後、またアプリケーション UI は構築される前に発火します。これは、表示される前にアプリケーションの設定の修正する手段を提供します。
<onAppStartup>
onAppStartup 要素はonAppstartup イベントのハンドラを含めます。これは任意要素で有効な mco 文を含まなくてはなりません。
onAppStartup イベントは、アプリケーション UI が構築され、ホームページがロードされた後、発火されます。セキュリティが有効な場合、このイベントはユーザーがログインに成功し、onLoginSucceeded イベントが発火された後、このイベントは発火されます。これにより、アプリケーション開始後国際化をする手段を提供します。