Class ExcelExportRenderer
java.lang.Object
com.hybris.cockpitng.widgets.common.AbstractWidgetComponentRenderer<org.zkoss.zk.ui.Component,com.hybris.cockpitng.config.jaxb.wizard.ViewType,Map<String,String>>
com.hybris.cockpitng.widgets.configurableflow.renderer.DefaultCustomViewRenderer
com.hybris.backoffice.renderer.attributeschooser.AbstractAttributesExportRenderer<AttributeDescriptorModel>
com.hybris.backoffice.excel.export.wizard.renderer.ExcelExportRenderer
- All Implemented Interfaces:
com.hybris.cockpitng.widgets.common.NotifyingWidgetComponentRenderer<org.zkoss.zk.ui.Component,,com.hybris.cockpitng.config.jaxb.wizard.ViewType, Map<String, String>> com.hybris.cockpitng.widgets.common.WidgetComponentRenderer<org.zkoss.zk.ui.Component,com.hybris.cockpitng.config.jaxb.wizard.ViewType, Map<String, String>>
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
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final StringDeprecated, for removal: This API element is subject to removal in a future version.Fields inherited from class com.hybris.backoffice.renderer.attributeschooser.AbstractAttributesExportRenderer
attributesChooserRenderer, cockpitLocaleService, notificationService, PARAM_INCLUDE_ALL_SUPPORTED, permissionFacade -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected StringcreateAttributeName(AttributeDescriptorModel attrDesc) protected Stringcom.hybris.cockpitng.widgets.common.WidgetComponentRenderer<org.zkoss.zk.ui.Component,Object, AttributeChooserForm> Deprecated, for removal: This API element is subject to removal in a future version.since 6.7 no longer used - please seeAbstractAttributesExportRenderer.getAttributesChooserRenderer()(WidgetComponentRenderer)}protected ExcelExportWizardFormgetExcelExportForm(com.hybris.cockpitng.engine.WidgetInstanceManager wim, Map<String, String> parameters) com.hybris.cockpitng.labels.LabelServiceprotected StringgetLocalizedAttributeName(String dataType, String attr) protected Set<AttributeDescriptorModel>getSupportedAttributes(String dataType) protected booleanprotected booleanisRequired(AttributeDescriptorModel attributeDescriptor) Deprecated, for removal: This API element is subject to removal in a future version.since 1808.protected booleanisSupported(String dataType, AttributeDescriptorModel attr) Deprecated, for removal: This API element is subject to removal in a future version.since 1808.protected voidpopulateAttributesChooserForm(com.hybris.backoffice.attributechooser.AttributeChooserForm attributesForm, String typeCode) voidrender(org.zkoss.zk.ui.Component parent, com.hybris.cockpitng.config.jaxb.wizard.ViewType customView, Map<String, String> params, com.hybris.cockpitng.dataaccess.facades.type.DataType dataType, com.hybris.cockpitng.engine.WidgetInstanceManager wim) voidsetAttributeChooserRenderer(com.hybris.cockpitng.widgets.common.WidgetComponentRenderer<org.zkoss.zk.ui.Component, Object, AttributeChooserForm> attributeChooserRenderer) Deprecated, for removal: This API element is subject to removal in a future version.since 6.7 no longer used - please seeAbstractAttributesExportRenderer.setAttributesChooserRenderer(WidgetComponentRenderer)voidsetExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry) voidsetLabelService(com.hybris.cockpitng.labels.LabelService labelService) voidsetRequiredFilters(ExcelFilter<AttributeDescriptorModel> requiredFilters) voidsetSupportedFilters(ExcelFilter<AttributeDescriptorModel> supportedFilters) voidsetTypeService(TypeService typeService) Methods inherited from class com.hybris.backoffice.renderer.attributeschooser.AbstractAttributesExportRenderer
createAttributesChooserConfig, createAttributeWithLocalizedChildren, getAttributesChooserRenderer, getCockpitLocaleService, getNotificationService, getPermissionFacade, getSupportedLanguages, setAttributesChooserRenderer, setCockpitLocaleService, setNotificationService, setPermissionFacadeMethods inherited from class com.hybris.cockpitng.widgets.common.AbstractWidgetComponentRenderer
addRendererListener, fireComponentRendered, fireComponentRendered, fireComponentRendered, removeRendererListenerMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.hybris.cockpitng.widgets.common.WidgetComponentRenderer
render
-
Field Details
-
PARAM_EXCEL_INCLUDE_ALL_SUPPORTED
@Deprecated(since="1808", forRemoval=true) public static final String PARAM_EXCEL_INCLUDE_ALL_SUPPORTEDDeprecated, for removal: This API element is subject to removal in a future version.since 1808 useAbstractAttributesExportRenderer.PARAM_INCLUDE_ALL_SUPPORTED- See Also:
-
PARAM_EXCEL_EXPORT_FORM_MODEL_KEY
- See Also:
-
-
Constructor Details
-
ExcelExportRenderer
public ExcelExportRenderer()
-
-
Method Details
-
render
-
populateAttributesChooserForm
protected void populateAttributesChooserForm(com.hybris.backoffice.attributechooser.AttributeChooserForm attributesForm, String typeCode) -
getSupportedAttributes
-
isSupported
@Deprecated(since="1808", forRemoval=true) protected boolean isSupported(String dataType, AttributeDescriptorModel attr) Deprecated, for removal: This API element is subject to removal in a future version.since 1808. Not used anymore, it is replaced byExcelFilter -
createAttributeQualifier
- Specified by:
createAttributeQualifierin classAbstractAttributesExportRenderer<AttributeDescriptorModel>
-
createAttributeName
- Specified by:
createAttributeNamein classAbstractAttributesExportRenderer<AttributeDescriptorModel>
-
isLocalized
- Specified by:
isLocalizedin classAbstractAttributesExportRenderer<AttributeDescriptorModel>
-
isRequired
@Deprecated(since="1808", forRemoval=true) protected boolean isRequired(AttributeDescriptorModel attributeDescriptor) Deprecated, for removal: This API element is subject to removal in a future version.since 1808. Not used anymore, it is replaced byExcelFilter -
getLocalizedAttributeName
-
getExcelExportForm
protected ExcelExportWizardForm getExcelExportForm(com.hybris.cockpitng.engine.WidgetInstanceManager wim, Map<String, String> parameters) -
getRequiredFilters
-
setRequiredFilters
-
getSupportedFilters
-
setSupportedFilters
-
getLabelService
public com.hybris.cockpitng.labels.LabelService getLabelService() -
setLabelService
public void setLabelService(com.hybris.cockpitng.labels.LabelService labelService) -
getTypeService
-
setTypeService
-
getExcelTranslatorRegistry
-
setExcelTranslatorRegistry
-
getAttributeChooserRenderer
@Deprecated(since="6.7", forRemoval=true) public com.hybris.cockpitng.widgets.common.WidgetComponentRenderer<org.zkoss.zk.ui.Component,Object, getAttributeChooserRenderer()AttributeChooserForm> Deprecated, for removal: This API element is subject to removal in a future version.since 6.7 no longer used - please seeAbstractAttributesExportRenderer.getAttributesChooserRenderer()(WidgetComponentRenderer)} -
setAttributeChooserRenderer
@Deprecated(since="6.7", forRemoval=true) public void setAttributeChooserRenderer(com.hybris.cockpitng.widgets.common.WidgetComponentRenderer<org.zkoss.zk.ui.Component, Object, AttributeChooserForm> attributeChooserRenderer) Deprecated, for removal: This API element is subject to removal in a future version.since 6.7 no longer used - please seeAbstractAttributesExportRenderer.setAttributesChooserRenderer(WidgetComponentRenderer)
-
AbstractAttributesExportRenderer.PARAM_INCLUDE_ALL_SUPPORTED