Oracle ATG Web Commerce - TabDefinition

TabDefinition

The tab-definition object has multiple functions, which are related to the overall purpose of dividing the application into large functional areas:

Define top-level navigation between functional areas
Specify page structure using layout cells and templates
Define panel stacks containing related content groupings

The attributes of the tab-definition object, in addition to the attributes inherited from the FrameworkObject base class, are described below:

Attribute	Description
`tab-id`	Logical identifier that other objects use to refer to this object, which is exposed to other objects and to the code. This is the primary external way to refer to the object.
`title-key`	Resource bundle key for the tab label.
`action-id`	The application-interpreted action URL or JavaScript function that is executed when the user selects an object on the tab.
`next-steps-id`	The identifier of the default next steps menu that is displayed with the tab.
`visible-yn`	The `visibleYn` flag determines whether an enabled tab is rendered or hidden.
`access-right`	The access right that defines the security user role required to view the tab.
`panel-stack-assignments`	A map that assigns `panel-stack-ids` strings to `cell-id` strings. The panel stack assignments indicate the cells where each panel stack is displayed. Contains the reverse mapping of the `cell-assignments` map.
`current-panel-stacks`	The listing of the identifiers of the panel stacks currently being displayed on the tab. The `panel-stack-assignments` attribute indicates which cell the panel stack populates within the page layout.
`panel-stack-order`	The list of all panel stacks for the tab in rendering order. This supports panel stacks that must be rendered in a specific order.
`cell-assignments`	Indicates the initial panel stack that is displayed in each cell. Contains the reverse mapping of the `panel-stack-assignments` map.

The extension method of the TabDefinitionHome interface is:

Returns	Method	Description
`TabDefinition`	`findByUserSegmentAndTabId`	Returns the `TabDefinition` with the specified identifier based on the segment of the current user. If the current user does not have a segment or no object is found for the current segment, a default object is returned based on tab identifier only. The `appId` indicates the framework application in which to look for the object. Arguments: String `appId`, String `tabId`

Returns

Method

Description

TabDefinition

findByUserSegmentAndTabId

Returns the TabDefinition with the specified identifier based on the segment of the current user. If the current user does not have a segment or no object is found for the current segment, a default object is returned based on tab identifier only. The appId indicates the framework application in which to look for the object.

Arguments: String appId, String tabId

The following is an example of a tab-definition that defines a document tab layout:

<tab-definition>
  <id>MyDocumentTabDefinition</id>
  <app-id>workspace</app-id>
  <enabled-yn>true</enabled-yn>
  <name-key>myDocumentTab.name</name-key>
  <object-type>TabDefinition</object-type>
  <description-key>myDocumentTab.description</description-key>
  <image-url>/image/myDocumentTabdefault.gif</image-url>
  <tab-id>myDocumentTab</tab-id>
  <title-key>myDocumentTab.label</title-key>
  <action-id>/main.jsp?t=documentTab</action-id>
  <visible-yn>false</visible-yn>
  <access-right></access-right>
  <panel-stack-assignments>
    <map-entry>
      <key>documentPanels</key>
      <value>centerColumn</value>
    </map-entry>
  </panel-stack-assignments>
  <cell-assignments>
    <map-entry>
      <key>centerColumn</key>
      <value>documentPanels</value>
    </map-entry>
  </cell-assignments>
</tab-definition>

TabDefinition

ATG Service Center UI Programming Guide