Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

This document provides the configuration details for all pages except the home page.

Requirements

Reference Framework 2.0 runs against 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

 

Shortcut Keys

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

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

 

Menus

Configuration

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

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

 

Commandbar

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

Specifies the name used to identify the button.

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.

 

StatusBar

Configuration

 

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

 

SideBar

Configuration

<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

Specifies width of the side panel. This attribute is optional.

  • No labels