ATG Service Installation and Configuration Guide

accessRight

The access right, which defines a security right required to view the panel.

allowContentToggleYn

The allowContentToggleYn flag indicates whether the panel contents can be closed or minimized, leaving only the panel title bar visible.

allowPanelToggleYn

The allowPanelToggle flag indicates whether the entire panel, including title bar, can be closed or minimized and represented by a place-holder in the available panels.

allowSlotsYn

The allowSlotsYn flag indicates whether the panel is allowed to contain slots. Panels with this flag set to true are displayed with as the potential slot-enabled panels in admin.

allowTabbingYn

The allowTabbingYn flag indicates whether the panel is allowed to be tabbed in a row of panel tabs on a tab-holder panel.

alwaysTabbedYn

The alwaysTabbedYn flag indicates whether the panel is forced to be tabbed in a row of panel tabs on a tab-holder panel with no ability to be removed from the tabbed position.

availableYn

[Obsolete] Not used (see panelOpenYn).

contentOpenYn

The contentOpenYn flag indicates whether the panel contents are currently closed or minimized and whether currently only the panel title bar is visible.

contentUrl

Use the templateIds mapping on the FrameworkObject to assign arbitrary JSP pages to framework objects. Currently used in Service Center to identify the contents of the panel.

currentPanelId

Holds the identifier of the currently visible panel based on the selected tab for tab-holder panels.

helpKey

Originally intended to provide a string for inline help accessible via a help icon located on the panel title bar. The panel help feature has not been implemented. See Global Workspace functional spec.

objectType

PanelDefinition

onload

Contains the optional name of a JavaScript function to evaluate when the panel is loaded by the framework.

onunload

Contains the optional name of a JavaScript function to evaluate when the panel is unloaded by the framework.

panelId

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.

panelItemCount

Provides a way for the panel label to contain a number representing the number of items displayed in the panel. For example, a panel that displays 17 search results in its content area is able to display My Search Results (17) in the title bar.

panelOpenYn

The panelOpenYn flag indicates whether the entire panel is currently closed or minimized with a place-holder displayed in the available panels.

panelTitleStyle

[Obsolete] Not used. Styles are indicated in the panel layout template.

showTitleYn

The showTitleYn flag indicates whether the panel has a visible title bar or only a content area with no title bar.

slotRendererCombos

Defines the slots to render with the panel. The allowSlotsYn flag must be enabled to render slots within a panel.

tabbedPanelIds

Lists the identifiers of the other panels which are tabbed with the current tab-holder panel. The tabs are rendered in the order that the corresponding panels identifiers occur in the list.

tabbedYn

The tabbedYn flag indicates whether the panel is currently a tabbed in a row of panel tabs on a tab-holder panel.

tabHolderYn

The tabHolderYn flag determines whether the panel can hold other panels in a tabbed format.

tabScrollIndex

Supports the scrollable tabs feature for horizontal tab scrolling that has not been implemented. See Global Workspace functional spec.

titleKey

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

visibleYn

The visibleYn flag determines whether an enabled tab is rendered or hidden.

void

addSlotRendererCombo

Arguments: SlotRendererCombopCombo

Adds a SlotRendererCombo object defining a slot to this personalization panel for offer management. The allowSlotsYn flag must be enabled for the slots to be rendered.

Boolean

removeSlotRendererCombo

Arguments: SlotRendererCombopCombo

Removes a SlotRendererCombo object defining a slot from the personalization panel.

void

moveSlotRendererComboDown

Arguments: SlotRendererCombopCombo

Moves a SlotRendererCombo object defining a slot in the personalization panel to a higher-indexed position.

void

moveSlotRendererComboUp

Arguments: SlotRendererCombopCombo

Moves a SlotRendererCombo object defining a slot in the personalization panel to a lower-indexed position.

PanelDefinition

findByUserSegmentAndPanelId

Arguments: String appId, String panelId

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