This document provides the details of the configuration elements.このドキュメントでは、以下の設定要素の詳細を提供しています。
Requirements要件
Reference Framework 2.0 runs against は Nexaweb Platform 4.5.33 or higher.以上で稼働します。
Globals
An element containing the list of components (e.g. MCOs, Macros, datasources or any element from any namespace) to be loaded for global use.
Configurationアプリケーション全体で使用するコンポーネントのリストを含む要素 (例：MCO、 マクロ、 データソースまたは全ての名前空間からの全ての要素)
設定
| Code Block |
|---|
<globals>
<mco/>
<macro/>
</globals> |
...
Contains the list of shortcut key definitions to be loaded for use within the application.
Configurationショートカットキー
アプリケーション内で使用するショートカットキー定義の一覧を含みます。
設定
| Code Block |
|---|
<shortcutKeys>
<shortcut key="F5" o
nCommand="PageManager.loadPage( 'dataIntegration' )" role="ROLE_ADMIN"/>
</shortcutKeys> |
<shortcutKeys>
An element containing the list of shortcut key definitions to be loaded for use within the application.
<shortcut>
A shortcut represents key sequence, command to execute and role/roles that dictate if this shortcut is available to the user.
key
Specifies the key sequence for this shortcut. This attribute is optional.
onCommand
Specifies the event handler to execute for the this menu item. This attribute is optional.
role
Specifies the role or roles that dictate if this shortcut is available to the user. This attribute is optional.
...
Configure the page to be used as the home page.
Configurationアプリケーション内で使用されるためロードされるショートカットキー定義の一覧を含む要素です。
<shortcut>
ユーザーがこのショートカットを利用可能である場合、ショートカットはキーの順番、実施するためのコマンド、命令をするロールを表します。
key
このショートカットに対し、キーの順番を指定します。この属性は任意です。
onCommand
このメニュー項目に対し実施するイベントハンドラを指定します。この属性は任意です。
role
ユーザーがショートカットを利用できるかどうか命令するロールを指定します。この属性は任意です。
ホームページ
ホームページとして使用されるページを設定します。
設定
| Code Block |
|---|
<homepageConfig>
<homepage pageId="homepage" role=""/>
</homepageConfig> |
<homepageConfig>
Configure the page to be used as the home page.
<homepage>
Files can be configured for preload. The number of preloaded files does not have to match the size of the cache. If the size of the cache is greater than the number of preloads, then other files opened can occupby the slots.
pageId
Specifies the name of the page to use as the homepage. This attribute is optional.
role
Specifies Specifies the role or roles assigned to this homepage. This page will be used as the homepage if security is enabled and the user's roles match the roles assgined to this homepage definition. This attribute is optional, when omitted, all roles can access the page.
Cache/xalCacheCaching has been added to the reference framework.
NOTE : Use of the cache in Reference Framework requires ホームページとして使用されるページを設定します。
<homepage>
プリロードのためにファイルは設定可能です。プリロードされたファイルの数はキャッシュのサイズと合致している必要はありません。キャッシュのサイズがプリロードの数より多い場合は、開いたその他ファイルはそのスロットを占めることができます。
pageId
ホームページとして使用するためのページ名を指定します。この属性は任意です。
role
このホームページにアサインされているロールを指定します。セキュリティが有効になっている場合、またユーザーのロールがこのホームページ定義にアサインされているロールと合致している場合、このページはホームページとして使われます。
キャッシュ / xalCache
キャッシュ機能が reference framework に追加されました。
注: Reference Framework のキャッシュを使用するには version 4.5.40 or higher.またはそれ以上が必要です。
Configuration
The cache is configured as part of the Reference Frameowrk configuration file 設定
Reference Framework 設定ファイル nexaweb-reference-framework.xml . 内に以下のようにキャッシュを設定します。
| Code Block |
|---|
<xalCache cacheSize="5"> <cacheSlot path="/XAL/include/IncludeTest.xal" keepInCache="true"”true”/> <cacheSlot path="/XAL/include/Frag1.xal"/> </xalCache> |
<xalCache>
The xalCache tag is required for configuring the cache. If the tag does not exist in the configuration file, then the cache will not be configured.xalCache タグはキャッシュの設定に必要です。タグが設定ファイルに存在していない場合、キャッシュは設定されません。
cacheSize
The cacheSize attribute of the xalCache tag, signifies the maximum number of slots available for caching files. If the attribute is not include, then the default size
of the cache will be 10.
If the number of files to be cached exceeds the size of the cache, then least recently used file will be rmoved from the cache.
<cacheSlot>
Files can be configured for preload. The number of preloaded files does not have to match the size of the cache. If the size of the cache is greater than
the number of preloads, then other files opened can occupby the slots.
The cacheSlot tag is optional. If not files need to be preloaded, then they can be omitted.
keepInCache
The KeepInCache attribute of the cacheSlot tag can keep a file from being removed from cache, when the number of files being cached exceed the cache size.
Setting this attribute to true, will keep the file in this cache slot from being removed from the cache. If the attribute is not set, the value is set to false,
and the file in this cache slot can be removed from cache.
NOTE:
If the numbe of cache slots with keepInCache, matches or exceeds the size of the cache, then no new cache slots can be created. If the number of preload cache slots
with keep alive, exceed the size of the cache, then the files associated with the cache slots that do not get created will not be preloaded.
...
Configuration
The cache is configured as part of the Reference Frameowrk configuration file nexaweb-reference-framework.xml. xalCache タグの cacheSize 属性は、ファイルのキャッシュに利用可能なスロットの最大数を表します。属性が含まれていない場合、キャッシュのデフォルトサイズは 10 です。
キャッシュされるファイルの数がキャッシュのサイズを超える場合、少なくとも、使用頻度の少ないファイルがキャッシュから削除されます。
<cacheSlot>
ファイルは事前ロードのために設定することができます。事前ロードされたファイルの数はキャッシュのサイズに合致している必要はありません。キャッシュのサイズが事前ロード の数より大きい場合、その他の開いたファイルがスロットを占領します。
cacheSlot タグの設定は任意です。ファイルが事前ロードされる必要がない場合、省略されます。
keepInCache
キャッシュされたファイル数がキャッシュサイズを超えた場合、cacheSlot タグの KeepInCache 属性はキャッシュから削除されたファイルを保存することができます。この属性を true に設定をすると、キャッシュから削除されたキャッシュスロットのファイルを保存します。属性が設定されない場合、値が false に設定され、このキャッシュスロットのファイルはキャッシュから削除されます。
NOTE:
keepInCache の キャッシュスロットの数がキャッシュのサイズに合致または超える場合、新しいキャッシュスロットは作成されません。Keep alive付きの事前ロードキャッシュスロットの数がキャッシュのサイズを超える場合、作成されない、キャッシュスロットと関連しているファイルは事前ロードされません。
データサービス (エンコード)
設定
Reference Framework 設定ファイル nexaweb-reference-framework.xm lの一部としてキャッシュは設定されます。
| Code Block |
|---|
<dataService>
<encoding>xml</encoding>
<encodeRequest>false</encodeRequest>
<encodeResponse>true</encodeResponse>
</dataService> |
...
<dataService>
The dataService tag allows for configuration of how data is passed from the client to the server Reference Framework’s ClientDataService, as well as how the data is returned to the client from the server.
The dataService tag is optional.If the tag is not configured, then data will be passed to and from the server, without any encoding.
<encoding>
The encoding tag indicates the type of encoding that is used the request data (client to server) and response object (server to client), when using the Client Data Service.
Valid Encoding types
object - (or identity) means that no encoding is used
gzip - the data will be compressed using gzip
xml - the data will be passed as XML
The encoding tag is optional. The default value is object.
<encodeRequest>
The encodeRequest tag provides a way to configure whether or not to encode the request data. This is an optional tag. The default value is true.
<encodeResponse>
The encodeResponse tag provides a way to configure whether or not to encode the response object being returned from the server. This is an optional tag. The default value is true.
MenuGroups ConfigurationdataService タグによって、クライアントからサーバー 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 です。
メニューグループ
設定
| Code Block |
|---|
<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>
Configures the application menubar. Either a main menu or a child menu can bundle an action.アプリケーションメニューバーを設定します。メインメニューまたは子メニューはアクションをバンドルします。
<menuGroup>
A shortcut represents key sequence, command to execute and role/roles that dictate if this shortcut is available to the user.ユーザーがショートカットを利用できない場合は、決定を行うキーシークエンス、コマンドを示します。
<item>
A menu item in the menu list.メニューリストにあるメニュー項目です。
image
...
メニュー項目で表示されている画像のソースを指定します。この属性は任意です。
name
...
メニュー項目を認識するために使用されている名前を指定する。この属性は任意です。
onCommand
Specifies the event handler to execute for the this menu item. This attribute is optional.
roleEnabled
Specifies the role or roles that dictate if this item is enabled. This attribute is optional. See more at
roleVisible
Specifies the role or roles that dictate if this item is visible to the user. This attribute is optional. See more at
text
Specifies the text to be displayed in the menu item. This attribute is optional.
tooltip
Specifies the text to be displayed in the tooltip for the menu item. This attribute is optional.
...
Configuration
...
このメニュー項目に対しイベントハンドラを指定し実行します。この属性は任意です。
roleEnabled
この項目が有効化どうか命令するロールを指定します。この属性は任意です。
roleVisible
ユーザーがこの項目を見ることができるかどうかを命令する決定するロールを指定します。この属性は任意です。
text
メニュー項目で表示されているテキストを指定します。この属性は任意です。
tooltip
メニュー項目のツールチップで表示されているテキストを指定します。この属性は任意です。
コマンドバー
設定
| Code Block |
|---|
<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>
Configures the application toolbar. each command button can bundle an action which is previously defined.アプリケーションツールバーを設定します。各コマンドボタンは以前定義されたアクションをバンドルすることができます。
<button>
A button item in the command bar.コマンドバーのボタン項目です。
image
...
このボタンのために表示されるイメージのソースを指定します。この属性は任意です。
name
...
ボタンを認識するために使用される名前を指定します。この属性は任意です。
onCommand
Specifies the event handler to execute for the this button. This attribute is optional.
roleEnabled
Specifies the role or roles that dictate if this item is enabled. This attribute is optional. See more at
roleVisible
Specifies the role or roles that dictate if this item is visible to the user. This attribute is optional. See more at
tooltip
Specifies the text to be displayed in the tooltip for the button. This attribute is optional.
StatusbarConfigurationイベントハンドラを指定し、このボタンに対し実行します。この属性は任意です。
roleEnabled
この項目が有効かどうか、命令するロールを指定します。この属性は任意です。
roleVisible
ユーザーが、この項目を見ることができるかどうか、命令するロールを指定します。この属性は任意です。
tooltip
ボタンのツールチップで表示されているテキストを指定します。この属性は任意です。
ステータスバー
設定
| Code Block |
|---|
<statusPanels>
<statusPanel horizontalAlignment="left" image=""
name="statusBar.bar1" text="Hello, everybody!" width="80%"/>
<statusPanel image="" name="statusBar.bar2" text="Ready" width="19%"/>
</statusPanels> |
<statusPanels>
Configure the status bar on the home page.ホームページのステータスバーを設定します。
<statusPanel>
The panel(s) display the status info of the applicationアプリケーションのステータス情報を表示するパネルです。
image
...
ステータスパネルに表示されるイメージのソースを指定します。この属性は任意です。
name
...
ステータスパネルを指定するために使用される名前を指定します。この属性は任意です。
horizontalAlignment
Specifies the alignment to be used to display the text within the status panel. This attribute is optional.
width
The width of the status panel in pixels. For components managed by an active layout manager, setting this value will act as the preferred width.
...
EventsConfigurationステータスパネルでテキストを表示するために使用されるアライメントを指定します。この属性は任意です。
width
単位はピクセルで、ステータスパネルの幅。アクティブなレイアウトマネージャで管理されるコンポーネントは、この値を設定すると、その幅が優先される。
イベント
設定
| Code Block |
|---|
<appEvents> <onAppInit>mco:sampleMco.onAppInit()</onAppInit> <onAppStartup>mco:sampleMco.onAppStartup()</onAppStartup> </appEvents> |
<onAppInit>
The onAppInit element contains the handler for the onAppInit event. This is an optional element that must contain valid mco syntax.
The onAppInit event is fired after the configuration file has been read, but before the application UI is built. This provides a means for modifying the configuration of the application before it is rendered.
<onAppStartup>
The onAppStartup element contains the handler for the onAppStartup event. This is an optional element that must contain valid mco syntax.
The onAppStartup event is fired after the application UI has been built and after the home page has been loaded. If security is enabled, this event is fired after the user has been successfully logged in, and after the onLoginSucceeded event has fired. This provides a means for doing global initializations after the application has startedonAppInit 要素はonAppInit イベントのハンドラを含む要素です。これは有効な mco 構文を含まないといけない任意要素になります。
onAppInit イベントは、設定ファイルが読まれた後、またアプリケーション UI は構築される前に発火します。これは、表示される前にアプリケーションの設定の修正する手段を提供します。
<onAppStartup>
onAppStartup 要素はonAppstartup イベントのハンドラを含めます。これは任意要素で有効な mco 文を含まなくてはなりません。
onAppStartup イベントは、アプリケーション UI が構築され、ホームページがロードされた後、発火されます。セキュリティが有効な場合、このイベントはユーザーがログインに成功し、onLoginSucceeded イベントが発火された後、このイベントは発火されます。これにより、アプリケーション開始後国際化をする手段を提供します。