Define a Context Panel

When a context panel is present, it is displayed at the top of the tab's content area, and regardless of the particular page displayed below it, it is always there to provide the user with important contextual information. Refer to User Interface Element 2 in Introduction.

A context panel is defined using a UIM page with some limitation on the UIM allowed. The following is the UIM code for the context panel defined in the Person Tab:

Figure 1. SimplePersonContext.uim

<PAGE PAGE_ID="SimplePersonContext" TYPE="DETAILS">

  <PAGE_TITLE>
    <CONNECT>
      <SOURCE NAME="TEXT"
        PROPERTY="PageTitle.StaticText"/>
    </CONNECT>
  </PAGE_TITLE>

  <TAB_NAME>
    <CONNECT>
      <SOURCE NAME="TEXT" PROPERTY="Tab.title"/>
    </CONNECT>
  </TAB_NAME>


  <PAGE_PARAMETER NAME="personID"/>

  <CLUSTER>
    <FIELD LABEL="Field.Label.ContextPanelFor">
      <CONNECT>
        <SOURCE NAME="PAGE" PROPERTY="personID"/>
      </CONNECT>
    </FIELD>
  </CLUSTER>

</PAGE>

The TYPE attribute allows the developer to specify that a UIM page is intended as a context panel.

The TAB_NAME element defines the content that will be used as the name of the tab.

The PAGE_TITLE element is used as the tab title.

In this example, the context panel only contains one single field that outputs the unique identifier of the person. Note that the page-param matches that defined earlier in the tab configuration.

The corresponding .properties contains the localizable content for the context panel:

PageTitle.StaticText=Person Context Panel
Tab.title=Person Tab

Field.Label.ContextPanelFor=Context Panel for user with ID: