com.hybris.backoffice.excel.export.wizard.renderer

Class ExcelExportRenderer

java.lang.Object

DefaultCustomViewRenderer

com.hybris.backoffice.excel.export.wizard.renderer.ExcelExportRenderer

public class ExcelExportRenderer
extends DefaultCustomViewRenderer

Renders components that allow to pick a list of attributes to be exported to excel for given items.

Displays a list of all available attributes of an item (e.g. a Product), and a second list of selected attributes. Mandatory and unique attributes are selected by default. Params:

• "excelExportFormModelKey" - defines where in model excel export form is ExcelExportWizardForm - required
• "includeAllSupported" - defines if include all should be available

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_EXCEL_EXPORT_FORM_MODEL_KEY
static java.lang.String	PARAM_EXCEL_INCLUDE_ALL_SUPPORTED

Constructor Summary

Constructors

Constructor and Description
ExcelExportRenderer()

Method Summary

Modifier and Type	Method and Description
protected AttributesChooserConfig	createAttributesChooserConfig(WidgetInstanceManager wim, java.util.Map<java.lang.String,java.lang.String> params)
protected Attribute	createAttributeWithLocalizedChildren(AttributeDescriptorModel attrDesc, java.util.Set<java.lang.String> supportedLanguages, boolean mandatory)
<any>	getAttributeChooserRenderer() Deprecated. since 6.7 no longer used - please see getAttributesChooserRenderer() (WidgetComponentRenderer)}
<any>	getAttributesChooserRenderer()
CockpitLocaleService	getCockpitLocaleService()
protected ExcelExportWizardForm	getExcelExportForm(WidgetInstanceManager wim, java.util.Map<java.lang.String,java.lang.String> parameters)
ExcelTranslatorRegistry	getExcelTranslatorRegistry()
LabelService	getLabelService()
protected java.lang.String	getLocalizedAttributeName(java.lang.String dataType, java.lang.String attr)
NotificationService	getNotificationService()
PermissionFacade	getPermissionFacade()
protected java.util.Set<AttributeDescriptorModel>	getSupportedAttributes(java.lang.String dataType)
protected java.util.Set<java.lang.String>	getSupportedLanguages()
TypeService	getTypeService()
protected boolean	isLocalized(AttributeDescriptorModel attr)
boolean	isRequired(AttributeDescriptorModel attributeDescriptor)
protected boolean	isSupported(java.lang.String dataType, AttributeDescriptorModel attr)
protected void	populateAttributesChooserForm(AttributeChooserForm attributesForm, java.lang.String typeCode)
void	render(Component parent, ViewType customView, java.util.Map<java.lang.String,java.lang.String> params, DataType dataType, WidgetInstanceManager wim)
void	setAttributeChooserRenderer(<any> attributeChooserRenderer) Deprecated. since 6.7 no longer used - please see #setAttributesChooserRenderer(WidgetComponentRenderer)
void	setAttributesChooserRenderer(<any> attributesChooserRenderer)
void	setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)
void	setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)
void	setLabelService(LabelService labelService)
void	setNotificationService(NotificationService notificationService)
void	setPermissionFacade(PermissionFacade permissionFacade)
void	setTypeService(TypeService typeService)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_EXCEL_EXPORT_FORM_MODEL_KEY

public static final java.lang.String PARAM_EXCEL_EXPORT_FORM_MODEL_KEY

See Also:

Constant Field Values

PARAM_EXCEL_INCLUDE_ALL_SUPPORTED

public static final java.lang.String PARAM_EXCEL_INCLUDE_ALL_SUPPORTED

See Also:

Constant Field Values

Constructor Detail

ExcelExportRenderer

public ExcelExportRenderer()

Method Detail

render

public void render(Component parent,
                   ViewType customView,
                   java.util.Map<java.lang.String,java.lang.String> params,
                   DataType dataType,
                   WidgetInstanceManager wim)

populateAttributesChooserForm

protected void populateAttributesChooserForm(AttributeChooserForm attributesForm,
                                             java.lang.String typeCode)

createAttributeWithLocalizedChildren

protected Attribute createAttributeWithLocalizedChildren(AttributeDescriptorModel attrDesc,
                                                         java.util.Set<java.lang.String> supportedLanguages,
                                                         boolean mandatory)

getSupportedLanguages

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

isRequired

public boolean isRequired(AttributeDescriptorModel attributeDescriptor)

getSupportedAttributes

protected java.util.Set<AttributeDescriptorModel> getSupportedAttributes(java.lang.String dataType)

isSupported

protected boolean isSupported(java.lang.String dataType,
                              AttributeDescriptorModel attr)

getLocalizedAttributeName

protected java.lang.String getLocalizedAttributeName(java.lang.String dataType,
                                                     java.lang.String attr)

createAttributesChooserConfig

protected AttributesChooserConfig createAttributesChooserConfig(WidgetInstanceManager wim,
                                                                java.util.Map<java.lang.String,java.lang.String> params)

getExcelExportForm

protected ExcelExportWizardForm getExcelExportForm(WidgetInstanceManager wim,
                                                   java.util.Map<java.lang.String,java.lang.String> parameters)

isLocalized

protected boolean isLocalized(AttributeDescriptorModel attr)

getLabelService

public LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)

getPermissionFacade

public PermissionFacade getPermissionFacade()

setPermissionFacade

public void setPermissionFacade(PermissionFacade permissionFacade)

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getExcelTranslatorRegistry

public ExcelTranslatorRegistry getExcelTranslatorRegistry()

setExcelTranslatorRegistry

public void setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)

getCockpitLocaleService

public CockpitLocaleService getCockpitLocaleService()

setCockpitLocaleService

public void setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)

getAttributeChooserRenderer

@Deprecated
public <any> getAttributeChooserRenderer()

Deprecated. since 6.7 no longer used - please see getAttributesChooserRenderer() (WidgetComponentRenderer)}

setAttributeChooserRenderer

@Deprecated
public void setAttributeChooserRenderer(<any> attributeChooserRenderer)

Deprecated. since 6.7 no longer used - please see #setAttributesChooserRenderer(WidgetComponentRenderer)

getAttributesChooserRenderer

public <any> getAttributesChooserRenderer()

setAttributesChooserRenderer

public void setAttributesChooserRenderer(<any> attributesChooserRenderer)

getNotificationService

public NotificationService getNotificationService()

setNotificationService

public void setNotificationService(NotificationService notificationService)