PanelStackDefinition

The PanelStackDefinition object contains an ordered collection of panel identifiers. The PanelStackDefinition object is assigned to a cell which corresponds to a DOM element on the page. The cell defines the position of the PanelStackDefinition object on the page.

The attributes of the PanelStackDefinition object, which are in addition to the attributes inherited from the FrameworkObject base class, are described below:

Attribute

Description

errorPanelId

[Deprecated] Use the optionNames mapping on the FrameworkObject to assign arbitrary identifiers to framework objects. Currently used in Service Center to identify the error panel.

header

[Deprecated] Use the optionNames mapping on the FrameworkObject to assign arbitrary options to framework objects. Currently used in Service Center to specify the location of the panel stack header contents.

objectType

PanelStackDefinition

panelBackgroundTabStyle

Not used.

panelIds

The ordered collection of panel identifiers.

panelSelectedTabStyle

Not used. Styles are indicated in the panel layout template.

panelStackId

Logical identifier that other objects use to refer to this object, which is exposed to other objects and to the code and which is the primary external way to refer to the object.

panelTitlebarTabbedStyle

Not used. Styles are indicated in the panel layout template.

panelTitlebarUntabbedStyle

Not used. Styles are indicated in the panel layout template.

tabbYn

The tabAffinity flag indicates whether the panel stack is associated with a particular tab (true) or whether it can be rendered under any tab, as in the case of user preferences (false). For a given panel stack, if the tabAffinity flag is true and this was the last panelStack viewed under a tab, then, when the user navigates back to that tab, this panel stack will be rendered under the tab.

titleKey

Resource bundle key for the label that goes in the panel stack.

The extension methods of the PanelStackDefinition object are described below:

Returns

Method

Description

List

getPanels

Returns a list of all PanelDefinition objects assigned to the PanelStackDefinition.

List

getPanelStackDefinitions

Arguments: intpItemType

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

The extension methods of the PanelStackDefinitionHome interface are described below:

Returns

Method

Description

PanelStackDefinition

findByUserSegmentAndPanelStackId

Arguments: String appId, String panelStackId

Returns the PanelStackDefinition 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 panel stack identifier only. The appId indicates the framework application in which to look for the object.

 
loading table of contents...