Class ecm.widget.layout.LaunchBarContainer
Extends
dijit.layout.BorderContainer, dijit._TemplatedMixin, ecm.LoggerMixin.
Provides a vertical bar that displays the features available in a layout. The vertical bar appears on the
leading side of the layout.
Defined in: <ecm\widget\layout\LaunchBarContainer.js>.
Constructor Summary
| Constructor Attributes | Constructor Name and Description |
|---|---|
Field Summary
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
ecm.widget.layout.LaunchBarContainer.featureBarPosition
Controls the position of the feature bar in the container.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.featureBarStyle
Controls the style of the feature bar.
|
Method Summary
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
ecm.widget.layout.LaunchBarContainer.addFeatureToContainer(feature)
Adds a new feature to the container, by creating it's button and panel.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.addWidgetToContextualArea(widget)
Adds a widget to the contextual area.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.closeAllFlyouts()
Close all flyout menus
|
| <static> |
ecm.widget.layout.LaunchBarContainer.constructor(params)
|
| <static> |
ecm.widget.layout.LaunchBarContainer.destroy()
|
| <static> |
ecm.widget.layout.LaunchBarContainer.disableButton(uuid)
Disables the feature button
|
| <static> |
ecm.widget.layout.LaunchBarContainer.getButtonByID(uuid)
Gets the button with the given ID.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.getButtons()
Return all launcher buttons
|
| <static> |
ecm.widget.layout.LaunchBarContainer.getChildPanes()
Returns all child panes in the launchbar container.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.getContentPaneByID(uuid)
Gets the panel with the given ID .
|
| <static> |
ecm.widget.layout.LaunchBarContainer.getMenuItemByID(uuid)
Gets the menuItem with the given ID.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.onButtonClick(selectedButton)
Event invoked when the main launcher button is clicked
|
| <static> |
ecm.widget.layout.LaunchBarContainer.onFeatureFlyoutCreated(flyout)
Event method when a new feature flyout panel is added to the launch bar container.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.onFeaturePanelCreated(panel)
Event method when a new feature panel is added to the launch bar container.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.onFlyoutShortcutClicked(selectedButton)
Event invoked when the flyout's shortcut is clicked
|
| <static> |
ecm.widget.layout.LaunchBarContainer.postCreate()
|
| <static> |
ecm.widget.layout.LaunchBarContainer.removeFeatureFromLayout(feature)
Removes the given feature from the container.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.selectContentPane(button, uuid, params)
Selects a Content Pane by the given ID and sets the appropriate launcher button as selected.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.setLayout(layout)
Sets the layout for the launch bar.
|
| <static> |
ecm.widget.layout.LaunchBarContainer.updateButtonsState(button, contentSet)
Updates the button state to indicate whether it is selected
|
Field Detail
<static> ecm.widget.layout.LaunchBarContainer.featureBarPosition
Controls the position of the feature bar in the container. Default is leading, which will display the button
bar either on the left or right side of the UI depending on the whether the language is displayed
left-to-right or right-to-left. Valid values includes "top", "bottom", "leading" and "trailing".
<static> ecm.widget.layout.LaunchBarContainer.featureBarStyle
Controls the style of the feature bar. The default is to display all feature icons as a toolbar. Setting this
value to "dropdown" will create a single action drop-down button to contain all feature icons. The feature
bar will only display a dropdown if "featureBarPosition" is top or bottom.
Method Detail
<static> ecm.widget.layout.LaunchBarContainer.addFeatureToContainer(feature)
Adds a new feature to the container, by creating it's button and panel.
- Parameters:
- feature
- The feature to add to the container.
<static> ecm.widget.layout.LaunchBarContainer.addWidgetToContextualArea(widget)
Adds a widget to the contextual area. The contextual area is located in the trailing position if the feature
bar is positioned at the top or bottom of the screen and in the bottom position if the feature bar is
positioned in the leading or trailing locations on the screen. This area is an open area to add any widget
you choose, such as a search bar or additional buttons unrelated to the navigation within the feature bar
area.
- Parameters:
- widget
- The widget to add to the contextual area.
<static> ecm.widget.layout.LaunchBarContainer.closeAllFlyouts()
Close all flyout menus
- Deprecated:
- As of 2.0.3.3. Flyout menu capabilities will be removed in a future release.
<static> ecm.widget.layout.LaunchBarContainer.constructor(params)
- Parameters:
- params
<static> ecm.widget.layout.LaunchBarContainer.destroy()
<static> ecm.widget.layout.LaunchBarContainer.disableButton(uuid)
Disables the feature button
- Parameters:
- uuid
<static> ecm.widget.layout.LaunchBarContainer.getButtonByID(uuid)
Gets the button with the given ID.
- Parameters:
- uuid
- ID of the button to return.
- Returns:
- Retuns an instance of ecm.widget.layout._LaunchBarButton or ecm.widget.layout._LaunchBarDialogButton that matches the given ID or null if no match is found.
<static> ecm.widget.layout.LaunchBarContainer.getButtons()
Return all launcher buttons
<static> ecm.widget.layout.LaunchBarContainer.getChildPanes()
Returns all child panes in the launchbar container.
<static> ecm.widget.layout.LaunchBarContainer.getContentPaneByID(uuid)
Gets the panel with the given ID .
- Parameters:
- uuid
- ID of the panel to show.
<static> ecm.widget.layout.LaunchBarContainer.getMenuItemByID(uuid)
Gets the menuItem with the given ID.
- Parameters:
- uuid
- ID of the menuItem to return.
- Returns:
- Retuns an instance of dijit.MenuItem that matches the given ID or null if no match is found.
<static> ecm.widget.layout.LaunchBarContainer.onButtonClick(selectedButton)
Event invoked when the main launcher button is clicked
- Parameters:
- selectedButton
<static> ecm.widget.layout.LaunchBarContainer.onFeatureFlyoutCreated(flyout)
Event method when a new feature flyout panel is added to the launch bar container.
- Parameters:
- flyout
- The newly added ecm.widget.layout._LaunchBarDialogPane widget.
- Deprecated:
- As of 2.0.3.3. Flyout menu capabilities will be removed in a future release.
<static> ecm.widget.layout.LaunchBarContainer.onFeaturePanelCreated(panel)
Event method when a new feature panel is added to the launch bar container.
- Parameters:
- panel
- The newly added ecm.widget.layout._LaunchBarPane widget.
<static> ecm.widget.layout.LaunchBarContainer.onFlyoutShortcutClicked(selectedButton)
Event invoked when the flyout's shortcut is clicked
- Parameters:
- selectedButton
- Deprecated:
- As of 2.0.3.3. Flyout menu capabilities will be removed in a future release.
<static> ecm.widget.layout.LaunchBarContainer.postCreate()
<static> ecm.widget.layout.LaunchBarContainer.removeFeatureFromLayout(feature)
Removes the given feature from the container.
- Parameters:
- feature
- The feature to remove.
<static> ecm.widget.layout.LaunchBarContainer.selectContentPane(button, uuid, params)
Selects a Content Pane by the given ID and sets the appropriate launcher button as selected.
- Parameters:
- button
- Launcher button to be set as selected.
- uuid
- ID of the panel to show.
- params
- Parameters to pass into the child panel.
- Since:
- 2.0.2
<static> ecm.widget.layout.LaunchBarContainer.setLayout(layout)
Sets the layout for the launch bar.
- Parameters:
- layout
- JSON layout definition.
<static> ecm.widget.layout.LaunchBarContainer.updateButtonsState(button, contentSet)
Updates the button state to indicate whether it is selected
- Parameters:
- button
- contentSet