info.magnolia.ui.workbench.definition
Interface WorkbenchDefinition

All Superinterfaces:

Serializable

All Known Implementing Classes:

ConfiguredWorkbenchDefinition

public interface WorkbenchDefinition
extends Serializable

Defines a workbench. Contains all elements which define a workbench configuration.

Method Summary

List<ContentPresenterDefinition>	getContentViews()
String	getDefaultOrder()
Class<? extends DropConstraint>	getDropConstraintClass()
String	getName()
List<NodeTypeDefinition>	getNodeTypes()
String	getPath()
String	getWorkspace()
boolean	isDialogWorkbench() Define if this workbench is used for Dialog.
boolean	isEditable() Checks if workbench can edit tree view inplace.
boolean	isIncludeProperties()
boolean	isIncludeSystemNodes()

Method Detail

getName

String getName()

getWorkspace

String getWorkspace()

getPath

String getPath()

Returns:

the path configured as root for this workspace. If not specified, defaults to root ("/").

getNodeTypes

List<NodeTypeDefinition> getNodeTypes()

Returns:

all configured NodeTypes.

isIncludeProperties

boolean isIncludeProperties()

Returns:

whether properties should be displayed as well (or just nodes)

isIncludeSystemNodes

boolean isIncludeSystemNodes()

Returns:

whether nodes used by the system should be included, for instance nodes internal to the operations of the JCR implementation.

isDialogWorkbench

boolean isDialogWorkbench()

Define if this workbench is used for Dialog.

getDefaultOrder

String getDefaultOrder()

Returns:

the property (or comma separated list of properties) to be applied when no other order is requested.

isEditable

boolean isEditable()

Checks if workbench can edit tree view inplace.

Returns:

true, if workbench is editable

getDropConstraintClass

Class<? extends DropConstraint> getDropConstraintClass()

Returns:

the DropConstraint class used to handle drag&drop.

getContentViews

List<ContentPresenterDefinition> getContentViews()

Returns:

the list of configured views.