Package de.hybris.platform.cmsfacades.types.populator

Class CMSItemDropdownComponentTypeAttributePopulator

java.lang.Object

de.hybris.platform.cmsfacades.types.populator.CMSItemDropdownComponentTypeAttributePopulator

All Implemented Interfaces:

Populator<AttributeDescriptorModel,ComponentTypeAttributeData>

Direct Known Subclasses:

CMSNavigationEntryItemPopulator

public class CMSItemDropdownComponentTypeAttributePopulator
extends java.lang.Object
implements Populator<AttributeDescriptorModel,ComponentTypeAttributeData>

Populator aimed at setting all necessary information for the receiving end to build a cms item dropdown widget:

• identifies the cmsStructureType as CMS_ITEM_DROPDOWN
• marks the dropdown to use ID_ATTRIBUTE as idAttribute

Constructor Summary

Constructors

Constructor	Description
CMSItemDropdownComponentTypeAttributePopulator()

Method Summary

Modifier and Type	Method	Description
protected AttributeDescriptorModelHelperService	getAttributeDescriptorModelHelperService()
protected java.util.Map<java.lang.String,java.lang.String>	getComponentParams(java.lang.Class<?> type, ComponentTypeAttributeData target)
protected java.util.Map<java.lang.String,java.lang.String>	getComponentSubTypes(java.lang.Class<?> type)	This method retrieves a map of concrete subtypes of the provided type.
protected org.springframework.beans.factory.ObjectFactory<ComponentTypeData>	getComponentTypeDataFactory()
protected java.lang.String	getComponentTypeI18nKey(ComposedTypeModel typeModel)	This method retrieves the i18n key of the provided component type.
protected I18nComponentTypePopulator	getI18nComponentTypePopulator()
protected java.lang.String	getPlaceholder()
protected java.lang.String	getSearchParams()
protected TypeService	getTypeService()
void	populate(AttributeDescriptorModel source, ComponentTypeAttributeData target)	Populate the target instance with values from the source instance.
void	setAttributeDescriptorModelHelperService(AttributeDescriptorModelHelperService attributeDescriptorModelHelperService)
void	setComponentTypeDataFactory(org.springframework.beans.factory.ObjectFactory<ComponentTypeData> componentTypeDataFactory)
void	setI18nComponentTypePopulator(I18nComponentTypePopulator i18nComponentTypePopulator)
protected void	setPlaceholder(ComponentTypeAttributeData target)	Sets placeholder for a dropdown if it's not empty.
void	setPlaceholder(java.lang.String placeholder)
void	setSearchParams(java.lang.String searchParams)	If searchParams is set, the value will be added to the "params" map for the "itemSearchParams" key.
void	setTypeService(TypeService typeService)

Methods inherited from class java.lang.Object

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

Constructor Detail

CMSItemDropdownComponentTypeAttributePopulator

public CMSItemDropdownComponentTypeAttributePopulator()

Method Detail

populate

public void populate(AttributeDescriptorModel source,
                     ComponentTypeAttributeData target)
              throws ConversionException

Description copied from interface: Populator

Populate the target instance with values from the source instance.

Specified by:

populate in interface Populator<AttributeDescriptorModel,ComponentTypeAttributeData>

Parameters:

source - the source object

target - the target to fill

Throws:

ConversionException - if an error occurs

setPlaceholder

protected void setPlaceholder(ComponentTypeAttributeData target)

Sets placeholder for a dropdown if it's not empty.

Parameters:

target - the ComponentTypeAttributeData

getComponentParams

protected java.util.Map<java.lang.String,java.lang.String> getComponentParams(java.lang.Class<?> type,
                                                                                    ComponentTypeAttributeData target)

getComponentSubTypes

protected java.util.Map<java.lang.String,java.lang.String> getComponentSubTypes(java.lang.Class<?> type)

This method retrieves a map of concrete subtypes of the provided type. (If the provided type is concrete it will also be included in the map).

Parameters:

type - The type for which to retrieve its map of subtypes.

Returns:

map Map of concrete component subtypes. The key is the code of the sub-type and the value is its i18n key.

getComponentTypeI18nKey

protected java.lang.String getComponentTypeI18nKey(ComposedTypeModel typeModel)

This method retrieves the i18n key of the provided component type.

Parameters:

typeModel - The type for which to retrieve its map of subtypes.

Returns:

String The i18n key of the provided component type.

setAttributeDescriptorModelHelperService

public void setAttributeDescriptorModelHelperService(AttributeDescriptorModelHelperService attributeDescriptorModelHelperService)

getAttributeDescriptorModelHelperService

protected AttributeDescriptorModelHelperService getAttributeDescriptorModelHelperService()

setTypeService

public void setTypeService(TypeService typeService)

getTypeService

protected TypeService getTypeService()

setI18nComponentTypePopulator

public void setI18nComponentTypePopulator(I18nComponentTypePopulator i18nComponentTypePopulator)

getI18nComponentTypePopulator

protected I18nComponentTypePopulator getI18nComponentTypePopulator()

setComponentTypeDataFactory

public void setComponentTypeDataFactory(org.springframework.beans.factory.ObjectFactory<ComponentTypeData> componentTypeDataFactory)

getComponentTypeDataFactory

protected org.springframework.beans.factory.ObjectFactory<ComponentTypeData> getComponentTypeDataFactory()

setSearchParams

public void setSearchParams(java.lang.String searchParams)

If searchParams is set, the value will be added to the "params" map for the "itemSearchParams" key. This is useful when the "itemSearchParams" query-parameter needs to be set when calling the CMS Item Search API. Example of usage of this setter:

 
 	<property name="searchParams" value="pageStatus:active" />
 
 

Parameters:

searchParams - the searchParams value

getSearchParams

protected java.lang.String getSearchParams()

getPlaceholder

protected java.lang.String getPlaceholder()

setPlaceholder

public void setPlaceholder(java.lang.String placeholder)