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

Class ExcelExportRenderer

java.lang.Object

DefaultCustomViewRenderer

com.hybris.backoffice.renderer.attributeschooser.AbstractAttributesExportRenderer<AttributeDescriptorModel>

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

public class ExcelExportRenderer
extends AbstractAttributesExportRenderer<AttributeDescriptorModel>

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
• - 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 Deprecated. since 1808 use AbstractAttributesExportRenderer.PARAM_INCLUDE_ALL_SUPPORTED

Fields inherited from class com.hybris.backoffice.renderer.attributeschooser.AbstractAttributesExportRenderer

attributesChooserRenderer, cockpitLocaleService, notificationService, PARAM_INCLUDE_ALL_SUPPORTED, permissionFacade

Constructor Summary

Constructors

Constructor and Description
ExcelExportRenderer()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createAttributeName(AttributeDescriptorModel attrDesc)
protected java.lang.String	createAttributeQualifier(AttributeDescriptorModel attrDesc)
<any>	getAttributeChooserRenderer() Deprecated. since 6.7 no longer used - please see AbstractAttributesExportRenderer.getAttributesChooserRenderer() (WidgetComponentRenderer)}
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)
ExcelFilter<AttributeDescriptorModel>	getRequiredFilters()
protected java.util.Set<AttributeDescriptorModel>	getSupportedAttributes(java.lang.String dataType)
ExcelFilter<AttributeDescriptorModel>	getSupportedFilters()
TypeService	getTypeService()
protected boolean	isLocalized(AttributeDescriptorModel attr)
protected boolean	isRequired(AttributeDescriptorModel attributeDescriptor) Deprecated. since 1808. Not used anymore, it is replaced by ExcelFilter
protected boolean	isSupported(java.lang.String dataType, AttributeDescriptorModel attr) Deprecated. since 1808. Not used anymore, it is replaced by ExcelFilter
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	setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)
void	setLabelService(LabelService labelService)
void	setRequiredFilters(ExcelFilter<AttributeDescriptorModel> requiredFilters)
void	setSupportedFilters(ExcelFilter<AttributeDescriptorModel> supportedFilters)
void	setTypeService(TypeService typeService)

Methods inherited from class com.hybris.backoffice.renderer.attributeschooser.AbstractAttributesExportRenderer

createAttributesChooserConfig, createAttributeWithLocalizedChildren, getAttributesChooserRenderer, getCockpitLocaleService, getNotificationService, getPermissionFacade, getSupportedLanguages, setAttributesChooserRenderer, setCockpitLocaleService, setNotificationService, setPermissionFacade

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_EXCEL_INCLUDE_ALL_SUPPORTED

@Deprecated
public static final java.lang.String PARAM_EXCEL_INCLUDE_ALL_SUPPORTED

Deprecated. since 1808 use AbstractAttributesExportRenderer.PARAM_INCLUDE_ALL_SUPPORTED

See Also:

Constant Field Values

PARAM_EXCEL_EXPORT_FORM_MODEL_KEY

public static final java.lang.String PARAM_EXCEL_EXPORT_FORM_MODEL_KEY

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)

getSupportedAttributes

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

isSupported

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

Deprecated. since 1808. Not used anymore, it is replaced by ExcelFilter

createAttributeQualifier

protected java.lang.String createAttributeQualifier(AttributeDescriptorModel attrDesc)

Specified by:

createAttributeQualifier in class AbstractAttributesExportRenderer<AttributeDescriptorModel>

createAttributeName

protected java.lang.String createAttributeName(AttributeDescriptorModel attrDesc)

Specified by:

createAttributeName in class AbstractAttributesExportRenderer<AttributeDescriptorModel>

isLocalized

protected boolean isLocalized(AttributeDescriptorModel attr)

Specified by:

isLocalized in class AbstractAttributesExportRenderer<AttributeDescriptorModel>

isRequired

@Deprecated
protected boolean isRequired(AttributeDescriptorModel attributeDescriptor)

Deprecated. since 1808. Not used anymore, it is replaced by ExcelFilter

getLocalizedAttributeName

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

getExcelExportForm

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

getRequiredFilters

public ExcelFilter<AttributeDescriptorModel> getRequiredFilters()

setRequiredFilters

public void setRequiredFilters(ExcelFilter<AttributeDescriptorModel> requiredFilters)

getSupportedFilters

public ExcelFilter<AttributeDescriptorModel> getSupportedFilters()

setSupportedFilters

public void setSupportedFilters(ExcelFilter<AttributeDescriptorModel> supportedFilters)

getLabelService

public LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getExcelTranslatorRegistry

public ExcelTranslatorRegistry getExcelTranslatorRegistry()

setExcelTranslatorRegistry

public void setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)

getAttributeChooserRenderer

@Deprecated
public <any> getAttributeChooserRenderer()

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

setAttributeChooserRenderer

@Deprecated
public void setAttributeChooserRenderer(<any> attributeChooserRenderer)

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