Elements

element <Application>
Namespace:
http://schema.caplin.com/CaplinTrader/webcentric
XML Representation Summary
<Application
   
auto_save
 = 
 xs:boolean : "true"
auto_size
 = 
 xs:boolean : "true"
drag_container
 = 
 xs:string
layout
 = 
 xs:string
maximize_target
 = 
 xs:string : "GUI"
panel_name_max_length
 = 
 xs:integer : "30"
panel_rename
 = 
 xs:boolean : "false"
theme
 = 
 xs:string
theme_path
 = 
 xs:string
language
 = 
 xs:string
preload
 = 
 xs:boolean : "false"
    >
   
Content: 
Declarations?, GUI?
</Application>
Child elements (2):
Description
This is the root element of the Webcentric application document. As well as acting as the container for all other markup elements, the Application element carries attributes which help define the behaviour and presentation of the application. This element has a direct JavaScript counterpart in the presentation level of the Webcentric architecture: the Application object. In turn, the JavaScript Application object makes the underlying model accessible through its own 'model' property. This gives a direct reference to the root Application element, and through that to the entire model.
Attribute Detail
auto_save
Type:
xs:boolean, predefined
Use:
optional
Default:
"true"
Save user preferences and application state on exit. The application exits when user closes the browser, or navigates to another URL. If auto_save is true, any user preferences that have changed will be saved, along with state changes for layouts or components.
auto_size
Type:
xs:boolean, predefined
Use:
optional
Default:
"true"
Determines whether the application resizes when the browser window is resized.
drag_container
Type:
xs:string, predefined
Use:
optional
Identifies the container element that defines the drag boundaries for a drag operation. It is not possible to drag an element outside this constrained area. Individual draggable elements can define specific drag containers, though it is often more convenient to define this once for the entire application, on the application node. The value must be an xpath expression that, when evaluated, identifies a frameset or component.
language
Type:
xs:string, predefined
Use:
optional
The default language used to localise the application's text and formatting. Webcentric supports internationalisation of the user interface. If this feature is enabled, and users are given the option to specify an alternative display language, this value will be overridden by the user preferences.
layout
Type:
xs:string, predefined
Use:
optional
This attribute specifies the initial layout or layouts to be loaded, if not overridden by a value from the user preferences. Typically, this is used is to specify a default layout to be loaded the first time a user launches the application. If preferences are being saved on a per-user basis, this attribute will normally be ignored on subsequent use of the application by the same user. The last layout loaded will be saved as a user preference.
maximize_target
Type:
xs:string, predefined
Use:
optional
Default:
"GUI"
The default maximize boundary. This identifies the application region to which FrameItems are maximized. It must be an xpath expression identifying a frameset or component. If this attribute is not specified, the default value will be the main content area of the application, excluding any application decorators - headings, menus, toolbars, and so on; but including any components open within the application workspace - navigation panels, consoles and so on. This value will be used to define the maximized size of any FrameItem that is maximized and that does not explicitly declare a maximize_target attribute. In the case of FrameItems that do include a maximize_target attribute declaration, the local declaration takes precedence over the global attribute.
panel_name_max_length
Type:
xs:integer, predefined
Use:
optional
Default:
"30"
Defines the maximum number of characters allowed in a Panel name. This value is only used when a Panel can be renamed. For more information, see the "panel_rename" attribute.
panel_rename
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
Defines whether panels can be renamed by the user or not. Individual panels can override this value using the "rename" attribute.
preload
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
Instructs Webcentric to construct the referenced components at application startup, rather than on-demand. This is applicable to any components that are not included as part of the selected layout; these will be constructed as part of the normal startup process. This capability was introduced to facilitate faster first-time display of dialog components. Common sense must be applied when specifying components to pre-load, as there is a cost to processing these requests. They are handled in timeouts after the app is initialised, but too many components being pre-loaded may affect the responsiveness of the application during the users first interactions. Use for important dialogs which the user is highly likely to use. Especially useful where a dialog may be slow to display due more to network latency than build-time - in this case there is little downside to the technique.
theme
Type:
xs:string, predefined
Use:
optional
The default theme to be applied. If the application offers users a choice of theme, any theme specified in the user preferences will take precedence over this value. Valid values will depend on the themes available to the application. The value must equate to the name of an installed theme, which will be located in a folder of the same name.
theme_path
Type:
xs:string, predefined
Use:
optional
The path (relative to the application aspect), to the directory that contains all styling and images for the application. This directory should contain a directory named 'common' which contains styles and images that are used in all themes, and a separate directory per theme.