Package de.hybris.platform.cmscockpit.components.contentbrowser

Class CMSContentEditorInjector

java.lang.Object

de.hybris.platform.cmscockpit.components.contentbrowser.CMSContentEditorInjector

All Implemented Interfaces:

ComponentInjector

public class CMSContentEditorInjector
extends java.lang.Object
implements ComponentInjector

Creates and injects CMS Cockpit ZK components for the dynamic creation of template based content editors.

Note: Currently changes made to nested referenced items are automatically persisted, no matter the value of the autoPersist flag. The autoPersist flag only concerns attributes of the opened content element.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	ADD_BTN_URL
protected static java.lang.String	CREATE_MODE_PARAM
protected static java.lang.String	EDITOR_ENTRY_READ_ONLY
protected static java.lang.String	SELECT_MODE_PARAM
protected static java.lang.String	SKIP_CUSTOM_EDITOR_PARAM
protected static java.lang.String	WIZARD_CONFIG

Fields inherited from interface de.hybris.platform.cockpit.util.ComponentInjector

ATTRIBUTES, CODE, VALUE

Constructor Summary

Constructors

Constructor	Description
CMSContentEditorInjector()

Method Summary

Modifier and Type	Method	Description
protected CMSAdminComponentService	getCMSAdminComponentService()
CMSAdminSiteService	getCmsAdminPerspective()
ContentEditorConfiguration	getConfig()
UIConfigurationService	getConfigurationService()
TypedObject	getItem()
protected java.util.Set<java.lang.String>	getLoadLanguages()
java.lang.Object	getLocationInfoObject()
PropertyInjector	getPropertyInjector()
protected java.util.Comparator<PropertyDescriptor>	getPropertyListComparator()
ReferenceInjector	getReferenceInjector()
org.zkoss.zk.ui.HtmlBasedComponent	getRootComponent()
protected TypeService	getTypeService()
protected UIAccessRightService	getUiAccessRightService()
protected java.lang.Object	getValue(PropertyDescriptor propDescr)
protected java.lang.Object	getValue(PropertyDescriptor propDescr, ObjectValueContainer valueContainer)
ObjectValueContainer	getValueContainer()
ValueService	getValueService()
void	injectComponent(org.zkoss.zk.ui.HtmlBasedComponent parent, java.util.Map<java.lang.String,? extends java.lang.Object> params)
protected void	injectGeneralGroup(org.zkoss.zk.ui.HtmlBasedComponent parent, java.util.Map<java.lang.String,? extends java.lang.Object> params)
protected void	injectList(org.zkoss.zk.ui.HtmlBasedComponent parent, java.util.Map<java.lang.String,? extends java.lang.Object> params)
protected void	injectProperty(org.zkoss.zk.ui.HtmlBasedComponent parent, java.util.Map<java.lang.String,? extends java.lang.Object> params)
protected void	injectReference(TypedObject referenceValue, org.zkoss.zk.ui.HtmlBasedComponent parent, java.util.List<org.zkoss.zk.ui.HtmlBasedComponent> captionComponents)
boolean	isAddEnabled()
boolean	isAutoPersist()
boolean	isCreateEnabled()
protected boolean	isGeneralEmpty()
boolean	isGroupCollections()
boolean	isHideEmpty()
boolean	isHideReadOnly()
protected void	loadMissingValues(java.util.Map<java.lang.String,? extends java.lang.Object> params)	Method checks whether we would display indirect property - if so then we have to refresh current ObjectValueContainer and load this property there.
protected void	openCreateNewReferenceWizard(org.zkoss.zk.ui.Component parent, ObjectTemplate template, TypedObject item, PropertyDescriptor propertyDescriptor, WizardConfiguration wizardConfiguration)
void	setAddEnabled(boolean addEnabled)
void	setAutoPersist(boolean autoPersist)
void	setConfig(ContentEditorConfiguration config)
void	setCreateEnabled(boolean createEnabled)
void	setGroupCollections(boolean groupCollections)
void	setHideEmpty(boolean hideEmpty)
void	setHideReadOnly(boolean hideReadOnly)
void	setItem(TypedObject item)
void	setLocationInfoObject(java.lang.Object locationInfoObject)
void	setPropertyInjector(PropertyInjector propertyInjector)
void	setReferenceInjector(ReferenceInjector referenceInjector)
void	setRootComponent(org.zkoss.zk.ui.HtmlBasedComponent rootComponent)
protected void	setValue(PropertyDescriptor propDescr, java.lang.Object value)
protected void	setValue(PropertyDescriptor propDescr, java.lang.Object value, boolean persist)
protected void	setValue(PropertyDescriptor propDescr, java.lang.Object value, boolean persist, java.lang.Object eventSource)
void	setValueContainer(ObjectValueContainer valueContainer)

Methods inherited from class java.lang.Object

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

Field Detail

WIZARD_CONFIG

protected static final java.lang.String WIZARD_CONFIG

See Also:

Constant Field Values

EDITOR_ENTRY_READ_ONLY

protected static final java.lang.String EDITOR_ENTRY_READ_ONLY

See Also:

Constant Field Values

ADD_BTN_URL

protected static final java.lang.String ADD_BTN_URL

See Also:

Constant Field Values

CREATE_MODE_PARAM

protected static final java.lang.String CREATE_MODE_PARAM

See Also:

Constant Field Values

SELECT_MODE_PARAM

