Page Comparison

This document provides the configuration details for all pages except the home page.ここでは、ホームページ以外の全てのページの設定についての詳細を提供しています。

• Attributes
• Shortcut Keys
• Menus
• Commandbar
• StatusBar
• SideBar

...

要件

Reference Framework 2.0 runs against Nexaweb はNexaweb Platform 4.5.33 or higher. またはそれ以上で稼働します。

<page>

A page element contains the definition used to create pages, subPages or dialogs.  Each page can define its own menus, commandbar, shortkeys or status bars.

Attributes

name

Specifies the identifier used to look up the page definition. This attribute is required.

title

Specifies the title associated with the page. This attribute is optional.

xal

Specifies the name of the XAL file to be loaded by the page. This attribute is optional.

onPageLoaded

Specifies the handler for the onPageLoaded event.  
This attribute is optional and must contain valid Mco syntax.
The onPageLoaded event is fired when the page is first crated.   See the Page Events topic for more information on the onPageLoaded event.

onPageActivated

Specifies the handler for the onPageActivated event.  
This attribute is optional and must contain valid Mco syntax.
The onPageActivated  event is fired when the page is first crated.   See the Page Events for more information on the onPageActivated event.

onPageDeactivated

Specifies the handler for the onPageDeactivated event.  
This attribute is optional and must contain valid Mco syntax.
The onPageDeactivate event is fired when the page is first crated.   See the Page Events topic for more information on the onPageDeactivated event.

onPageClosed

Specifies the handler for the onPageClosed event.  
This attribute is optional and must contain valid Mco syntax.
The onPageClosed event is fired when the page is first crated.   See the Page Events topic for more information on the onPageClosed event

...

Contains the list of shortcut key definitions to be loaded for use within the page. The shortcut keys are only available when the page is active.

Configuration

...

ページ要素はページ、サブページ、ダイアログを作成するために使用される定義を含みます。各ページはその固有のメニュー、コマンドバー、ショートカットキーまたはステータスバーを定義することが可能です。

属性

name

ページ定義を検索するために使用される識別子を指定します。この属性は必須です。

title

ページに関連したタイトルを指定します。この属性は任意です。

xal

ページによってロードされる XAL ファイル名を指定する。この属性は任意です。

onPageLoaded

onPageLoaded イベントに対するハンドラを指定する。この属性は任意で有効な MCO 構文を含んでいなければなりません。 onPageLoaded イベントはページが最初にロードされた際に発生します。onPageLoaded イベントに関する詳細な情報はページイベントをご確認下さい。

onPageActivated

onPageActivate イベントのハンドラを指定します。この属性は任意で、有効な MCO 構文を含んでいなければなりません。onPageActivated イベントは、ページが最初に密封された時発火されます。onPageActivated イベントに関する詳細な情報は、ページイベントをご覧ください。

onPageDeactivated

onPageDeactivated イベントに対するハンドラを指定します。この属性は任意で有効な MCO 構文を含んでいなくてはなりません。onPageDeactivate イベントは、ページが最初に封印された時発火されます。onPageDeactivated イベントに関する詳細な情報は ページイベント をご覧下さい。

onPageClosed

onPageClosed イベントのハンドラを指定します。この属性は任意で有効な MCO 構文を含んでいなくてはいけません。onPageClosed イベントはページが最初封印された時、発火されます。 onPageClosed　イベントに関する詳細な情報は ページイベントをご覧ください

ショートカットキー

ページ内での使用のためにロードされるショートカットキー定義の一覧を含みます。ショートカットキーはページがアクティブな場合にのみ、利用可能です。 

設定

<shortcutKeys>
<shortcut key="F5" onCommand="PageManager.loadPage( 'dataIntegration' )"
 role="ROLE_ADMIN"/>
   </shortcutKeys>

...

<shortcutKeys>

An element containing the list of shortcut key definitions to be loaded for use within the page.ページ内での使用のためにロードされるショートカットキー定義の一覧を含む要素です。

<shortcut>

A shortcut represents key sequence, command to execute and role/roles that dictate if this shortcut is available to the user.

Attributes

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.

pageId

Specifies the role or roles that dictate if this shortcut is available to the user. This attribute is optional.

...

Configuration

...

shortcut は、実行するためのコマンドとユーザーがこのショートカットを利用可能かどうかを命令するロールを表しています。 

属性

key

このショートカットに対するキーを指定します。この属性は任意です。

onCommand

このメニュー項目に対して実行するイベントハンドラを指定します。この属性は任意です。

pageId

ユーザーがこのショートカットを利用可能なよう、命令するロールを指定します。この属性は任意です。

メニュー

設定

<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>

The menuGroups element contains a list of menuGroups to be associated with the defined page.menuGroups 要素は、定義されたページに関連したメニューグループの一覧を含んでいます。 

<menuGroup>

The menuGroup element specifies a group of menu items associated with the page.
Each menuGroup will be added to the menu when the page is active.

Attributes

name

Specifies the name used to identify the menu group.

test

Specifies the text to be displayed for the menu group. This attribute is optional.

image

Specifies the source of an image to be displayed in the menu group. This attribute is optional.

tooltip

Specifies  the text to be displayed in the tooltip for the menu group. This attribute is optional.

roleEnabled

Specifies the role or roles that dictate if this item is enabled. This attribute is optional.
See the Role Based Configurationtopic for more information. 

roleVisible

Specifies the role or roles that dictate if this item is visible to the user.
See the Role Based Configuration topic for more informationl.

<item>

The item element specifies a menu item displayed as part of the menu group.

Attributes

name

Specifies the name used to identify the menu item.

text

Specifies the text to be displayed in the menu item. This attribute is optional.

