Workbench definition - 5 UI

Deprecated

This workbench definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.

For the updated implementation, see Workbench definition for Magnolia 6 UI instead.

Workbench

Workbench is a view that displays content items in a workspace. It’s part of the content app framework, typically defined in the browser subapp.

The workbench contains a list of content views. Common view types are tree, list, and thumbnail. By default, JCR content apps use the tree view type.

The workbench also provides a default search box.

Workbench definition

Here is an example workbench definition from the Contacts app. This workbench operates on the contacts workspace and displays contacts and folders.

workbench:
  dropConstraintClass: info.magnolia.ui.workbench.tree.drop.AlwaysTrueDropConstraint
  editable: false
  contentViews:
  contentTools:

Property Description

Property	Description
`contentViews`	required Defines how users can view content in the workbench. The parent node for the specific content view definitions. It must contain at least one content view, see Content view definition.
`dragAndDrop`	optional, default is `true` Set to `false` to disable drag and drop operations in the workbench.
`dropConstraintClass`	optional, default is `AlwaysTrueDropConstraint` A drag-and-drop constraint class. By restricting the nodes that a user can move you can enforce a certain node hierarchy. For example, you might want to allow content to be moved under folders but not folders under content. If the class is not defined, the `AlwaysTrueDropConstraint` is set as default. When you write your own class, implement the `DropConstraint` interface.
`editable`	optional Makes the workbench editable inline. You can double-click a cell to edit its value. Works only for columns which are also configured as editable. Inline editing is available only in the tree view, not in list, thumbnail or search views. Definining a default action will override inline editing. Double-clicking the cell with trigger the default action instead of inline edit mode.
`contentTools`	optional A list of configured content tools. A content tool must be configured using `ContentToolDefinition`. `WorkbenchPresenter` is implemented in a way that it automatically configures a search box if you have both list and search view defined.

contentViews

required

Defines how users can view content in the workbench. The parent node for the specific content view definitions. It must contain at least one content view, see Content view definition.

dragAndDrop

optional, default is true

Set to false to disable drag and drop operations in the workbench.

dropConstraintClass

optional, default is AlwaysTrueDropConstraint

A drag-and-drop constraint class. By restricting the nodes that a user can move you can enforce a certain node hierarchy. For example, you might want to allow content to be moved under folders but not folders under content. If the class is not defined, the AlwaysTrueDropConstraint is set as default. When you write your own class, implement the DropConstraint interface.

editable

optional

Makes the workbench editable inline. You can double-click a cell to edit its value. Works only for columns which are also configured as editable.

Inline editing is available only in the tree view, not in list, thumbnail or search views.

Definining a default action will override inline editing. Double-clicking the cell with trigger the default action instead of inline edit mode.

contentTools

optional

A list of configured content tools. A content tool must be configured using ContentToolDefinition.

WorkbenchPresenter is implemented in a way that it automatically configures a search box if you have both list and search view defined.

Feedback

DX Core

Workbench definition - 5 UI

Workbench

Workbench definition

Location

Main doc sections