protected static final java.lang.String SELECT_MODE_PARAM

See Also:

Constant Field Values

SKIP_CUSTOM_EDITOR_PARAM

protected static final java.lang.String SKIP_CUSTOM_EDITOR_PARAM

See Also:

Constant Field Values

Constructor Detail

CMSContentEditorInjector

public CMSContentEditorInjector()

Method Detail

setConfig

public void setConfig(ContentEditorConfiguration config)

setItem

public void setItem(TypedObject item)

getItem

public TypedObject getItem()

setValueContainer

public void setValueContainer(ObjectValueContainer valueContainer)

getValueContainer

public ObjectValueContainer getValueContainer()

setAutoPersist

public void setAutoPersist(boolean autoPersist)

isAutoPersist

public boolean isAutoPersist()

setGroupCollections

public void setGroupCollections(boolean groupCollections)

isGroupCollections

public boolean isGroupCollections()

setHideReadOnly

public void setHideReadOnly(boolean hideReadOnly)

isHideReadOnly

public boolean isHideReadOnly()

setHideEmpty

public void setHideEmpty(boolean hideEmpty)

isHideEmpty

public boolean isHideEmpty()

isAddEnabled

public boolean isAddEnabled()

setAddEnabled

public void setAddEnabled(boolean addEnabled)

isCreateEnabled

public boolean isCreateEnabled()

setCreateEnabled

public void setCreateEnabled(boolean createEnabled)

getRootComponent

public org.zkoss.zk.ui.HtmlBasedComponent getRootComponent()

setRootComponent

public void setRootComponent(org.zkoss.zk.ui.HtmlBasedComponent rootComponent)

injectComponent

public void injectComponent(org.zkoss.zk.ui.HtmlBasedComponent parent,
                            java.util.Map<java.lang.String,? extends java.lang.Object> params)

Specified by:

injectComponent in interface ComponentInjector

injectGeneralGroup

protected void injectGeneralGroup(org.zkoss.zk.ui.HtmlBasedComponent parent,
                                  java.util.Map<java.lang.String,? extends java.lang.Object> params)

isGeneralEmpty

protected boolean isGeneralEmpty()

injectProperty

protected void injectProperty(org.zkoss.zk.ui.HtmlBasedComponent parent,
                              java.util.Map<java.lang.String,? extends java.lang.Object> params)

injectList

protected void injectList(org.zkoss.zk.ui.HtmlBasedComponent parent,
                          java.util.Map<java.lang.String,? extends java.lang.Object> params)

openCreateNewReferenceWizard

protected void openCreateNewReferenceWizard(org.zkoss.zk.ui.Component parent,
                                            ObjectTemplate template,
                                            TypedObject item,
                                            PropertyDescriptor propertyDescriptor,
                                            WizardConfiguration wizardConfiguration)

injectReference

protected void injectReference(TypedObject referenceValue,
                               org.zkoss.zk.ui.HtmlBasedComponent parent,
                               java.util.List<org.zkoss.zk.ui.HtmlBasedComponent> captionComponents)

getValue

protected java.lang.Object getValue(PropertyDescriptor propDescr)

getValue

protected java.lang.Object getValue(PropertyDescriptor propDescr,
                                    ObjectValueContainer valueContainer)

setValue

protected void setValue(PropertyDescriptor propDescr,
                        java.lang.Object value)
                 throws ValueHandlerException

Throws:

ValueHandlerException

setValue

protected void setValue(PropertyDescriptor propDescr,
                        java.lang.Object value,
                        boolean persist)
                 throws ValueHandlerException

Throws:

ValueHandlerException

setValue

protected void setValue(PropertyDescriptor propDescr,
                        java.lang.Object value,
                        boolean persist,
                        java.lang.Object eventSource)
                 throws ValueHandlerException

Throws:

ValueHandlerException

getTypeService

protected TypeService getTypeService()

getUiAccessRightService

protected UIAccessRightService getUiAccessRightService()

getCMSAdminComponentService

protected CMSAdminComponentService getCMSAdminComponentService()

getCmsAdminPerspective

public CMSAdminSiteService getCmsAdminPerspective()

setLocationInfoObject

public void setLocationInfoObject(java.lang.Object locationInfoObject)

getLocationInfoObject

public java.lang.Object getLocationInfoObject()

getConfigurationService

public UIConfigurationService getConfigurationService()

getPropertyListComparator

protected java.util.Comparator<PropertyDescriptor> getPropertyListComparator()

setReferenceInjector

public void setReferenceInjector(ReferenceInjector referenceInjector)

getReferenceInjector

public ReferenceInjector getReferenceInjector()

getConfig

public ContentEditorConfiguration getConfig()

setPropertyInjector

public void setPropertyInjector(PropertyInjector propertyInjector)

getPropertyInjector

public PropertyInjector getPropertyInjector()

loadMissingValues

protected void loadMissingValues(java.util.Map<java.lang.String,? extends java.lang.Object> params)

Method checks whether we would display indirect property - if so then we have to refresh current ObjectValueContainer and load this property there.

Note:
When we would display e.g. BannerComponent.page.label - we have to check whether this property possess corresponding ObjectValueHandler within current ObjectValueContainer if no we have to load it.

Parameters:

params - current creation parameter

See Also:

ObjectValueContainer

getLoadLanguages

protected java.util.Set<java.lang.String> getLoadLanguages()

getValueService

public ValueService getValueService()