onCommand

Specifies the event handler to execute for the this menu item. This attribute is optional.

image

Specifies the source of an image 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.

roleEnabled

Specifies the role or roles that dictate if this item is enabled. This attribute is optional.
See the Role Based Configuration topic for more information. 

roleVisible

Specifies the role or roles that dictate if this item is visible to the user. This attribute is optional.
See the Role Based Configuration topic for more information.

...

Configuration

...

menuGroup 要素は、ページに関連しているメニュー項目のグループを指定します。各メニューグループはページがアクティブの際、メニューに追加されます。

属性

name

メニューグループを特定するために使用される名前を指定します。

test

メニューグループに対し表示されるテキストを指定します。この属性は任意です。

image

メニューグループで表示されるイメージのソースを指定します。この属性は任意です。

tooltip

メニューグループのツールチップに表示されるテキストを指定します。この属性は任意です。

roleEnabled

この項目を利用可能なロールを指定します。詳細に関しては Role Based Configuration をご覧ください。

roleVisible

この項目を表示をするロールを指定します。 詳細に関しては Role Based Configuration をご覧ください。

<item>

この項目要素は、メニューグループの一部として表示されているメニュー項目を特定します。 

属性

name

メニュー項目を特定するために使われる名前を指定します。

text

メニュー項目で表示されるテキストを指定します。この属性は任意です。

onCommand

このメニュー項目を実行するイベントハンドラを指定します。この属性は任意です。

image

メニュー項目に表示されるイメージのソースを指定します。この属性は任意です。

tooltip

メニュー項目のツールチップに表示されるテキストを指定します。この属性は任意です。

roleEnabled

この項目を利用可能なロールを指定します。詳細に関しては Role Based Configuration をご覧ください。

roleVisible

この項目を表示をするロールを指定します。 詳細に関しては Role Based Configuration をご覧ください。

コマンドバー

設定

<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>

The commandbar element contains the list of elements associated with page.  The elements are added to the application command bar when the page is activated.
While the button is the most commonly used element within the commad bar, any UI element can be used (e.g. comboBox, textField, etc).

<button>

The button element contains the definition of a button to be added to the command bar.   The button is the mostly commonly used UI element in the command bar.

Attributes

name

...

image

Specifies the source of an image to be displayed for this button. This attribute is optional.

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 the Role Based Configuration topic for more information.

roleVisible

Specifies the role or roles that dictate if this item is visible to the user. This attribute is optional. See the Role Based Configuration topic for more information.

tooltip

Specifies  the text to be displayed in the tooltip for the button. This attribute is optional.

...

Configuration

...

commandbar 要素はページと関連している要素リストを含んでいます。要素は、ページが有効になった際、アプリケーションコマンドバーに追加されます。
ボタンがコマンドバー内では最も良く使用される一方で、どの UI 要素でも使用可能です。(例 : コンボボックス、テキストフィールドなど).

<button>

Button 要素はコマンドバーに追加されるボタンの定義を含む要素です。ボタンは最も良くコマンドバーで使用される UI 要素です。

属性

name

ボタンを特定するために使用される名前を指定します。

image

このボタンに対し表示されるイメージのソースを指定します。属性は任意です。

onCommand

このボタンに対し実行するイベントハンドラを指定します。この属性は任意です。

roleEnabled

この項目を利用可能なロールを指定します。この属性は任意です。詳細に関しては Role Based Configurationをご覧ください。

roleVisible

この項目を表示をするロールを指定します。この属性は任意です。詳細に関しては Role Based Configurationをご覧ください。

tooltip

ボタンの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>

The statucPanels element contains the list of statusPanels associated with this page.  The page status panels will be added
to the application status panel when the page is activated.

<statusPanel>

The panel(s) display the status info of the application.

Attributes

name

Specifies the name used to identify status panel. This attribute is optional.

image

Specifies the source of an image to be displayed for status panel. This attribute is optional.

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.

...

ConfigurationstatusPanels 要素はこのページに関連した ステータスパネルの一覧を含みます。 ステータスパネルは、ページが有効な際、アプリケーション ステータスパネルに追加されます。

<statusPanel>

パネルにアプリケーションのステータス情報を表示します。

属性

name

ステータスパネルを識別するために使用される名前を指定します。この属性は任意です。

image

ステータスパネルに対し表示されている画像のソースを指定します。この属性は任意です。

horizontalAlignment

ステータスペイン内でテキストを表示するために使用されるアライメントを指定します。この属性は任意です。

width

ステータスパネルの幅を pixel で示します。有効なレイアウトマネージャによって管理されているコンポーネントに対し、この値を設定することにより優先幅として振る舞います。

サイドバー

設定

<page name="excelSample" title="Excel Sample" xal="/XAL/Sample/ExcelSample.xal"/>
     <sideBar position="west" width="19%"
xal="/XAL/Sample/DataIntegration_SidePage.xal"/>
</page>

<sideBar>

The sideBar element contains the definition related to using a xal page as a side bar.  The xal specified as
the sideBar will be displayed relative to the its containing page as specified by its position attribute.

Attributes

xal

The name of the xal file to load as the side bar to the page. This attribute is required.

position

Specifies the position to place the side bar. This attribute is optional.

width

...

sideBar 要素は xal ページをサイドバーとして使用することに関する定義を含みます。サイドバーとして指定される xal は、その位置属性によって指定される、それが含まれているページに対し、サイドバーが表示されます。

属性

xal

ページのサイドバーとしてロードされるxal ファイルの名前。この属性は必須です。

position

サイドバーを配置するための位置を指定します。この属性は任意です。

width

サイドパネルの幅を指定します。この属性は任意です。