info.magnolia.ui.workbench.definition
Class ConfiguredWorkbenchDefinition

java.lang.Object
  info.magnolia.ui.workbench.definition.ConfiguredWorkbenchDefinition

All Implemented Interfaces:

WorkbenchDefinition, Serializable

public class ConfiguredWorkbenchDefinition
extends Object
implements WorkbenchDefinition

Default configured implementation of WorkbenchDefinition.

See Also:

Serialized Form

Constructor Summary

ConfiguredWorkbenchDefinition()

Method Summary

void	addContentView(ContentPresenterDefinition contentView)
void	addNodeType(NodeTypeDefinition nodeTypeDefinition)
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()
void	setContentViews(List<ContentPresenterDefinition> contentViews)
void	setDefaultOrder(String defaultOrder)
void	setDialogWorkbench(boolean dialogWorkbench)
void	setDropConstraintClass(Class<? extends DropConstraint> dropConstraintClass)
void	setEditable(boolean editable)
void	setIncludeProperties(boolean includeProperties)
void	setIncludeSystemNodes(boolean includeSystemNodes)
void	setName(String name)
void	setNodeTypes(List<NodeTypeDefinition> nodeTypes)
void	setPath(String path)
void	setWorkspace(String workspace)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfiguredWorkbenchDefinition

public ConfiguredWorkbenchDefinition()

Method Detail

getName

public String getName()

Specified by:

getName in interface WorkbenchDefinition

setName

public void setName(String name)

getNodeTypes

public List<NodeTypeDefinition> getNodeTypes()

Specified by:

getNodeTypes in interface WorkbenchDefinition

Returns:

all configured NodeTypes.

setNodeTypes

public void setNodeTypes(List<NodeTypeDefinition> nodeTypes)

addNodeType

public void addNodeType(NodeTypeDefinition nodeTypeDefinition)

isIncludeProperties

public boolean isIncludeProperties()

Specified by:

isIncludeProperties in interface WorkbenchDefinition

Returns:

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

setIncludeProperties

public void setIncludeProperties(boolean includeProperties)

isIncludeSystemNodes

public boolean isIncludeSystemNodes()

Specified by:

isIncludeSystemNodes in interface WorkbenchDefinition

Returns:

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

setIncludeSystemNodes

public void setIncludeSystemNodes(boolean includeSystemNodes)

getWorkspace

public String getWorkspace()

Specified by:

getWorkspace in interface WorkbenchDefinition

setWorkspace

public void setWorkspace(String workspace)

getPath

public String getPath()

Specified by:

getPath in interface WorkbenchDefinition

Returns:

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

setPath

public void setPath(String path)

isDialogWorkbench

public boolean isDialogWorkbench()

Description copied from interface: WorkbenchDefinition

Define if this workbench is used for Dialog.

Specified by:

isDialogWorkbench in interface WorkbenchDefinition

setDialogWorkbench

public void setDialogWorkbench(boolean dialogWorkbench)

getDefaultOrder

public String getDefaultOrder()

Specified by:

getDefaultOrder in interface WorkbenchDefinition

Returns:

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

setDefaultOrder

public void setDefaultOrder(String defaultOrder)

isEditable

public boolean isEditable()

Description copied from interface: WorkbenchDefinition

Checks if workbench can edit tree view inplace.

Specified by:

isEditable in interface WorkbenchDefinition

Returns:

true, if workbench is editable

setEditable

public void setEditable(boolean editable)

getDropConstraintClass

public Class<? extends DropConstraint> getDropConstraintClass()

Specified by:

getDropConstraintClass in interface WorkbenchDefinition

Returns:

the DropConstraint class used to handle drag&drop.

setDropConstraintClass

public void setDropConstraintClass(Class<? extends DropConstraint> dropConstraintClass)

getContentViews

public List<ContentPresenterDefinition> getContentViews()

Specified by:

getContentViews in interface WorkbenchDefinition

Returns:

the list of configured views.

setContentViews

public void setContentViews(List<ContentPresenterDefinition> contentViews)

addContentView

public void addContentView(ContentPresenterDefinition contentView)