The framework-definition object is a container object for navigation, layout, and look-and-feel for the entire UI. The framework-definition object contains skins and tabs. Skins contain configurable look-and-feel and template definitions for the UI layout. Tabs define the top-level navigation for the application.
The attributes of the framework-definition object, in addition to the attributes inherited from the FrameworkObject base class, are:
Attribute | Description |
|---|---|
| Logical identifier that other objects use to refer to this object. This is exposed to other objects and to the code, and is the primary external way to refer to the object. |
| The logical identifier for the currently selected tab. |
| Ordered list of the look-and-feel skins used by the framework that is mapped to a user-friendly local key. |
| Defines the order of the application tabs. |
The following are extension methods of the framework-definition object:
Returns | Method | Description |
|---|---|---|
List |
| Returns a list of all |
List |
| Returns a list of all |
List |
| Utility method that returns a list of framework definitions by Arguments: |
The following is an example of a framework-definition from the serviceFramework.xml file:
<framework-definition> <id>WsAgentFramework</id> <app-id>workspace</app-id> <enabled-yn>true</enabled-yn> <object-type>FrameworkDefinition</object-type> … </framework-definition>
The framework-definition also identifies the skin IDs used within the framework. For example, the skins used in this framework definition object are the htmlSkin and the originalSkin. The priority sets the skin priority in the layout:
<skin-ids> <id-entry> <id>htmlSkin</id> <priority>100</priority> </id-entry> <id-entry> <id>originalSkin</id> <priority>200</priority> </id-entry> </skin-ids>
The framework-definition identifies the tab IDs used within the framework. The priority property sets the tab priority, for example:
<tab-ids> <id-entry> <id>browseTab</id> <priority>100</priority> </id-entry> <id-entry> <id>searchTab</id> <priority>200</priority> </id-entry> <tab-ids>
