The panel-definition object is the basic content unit for the application. The panel-definition defines a rectangular region of the page with related content referenced by an included JSP content template.
The attributes of the panel-definition object, in addition to the attributes inherited from the FrameworkObject base class, are:
Attribute | Description |
|---|---|
| Logical identifier that other objects use to refer to this object, which is exposed to other objects and to the code. It is the primary external way to refer to the object. |
| Use the |
| Contains a static context link or a context/URL link. |
| Contains the optional name of a JavaScript function to evaluate when the panel is loaded by the framework. |
| Contains the optional name of a JavaScript function to evaluate when the panel is unloaded by the framework. |
| Provides a string for inline help accessible via a help icon located on the panel title bar. |
| Resource bundle key for the label that is associated with the panel. |
| Determines whether an enabled tab is rendered or hidden. |
| Indicates whether the panel has a visible title bar or only a content area with no title bar. |
| Indicates whether the entire panel is currently closed or minimized with a placeholder displayed in the available panels. |
| Indicates whether the entire panel, including title bar, can be closed or minimized and represented by a placeholder in the available panels. |
| Indicates whether the panel contents can be closed or minimized, leaving only the panel title bar visible. |
| Determines whether the panel can hold other panels in a tabbed format. |
| 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. |
| Indicates whether the panel is currently a tabbed in a row of panel tabs on a tab-holder panel. |
| Indicates whether the panel is allowed to be tabbed in a row of panel tabs on a tab-holder panel. |
| Holds the identifier of the currently visible panel based on the selected tab for tab-holder panels. |
| 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. |
| The access right that defines the security user role required to view the panel. |
| Lists the identifiers of the other panels that are tabbed with the current tab-holder panel. The tabs are rendered in the order that the corresponding panels identifiers occur in the list. |
The extension method of the PanelDefinitionHome interface is:
Returns | Method | Description |
|---|---|---|
|
| Returns the Arguments: String |
The following is an example of a PanelDefinition:
<panel-definition> <id>WsCustomerCreateNewPanel</id> <app-id>workspace</app-id> <enabled-yn>true</enabled-yn> <object-type>PanelDefinition</object-type> <template-ids> <map-entry> <key>panelTemplate</key> <value>panelTemplate</value> </map-entry> </template-ids> <panel-id>customerCreatePanel</panel-id> <content-url>/panels/customer/info.jsp</content-url> <other-context>agent</other-context> <help-key>panel.customerInformationPanel.help</help-key> <title-key>panel.customerInformationPanel.label</title-key> <visible-yn>true</visible-yn> <show-title-yn>true</show-title-yn> <panel-open-yn>true</panel-open-yn> <allow-panel-toggle-yn>false</allow-panel-toggle-yn> <available-yn>false</available-yn> <content-open-yn>true</content-open-yn> <allow-content-toggle-yn>false</allow-content-toggle-yn> <tab-holder-yn>false</tab-holder-yn> <always-tabbed-yn>false</always-tabbed-yn> <tabbed-yn>false</tabbed-yn> <allow-tabbing-yn>false</allow-tabbing-yn> <allow-slots-yn>false</allow-slots-yn> <tab-scroll-index>0</tab-scroll-index> <panel-item-count>0</panel-item-count> <access-right>CustomerInformationPanel</access-right> </panel-definition>
