FrameworkDefinition

The FrameworkDefinitionobject is a container object for navigation, layout, and look-and-feel for the entire UI. The FrameworkDefinition 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 FrameworkDefinition object, in addition to the attributes inherited from the FrameworkObject base class, are:

Attribute

Description

frameworkId

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.

currentTabId

The logical identifier for the currently selected tab.

skinIds

Ordered list of the look-and-feel skins used by the framework that is mapped to a user-friendly local key.

tabIds

Defines the order of the application tabs.

The following are extension methods of the FrameworkDefinition object:

Returns

Method

Description

List

getSkins

Returns a list of all SkinDefinition objects assigned to the FrameworkDefinition.

List

getTabs

Returns a list of all TabDefinition objects assigned to the FrameworkDefinition.

List

getFrameworkDefinitions

Utility method that returns a list of framework definitions by item type.

Arguments: int pItemType

The following is an example of a framework-definition from the serviceFramework.xml file:

<framework-definition>
  <id>SsSelfServiceFramework</id>
  <app-id>selfService</app-id>
  <enabled-yn>true</enabled-yn>
  <name-key>selfService.framework.name</name-key>
  <object-type>FrameworkDefinition</object-type>
  <description-key>selfService.framework.description</description-key>
  <image-url>/image/default.gif</image-url>
  <framework-id>selfServiceFramework</framework-id>
...

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>