Application

A classic presentation layer application. (deprecated)

Properties

caption : CaptionType

String indentifier. The caption is displayed in the Titlebar of the application.

Valid values based on“string”.
80 (maxLength)	Caption can be a maximum of 80 characters long.

contextImplementation : string

Refers to either a Java class, or JavaScript class which implements a context bus adapter

Please note that this has been deprecated in preference of the new ContextAdapter element.

The NexJ client framework can support sharing of context between a NexJ client and a third-party application via the context bus adapter infrastructure.

Configuring a Context Adapter

To communicate context information between the NexJ client and a third-party application, a context adapter must be specified in the Application configuration by populating the 'contextImplementation' property. The value should be the complete name (including package name) of the class and be void of any client framework specific information. The client framework will automatically add the appropriate framework prefix to ensure the correct context adapter is instantiated.

Example: <Application caption="SysPortletServer" contextImplementation="nexj.customer.controller.CustomerContextAdapter"...

The client framework will be looking for the following classes when trying to instantiate the context adapter in the various frameworks:

Java - nexj.customer.controller.SWTCustomerContextAdapter Flat Web - nexj.customer.controller.FlatWebCustomerContextAdapter and FlatWebCustomerContextAdapter.js Rich Web - RichWebCustomerContextAdapter.js

Configuring controls for Context Integration Currently the Label control and columns of a Grid Control support context integration. Both these controls allow a developer to specify context information that should be made available to a third-party application when a user performs an operation with the value.

Context integration is configured using the following properties: context - String constant specifying context value that should be set. contextValue - The attribute, association path, or a constant specifying the value to set. collectionContextValue - The attribute, association path, or a constant specifying the value to set from a collection.

The 'collectionContextValue' property should be used when the Label or Grid column is based on a list of records (ie. 'collection' property is specified).

controller : string

Deprecated property. Do not use.

customDialogMode : boolean

Sets the type of popup that will be used across the application. When false native pop ups are used.

dashboards : identifierList

Space-delimited list of screens representing default dashboard pages.

The default mobile dashboard screen page should have the following portlet reference names: portletNW, portletNE, portletSW, portletSW. The portlet names from the above portlet references will be used to populate default system dashboards.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*\s+)*(:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*)?	Each element in the list must begin with a letter or underscore. Elements are space delimited.

defaultLocale : string

The default locale for the application. Must be a two letter abbreviation.

Example

en, fr, de for English, French, and Dutch respectively

description : string

Description of the application.

enableClientState : boolean

Enables the client framework to save client state at application shutdown.

flatMobile : boolean

Sets whether or not a wrapper needs to be build for flat mobile platform.

icon : string

Icon for the application. Will appear in the upper left of the application and on desktop links.

Various sizes of icons are organized into folders by size (8, 16, 22, 24, 32, 48). Icons should be added in PNG format. They are typically referred to as <folderName>/<iconName> without the PNG extension.

Example

16/document_pulse

icons : string

A semi-colon delimited list of icon ids that should be prefetched.

Specifies a list of icons which client frameworks should attempt to prefetch and cache locally in order to improve run-time performance. Should be used for icons which will likely be heavily used throughout the application.

menu : identifier

The Application's main menu. Must refer to an existing Menu in the Application's collection of Menus.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

mobilebuildproperties : string

Path to build configuration for Wrapper

navigatorStyle : string

Style for the Navigator component.

navigatorTextAlign : Alignment

Horizontal alignment of the Screen caption text within the Navigator component.

Example

"left", "right", "center"

Valid values based on“string”.
right
center
left

portalApplication : string

Sets the name of the portal application that the portal container will only load.

portlet : boolean

Deprecated. Please mark individual screens as portlets instead.

privilege : string

The privilege required to load the Application.

screenMenuIndex : int

Sets position in the application menu where the Screen menu will be inserted at run-time. Zero based.

splashScreen : string

Sets the image used in the splash screen.

startScreen : string

Sets the screenRef name that the application should load on start. This takes precedence over client state.

strictMode : boolean

Enables the client framework to have more control over the style and the layout of controls.

style : string

Style for the application background.

stylesheet : identifier

Stylesheet sets the overall appearance of the application and its screens, forms ...

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

template : string

Alternate application template for a flat web application. Template name must be preceeded by the template folder name.

The templates are stored in the meta/templates folder. They are basically HTML with replacable parameters. Special replaceable script items include: ${application} - application name ${style} - style sheet ${script} - applications script ${root}/images/WTIS_header.png - example of a replacable resource from the meta/Web folder ${=(string-append (((user)'person)'firstName) " " (((user)'person)'lastName))} - example of embedded script ${screen} - the full contents of the current screen from the application

Example

templates/MyAppTemplate.html

toolbar : identifier

The Application's main toolbar. Must refer to an existing Menu in the Application's collection of Menus.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

Content

• Sequence of:

  • Sequence of:

    • Menus [0..1] - The set of menu items in an application.

    • Script [0..1] - The script which is run on startup of the application.

    • DataActions [0..1] - The collection of data actions defined for the application.

    • UIActions [0..1] - The set of ui actions defined for the application.

    • ExceptionActions [0..1] - The set of exception actions defined for the application.

    • StatusBar [0..1] - The application status bar.

    • Notifications [0..1] - The set of notifications defined for the application.

    • Choice of:

      • TableLayout [0..1]

      • SplitterLayout [0..1]

      • GroupLayout [0..1]

      • ScreenRefs [0..1] - The set of screens defined for the application.

    • BrokerPortletRef [0..1] - A reference to the application broker portlet. There is at most one, and it will be the first portlet to load.

    • ServicePortletRef [0..*] - A reference to an application service portlet. Multiple service portlets may exist, and are intended to handle client-side behaviour within the portal container. For example, portal event or portal notification handling.

    • MasterModels [0..1] - The set of master models defined for the application.

    • ContextAdapter [0..*]