Class: ManagementToolbar

ManagementToolbar()

Metal ManagementToolbar component.

Constructor

new ManagementToolbar()

Source:

Members

(static, non-null) STATE :Object

State definition.
Type:
  • Object
Source:

(nullable) actionHandler :string|object|undefined

Component wired to handle the different available user actions in the ManagementToolbar component. The actionHandler should be a string that represent a component ID that the toolbar can resolve through a `Liferay.componentReady(actionHandler)` call.
Type:
  • string | object | undefined
Deprecated:
  • use defaultEventHandler instead
Default Value:
  • undefined
Source:

(nullable) actionItems :array|undefined

List of items to display in the actions menu on active state.
Type:
  • array | undefined
Default Value:
  • undefined
Source:

(nullable) checkboxStatus :string|undefined

Satus of the select items checkbox. If checkboxStatus is checked or indeterminate the toolbar will be in active state.
Type:
  • string | undefined
Default Value:
  • unchecked
Source:

(nullable) clearResultsURL :string|undefined

Url for clear results link.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) clearSelectionURL :string|undefined

Url for clear selection link.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) contentRenderer :string|undefined

Name of the content renderer to use template variants.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) creationMenu :object|string|bool|undefined

Configuration of the creation menu. Set `true` to render a plain button that will emit an event onclick. Set `string` to use it as link href to render a link styled button. Set `object` to render a dropdown menu with items.
Type:
  • object | string | bool | undefined
Default Value:
  • undefined
Source:

(nullable) defaultEventHandler :string|object|undefined

Component wired to handle the different available user actions in the ManagementToolbar component.
Type:
  • string | object | undefined
Default Value:
  • undefined
Source:

(nullable) disabled :bool

Flag to indicate if the managment toolbar is disabled or not.
Type:
  • bool
Default Value:
  • false
Source:

(nullable) elementClasses :string|undefined

CSS classes to be applied to the element.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) filterItems :array|undefined

List of filter menu items.
Type:
  • array | undefined
Default Value:
  • undefined
Source:

(nullable) filterLabels :array|undefined

List of filter label items.
Type:
  • array | undefined
Default Value:
  • undefined
Source:

(nullable) id :string|undefined

Id to be applied to the element.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

infoPanelId :string|undefined

Id to get the infoPanel node.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) searchActionURL :string|undefined

URL of the search form action
Type:
  • string | undefined
Default Value:
  • undefined
Source:

searchContainerId :string|undefined

Id to get a instance of the searchContainer.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) searchData :object

Map of properties that will be rendered as hidden inputs in the search form.
Type:
  • object
Default Value:
  • undefined
Source:

(nullable) searchFormMethod :string|undefined

Method of the search form.
Type:
  • string | undefined
Default Value:
  • GET
Source:

(nullable) searchFormName :string|undefined

Name of the search form.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) searchInputName :string|undefined

Name of the search input.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) searchValue :string|undefined

Value of the search input.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) selectable :bool|undefined

Flag to indicate if the managment toolbar will control the selection of elements.
Type:
  • bool | undefined
Default Value:
  • undefined
Source:

(nullable) selectAllURL :string|undefined

Url for select all link.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) selectedItems :number|undefined

Number of selected items.
Type:
  • number | undefined
Default Value:
  • undefined
Source:

(nullable) showAdvancedSearch :bool

Flag to indicate if advanced search should be shown or not.
Type:
  • bool
Default Value:
  • false
Source:

(nullable) showCreationMenu :bool

Flag to indicate if creation menu button should be shown or not.
Type:
  • bool
Default Value:
  • true
Source:

(nullable) showFiltersDoneButton :bool

Flag to indicate if the `Done` button in filter dropdown should be shown or not.
Type:
  • bool
Default Value:
  • true
Source:

(nullable) showInfoButton :bool

Flag to indicate if the Info button should be shown or not.
Type:
  • bool
Default Value:
  • false
Source:

(nullable) showResultsBar :bool

Flag to indicate if the results bar should be shown or not.
Type:
  • bool
Default Value:
  • false
Source:

(nullable) showSearch :bool

Flag to indicate if search should be shown or not.
Type:
  • bool
Default Value:
  • true
Source:

(nullable) showSelectAllButton :bool

Flag to indicate if select all button should be shown or not.
Type:
  • bool
Default Value:
  • false
Source:

(nullable) sortingOrder :string|undefined

Sorting order.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) sortingURL :string|undefined

Sorting url.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

(nullable) spritemap :string|undefined

The path to the SVG spritemap file containing the icons.
Type:
  • string | undefined
Default Value:
  • undefined
Source:

supportsBulkActions :boolean

Flag to indicate that the toolbar supports bulk selection.
Type:
  • boolean
Default Value:
  • false
Source:

(nullable) totalItems :number|undefined

Total number of items. If totalItems is 0 most of the elements in the bar will appear disabled.
Type:
  • number | undefined
Default Value:
  • undefined
Source:

(nullable) viewTypes :array|undefined

List of view items.
Type:
  • array | undefined
Default Value:
  • undefined
Source:

Methods

attached()

Source:

disposed()

Source: