org.jahia.services.uicomponents.bean.editmode

Class EditConfiguration

java.lang.Object

org.jahia.services.uicomponents.bean.editmode.EditConfiguration

All Implemented Interfaces:

Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class EditConfiguration
extends Object
implements Serializable, org.springframework.beans.factory.BeanNameAware

Represent edit mode configuration, including side panel and side panel toolbar, top toolbar, main module toolbar and context menu. Core side of GWTConfiguration. See link between this and GWTConfiguration in UIConfigHelper

Author:

ktlili Date: Apr 14, 2010 Time: 12:26:47 PM

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EditConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addTab(int index, SidePanelTab tab)
void	addTab(SidePanelTab tab)
Set<String>	getBypassModeForTypes()
List<String>	getComponentsPaths()
Toolbar	getContextMenu()
EngineConfiguration	getDefaultEditConfiguration()
String	getDefaultLocation()
String	getDefaultUrlMapping()
org.jahia.ajax.gwt.client.data.toolbar.GWTConfiguration.DragAndDropBehavior	getDragAndDropBehavior()
Set<String>	getEditableTypes()
Map<String,EngineConfiguration>	getEngineConfigurations()
Set<String>	getExcludedNodeTypes() Excluded node types from creation
String	getForcedSite()
Toolbar	getMainModuleToolbar()
String	getName()
String	getNodeCheckPermission()
Set<String>	getNonEditableTypes()
Set<String>	getNonVisibleTypes()
boolean	getRefreshOnExternalModification()
String	getRequiredPermission()
Toolbar	getSidePanelToolbar()
String	getSitesLocation()
Set<String>	getSkipMainModuleTypesDomParsing()
List<SidePanelTab>	getTabs()
Toolbar	getTopToolbar()
List<Toolbar>	getTopToolbars()
Set<String>	getVisibleTypes()
boolean	isEventDispatchingEnabled() Indicates if the events (using Atmosphere framework) should be dispatched to consumers, registered via JavaScript callbacks.
boolean	isForceHeaders()
boolean	isLoadSitesList()
boolean	isNeedFrameParsing()
boolean	isRefreshEnabled()
boolean	isSupportChannelsDisplay()
boolean	isUseFullPublicationInfoInMainAreaModules()
void	removeTab(String tabKey)
void	setBeanName(String name)
void	setBypassModeForTypes(Set<String> bypassModeForTypes)
void	setComponentsPaths(List<String> componentsPaths)
void	setContextMenu(Toolbar contextMenu)
void	setDefaultLocation(String defaultLocation)
void	setDefaultUrlMapping(String defaultUrlMapping)
void	setDragAndDropBehavior(org.jahia.ajax.gwt.client.data.toolbar.GWTConfiguration.DragAndDropBehavior dragAndDropBehavior)
void	setEditableTypes(Set<String> editableTypes)
void	setEnableDragAndDrop(boolean enableDragAndDrop)
void	setEngineConfigurations(Map<String,EngineConfiguration> engineConfigurations)
void	setEventDispatchingEnabled(boolean dispatchEvents) Should the events (using Atmosphere framework) be dispatched to consumers, registered via JavaScript callbacks or not.
void	setExcludedNodeTypes(Set<String> excludedNodeTypes)
void	setForcedSite(String forcedSite)
void	setForceHeaders(boolean forceHeaders)
void	setLoadSitesList(boolean loadSitesList)
void	setMainModuleToolbar(Toolbar mainModuleToolbar)
void	setName(String name)
void	setNeedFrameParsing(boolean needFrameParsing)
void	setNodeCheckPermission(String nodeCheckPermission)
void	setNonEditableTypes(Set<String> nonEditableTypes)
void	setNonVisibleTypes(Set<String> nonVisibleTypes)
void	setRefreshEnabled(boolean refreshEnabled)
void	setRefreshOnExternalModification(boolean refreshOnExternalModification)
void	setRequiredPermission(String requiredPermission)
void	setSidePanelToolbar(Toolbar sidePanelToolbar)
void	setSitesLocation(String sitesLocation)
void	setSkipMainModuleTypesDomParsing(Set<String> skipMainModuleTypesDomParsing)
void	setSupportChannelsDisplay(boolean supportChannelsDisplay)
void	setTabs(List<SidePanelTab> tabs)
void	setTopToolbar(Toolbar topToolbar)
void	setTopToolbars(List<Toolbar> topToolbars)
void	setUseFullPublicationInfoInMainAreaModules(boolean useFullPublicationInfoInMainAreaModules)
void	setVisibleTypes(Set<String> visibleTypes)

Methods inherited from class java.lang.Object

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

Constructor Detail

EditConfiguration

public EditConfiguration()

Method Detail

addTab

public void addTab(SidePanelTab tab)

addTab

public void addTab(int index,
                   SidePanelTab tab)

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

getName

public String getName()

setName

public void setName(String name)

getTopToolbar

public Toolbar getTopToolbar()

setTopToolbar

public void setTopToolbar(Toolbar topToolbar)

getTopToolbars

public List<Toolbar> getTopToolbars()

setTopToolbars

public void setTopToolbars(List<Toolbar> topToolbars)

getSidePanelToolbar

public Toolbar getSidePanelToolbar()

setSidePanelToolbar

public void setSidePanelToolbar(Toolbar sidePanelToolbar)

getMainModuleToolbar

public Toolbar getMainModuleToolbar()

setMainModuleToolbar

public void setMainModuleToolbar(Toolbar mainModuleToolbar)

getContextMenu

public Toolbar getContextMenu()

setContextMenu

public void setContextMenu(Toolbar contextMenu)

getTabs

public List<SidePanelTab> getTabs()

setTabs

public void setTabs(List<SidePanelTab> tabs)

getDefaultEditConfiguration

public EngineConfiguration getDefaultEditConfiguration()

getEngineConfigurations

public Map<String,EngineConfiguration> getEngineConfigurations()

setEngineConfigurations

public void setEngineConfigurations(Map<String,EngineConfiguration> engineConfigurations)

getSitesLocation

public String getSitesLocation()

setSitesLocation

public void setSitesLocation(String sitesLocation)

getForcedSite

public String getForcedSite()

setForcedSite

public void setForcedSite(String forcedSite)

getDragAndDropBehavior

public org.jahia.ajax.gwt.client.data.toolbar.GWTConfiguration.DragAndDropBehavior getDragAndDropBehavior()

setDragAndDropBehavior

public void setDragAndDropBehavior(org.jahia.ajax.gwt.client.data.toolbar.GWTConfiguration.DragAndDropBehavior dragAndDropBehavior)

setEnableDragAndDrop

public void setEnableDragAndDrop(boolean enableDragAndDrop)

getRefreshOnExternalModification

public boolean getRefreshOnExternalModification()

setRefreshOnExternalModification

public void setRefreshOnExternalModification(boolean refreshOnExternalModification)

getRequiredPermission

public String getRequiredPermission()

setRequiredPermission

public void setRequiredPermission(String requiredPermission)

getNodeCheckPermission

public String getNodeCheckPermission()

setNodeCheckPermission

public void setNodeCheckPermission(String nodeCheckPermission)

getDefaultUrlMapping

public String getDefaultUrlMapping()

setDefaultUrlMapping

public void setDefaultUrlMapping(String defaultUrlMapping)

removeTab

public void removeTab(String tabKey)

getComponentsPaths

public List<String> getComponentsPaths()

Returns:

List of paths to the components

setComponentsPaths

public void setComponentsPaths(List<String> componentsPaths)

getEditableTypes

public Set<String> getEditableTypes()

Returns:

Set of editable types

setEditableTypes

public void setEditableTypes(Set<String> editableTypes)

getNonEditableTypes

public Set<String> getNonEditableTypes()

Returns:

Set of non editable types

setNonEditableTypes

public void setNonEditableTypes(Set<String> nonEditableTypes)

getSkipMainModuleTypesDomParsing

public Set<String> getSkipMainModuleTypesDomParsing()

Returns:

Set of types on witch we avoid to parse dom for module lookup (ex javascript, css, etc ..)

setSkipMainModuleTypesDomParsing

public void setSkipMainModuleTypesDomParsing(Set<String> skipMainModuleTypesDomParsing)

getVisibleTypes

public Set<String> getVisibleTypes()

Returns:

Set of visible Types

setVisibleTypes

public void setVisibleTypes(Set<String> visibleTypes)

getNonVisibleTypes

public Set<String> getNonVisibleTypes()

Returns:

Set of types to hide

setNonVisibleTypes

public void setNonVisibleTypes(Set<String> nonVisibleTypes)

getExcludedNodeTypes

public Set<String> getExcludedNodeTypes()

Excluded node types from creation

Returns:

setExcludedNodeTypes

public void setExcludedNodeTypes(Set<String> excludedNodeTypes)

getBypassModeForTypes

public Set<String> getBypassModeForTypes()

setBypassModeForTypes

public void setBypassModeForTypes(Set<String> bypassModeForTypes)

isForceHeaders

public boolean isForceHeaders()

setForceHeaders

public void setForceHeaders(boolean forceHeaders)

getDefaultLocation

public String getDefaultLocation()

setDefaultLocation

public void setDefaultLocation(String defaultLocation)

isLoadSitesList

public boolean isLoadSitesList()

setLoadSitesList

public void setLoadSitesList(boolean loadSitesList)

isUseFullPublicationInfoInMainAreaModules

public boolean isUseFullPublicationInfoInMainAreaModules()

setUseFullPublicationInfoInMainAreaModules

public void setUseFullPublicationInfoInMainAreaModules(boolean useFullPublicationInfoInMainAreaModules)

isSupportChannelsDisplay

public boolean isSupportChannelsDisplay()

setSupportChannelsDisplay

public void setSupportChannelsDisplay(boolean supportChannelsDisplay)

isNeedFrameParsing

public boolean isNeedFrameParsing()

setNeedFrameParsing

public void setNeedFrameParsing(boolean needFrameParsing)

isRefreshEnabled

public boolean isRefreshEnabled()

setRefreshEnabled

public void setRefreshEnabled(boolean refreshEnabled)

isEventDispatchingEnabled

public boolean isEventDispatchingEnabled()

Indicates if the events (using Atmosphere framework) should be dispatched to consumers, registered via JavaScript callbacks.

Returns:

true if the events should be dispatched; false if not

setEventDispatchingEnabled

public void setEventDispatchingEnabled(boolean dispatchEvents)

Should the events (using Atmosphere framework) be dispatched to consumers, registered via JavaScript callbacks or not.

Parameters:

dispatchEvents - true enables event dispatching; false disables it