Package com.hybris.backoffice.widgets.advancedsearch.impl.renderer

Class AdvancedSearchRenderer

java.lang.Object

com.hybris.backoffice.widgets.advancedsearch.impl.renderer.AdvancedSearchRenderer

public class AdvancedSearchRenderer
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AdvancedSearchRenderer.SearchConditionRenderer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ADD_ROW_POSITION
static java.lang.String	BOTTOM
static java.lang.String	DISABLE_ATTRIBUTES_COMPARATOR
static java.lang.String	DISABLE_SORT_ORDER
static java.lang.String	IS_NESTED_OBJECT_CREATION_DISABLED_SETTING
static java.lang.String	RADIO_SORT_ORDER_ASC_ATTR
static java.lang.String	SCLASS_EDITOR
static java.lang.String	SCLASS_EDITOR_MANDATORY_STYLE
static java.lang.String	SORT_ORDER_COLUMN_ID
static java.lang.String	TOP
static java.lang.String	YW_ADVANCED_SEARCH_ASC
static java.lang.String	YW_ADVANCED_SEARCH_DESC
static java.lang.String	YW_ADVANCED_SEARCH_LAST_ROW_FOR_CONDITION
static java.lang.String	YW_ADVANCED_SEARCH_LINE
static java.lang.String	YW_ADVANCED_SEARCH_LOCALIZED
static java.lang.String	YW_ADVANCED_SEARCH_OPERATOR
static java.lang.String	YW_ADVANCED_SEARCH_ROWSPAN
static java.lang.String	YW_ADVANCED_SEARCH_SORTORDER_DIV

Constructor Summary

Constructors

Constructor	Description
AdvancedSearchRenderer(TypeFacade typeFacade, LabelService labelService, AdvancedSearchOperatorService advancedSearchOperatorService, PermissionFacade permissionFacade, CockpitLocaleService cockpitLocaleService)
AdvancedSearchRenderer(TypeFacade typeFacade, LabelService labelService, WidgetInstanceManager widgetInstanceManager, AdvancedSearchOperatorService advancedSearchOperatorService, PermissionFacade permissionFacade, CockpitLocaleService cockpitLocaleService)
AdvancedSearchRenderer(TypeFacade typeFacade, LabelService labelService, WidgetInstanceManager widgetInstanceManager, AdvancedSearchOperatorService advancedSearchOperatorService, PermissionFacade permissionFacade, CockpitLocaleService cockpitLocaleService, java.util.function.Consumer<org.zkoss.zk.ui.event.Event> editorsEventConsumer)

Method Summary

Modifier and Type	Method	Description
protected void	addEnterSupport(org.zkoss.zk.ui.Component component)
protected void	addTypeSelectorBandboxEventListeners(org.zkoss.zul.Bandbox typeSelectorBandbox, org.zkoss.zul.Tree typeSelector, TypeSelectorTreeModel model)
protected void	adjustEditor(SearchAttributeDescriptor searchAttributeDescriptor, ValueComparisonOperator valueComparisonOperator, FieldType fileldType)
protected void	adjustSearchDataModel(SearchAttributeDescriptor searchAttributeDescriptor, ValueComparisonOperator valueComparisonOperator)
void	adjustSortOrderColumnVisibility(org.zkoss.zul.Column sortOrder, AdvancedSearchData advancedSearch)
protected void	applyReferenceAdvancedSearch(Editor editor)	Uses AbstractReferenceEditor.PARAM_REFERENCE_ADVANCED_SEARCH_ENABLED from the widget's settings.
protected void	assignEditorToField(SearchAttributeDescriptor searchAttributeDescriptor, Editor editor)
protected void	changeTypeSelectorModel(TypeSelectorTreeModel model, org.zkoss.zul.Tree typeSelector, java.lang.String filter)
protected org.zkoss.zul.RowRenderer<SearchConditionData>	createConditionRowRenderer(org.zkoss.zul.Grid container, org.zkoss.zul.Radiogroup sortControlCnt, AdvancedSearch configuration, DataType dataType, org.zkoss.zul.Column sortOrderColumn)
protected Editor	createEditor(FieldType field, int rowIndex, SearchConditionData data)
protected Editor	createEditor(FieldType field, int rowIndex, SearchConditionData data, boolean isEditorInAddAttributeRow)
protected org.zkoss.zul.Div	createSortControls(org.zkoss.zul.Radiogroup radiogroup, SearchConditionData data, SortData sortData)
protected TypeSelectorTreeModel	createTypeSelectorTreeModel(DataType rootType, TypeFacade typeFacade, PermissionFacade permissionFacade, boolean hideTypesWithoutClazz)
protected void	disableDblClickOnReferenceEditor(Editor editor)
protected SortData	extractSortData(AdvancedSearch configuration)
java.lang.String	getAddRowPosition()
protected java.lang.String	getAttributeLabel(java.lang.String qualifier)
protected CockpitLocaleService	getCockpitLocaleService()
protected DataAttribute	getDataAttribute(FieldType field)
protected DataType	getDataType()
protected Editor	getEditorForField(SearchAttributeDescriptor searchAttributeDescriptor)
java.util.Map<SearchAttributeDescriptor,Editor>	getFieldEditors()
protected DataType	getInitialDataType()
protected PermissionFacade	getPermissionFacade()
protected AdvancedSearchData	getSearchDataFromModel()
TypeFacade	getTypeFacade()
WidgetInstanceManager	getWidgetInstanceManager()
protected void	handleTypeSelectorBandboxOnBlur(org.zkoss.zk.ui.event.Event event, org.zkoss.zul.Bandbox typeSelectorBandbox, TypeSelectorTreeModel model, org.zkoss.zul.Tree typeSelector)
protected void	handleTypeSelectorBandboxOnChanging(org.zkoss.zk.ui.event.Event event, org.zkoss.zul.Bandbox typeSelectorBandbox, TypeSelectorTreeModel model, org.zkoss.zul.Tree typeSelector)
protected void	handleTypeSelectorBandboxOnFocus(org.zkoss.zk.ui.event.Event event, org.zkoss.zul.Bandbox typeSelectorBandbox, TypeSelectorTreeModel model, org.zkoss.zul.Tree typeSelector)
protected boolean	hideTypesWithoutClazz()
protected boolean	isNullable(DataAttribute attribute)
protected boolean	isReferenceEditor(Editor editor)
protected boolean	isSortable(FieldType field)
protected boolean	isSortPanelEnabled()
protected boolean	isSortPanelsVisible(FieldType field)
void	markEmptyMandatoryField(java.lang.String fieldName)
protected java.util.Map<java.util.regex.Pattern,java.lang.String>	prepareAdvancedSearchEditorMappings()
org.zkoss.zul.ListModelList<SearchConditionData>	prepareGridModel()
void	rendererGlobalOperator(org.zkoss.zul.Combobox operatorSelector)
void	renderTypeSelector(org.zkoss.zul.Bandbox typeSelectorBandbox, org.zkoss.zul.Tree typeSelector, DataType rootType)
void	renderVisible(org.zkoss.zul.Grid container, org.zkoss.zul.Radiogroup sortControlCnt, Actions actionSlot, AdvancedSearch configuration, DataType dataType)
protected java.lang.String	resolveEditorType(DataAttribute genericAttribute)
void	setEditorsEventConsumer(java.util.function.Consumer<org.zkoss.zk.ui.event.Event> editorsEventConsumer)
void	setWidgetInstanceManager(WidgetInstanceManager widgetInstanceManager)
void	unmarkMandatoryField(java.lang.String fieldName)
protected void	updateLocalizedEditorValueOnLanguageSelected(Editor editor, java.lang.Object eventData, AdvancedSearchData searchData, int rowIndex)
protected void	updateSearchDataForLocalizedValue(AdvancedSearchData searchData, int rowIndex, java.lang.Object editorsValue)

Methods inherited from class java.lang.Object

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

Field Detail

RADIO_SORT_ORDER_ASC_ATTR

public static final java.lang.String RADIO_SORT_ORDER_ASC_ATTR

See Also:

Constant Field Values

TOP

public static final java.lang.String TOP

See Also:

Constant Field Values

BOTTOM

public static final java.lang.String BOTTOM

See Also:

Constant Field Values

ADD_ROW_POSITION

public static final java.lang.String ADD_ROW_POSITION

See Also:

Constant Field Values

YW_ADVANCED_SEARCH_LOCALIZED

public static final java.lang.String YW_ADVANCED_SEARCH_LOCALIZED

See Also:

Constant Field Values

YW_ADVANCED_SEARCH_ASC

public static final java.lang.String YW_ADVANCED_SEARCH_ASC

See Also:

Constant Field Values

YW_ADVANCED_SEARCH_DESC

public static final java.lang.String YW_ADVANCED_SEARCH_DESC

See Also:

Constant Field Values

YW_ADVANCED_SEARCH_LINE

public static final java.lang.String YW_ADVANCED_SEARCH_LINE

See Also:

Constant Field Values

YW_ADVANCED_SEARCH_LAST_ROW_FOR_CONDITION

public static final java.lang.String YW_ADVANCED_SEARCH_LAST_ROW_FOR_CONDITION

See Also:

Constant Field Values

YW_ADVANCED_SEARCH_ROWSPAN

public static final java.lang.String YW_ADVANCED_SEARCH_ROWSPAN

See Also:

Constant Field Values

YW_ADVANCED_SEARCH_OPERATOR

public static final java.lang.String YW_ADVANCED_SEARCH_OPERATOR

See Also:

Constant Field Values

YW_ADVANCED_SEARCH_SORTORDER_DIV

public static final java.lang.String YW_ADVANCED_SEARCH_SORTORDER_DIV

See Also:

Constant Field Values

IS_NESTED_OBJECT_CREATION_DISABLED_SETTING

public static final java.lang.String IS_NESTED_OBJECT_CREATION_DISABLED_SETTING

See Also:

Constant Field Values

DISABLE_ATTRIBUTES_COMPARATOR

public static final java.lang.String DISABLE_ATTRIBUTES_COMPARATOR

See Also:

Constant Field Values

SCLASS_EDITOR_MANDATORY_STYLE

public static final java.lang.String SCLASS_EDITOR_MANDATORY_STYLE

See Also:

Constant Field Values

DISABLE_SORT_ORDER

public static final java.lang.String DISABLE_SORT_ORDER

See Also:

Constant Field Values

SORT_ORDER_COLUMN_ID

public static final java.lang.String SORT_ORDER_COLUMN_ID

See Also:

Constant Field Values

SCLASS_EDITOR

public static final java.lang.String SCLASS_EDITOR

See Also:

Constant Field Values

Constructor Detail

AdvancedSearchRenderer

public AdvancedSearchRenderer(TypeFacade typeFacade,
                              LabelService labelService,
                              AdvancedSearchOperatorService advancedSearchOperatorService,
                              PermissionFacade permissionFacade,
                              CockpitLocaleService cockpitLocaleService)

AdvancedSearchRenderer

public AdvancedSearchRenderer(TypeFacade typeFacade,
                              LabelService labelService,
                              WidgetInstanceManager widgetInstanceManager,
                              AdvancedSearchOperatorService advancedSearchOperatorService,
                              PermissionFacade permissionFacade,
                              CockpitLocaleService cockpitLocaleService)

AdvancedSearchRenderer

public AdvancedSearchRenderer(TypeFacade typeFacade,
                              LabelService labelService,
                              WidgetInstanceManager widgetInstanceManager,
                              AdvancedSearchOperatorService advancedSearchOperatorService,
                              PermissionFacade permissionFacade,
                              CockpitLocaleService cockpitLocaleService,
                              java.util.function.Consumer<org.zkoss.zk.ui.event.Event> editorsEventConsumer)

Parameters:

editorsEventConsumer - consumes an event when an enter is pressed in a search/comparator field. When the consumer is not passed support there is no enter support for search fields.

Method Detail

extractSortData

protected SortData extractSortData(AdvancedSearch configuration)

renderVisible

public void renderVisible(org.zkoss.zul.Grid container,
                          org.zkoss.zul.Radiogroup sortControlCnt,
                          Actions actionSlot,
                          AdvancedSearch configuration,
                          DataType dataType)

createConditionRowRenderer

protected org.zkoss.zul.RowRenderer<SearchConditionData> createConditionRowRenderer(org.zkoss.zul.Grid container,
                                                                                    org.zkoss.zul.Radiogroup sortControlCnt,
                                                                                    AdvancedSearch configuration,
                                                                                    DataType dataType,
                                                                                    org.zkoss.zul.Column sortOrderColumn)

getDataType

protected DataType getDataType()

getInitialDataType

protected DataType getInitialDataType()

prepareGridModel

public org.zkoss.zul.ListModelList<SearchConditionData> prepareGridModel()

getAddRowPosition

public java.lang.String getAddRowPosition()

createSortControls

protected org.zkoss.zul.Div createSortControls(org.zkoss.zul.Radiogroup radiogroup,
                                               SearchConditionData data,
                                               SortData sortData)

isSortPanelsVisible

protected boolean isSortPanelsVisible(FieldType field)

isSortPanelEnabled

protected boolean isSortPanelEnabled()

isSortable

protected boolean isSortable(FieldType field)

createEditor

protected Editor createEditor(FieldType field,
                              int rowIndex,
                              SearchConditionData data)

createEditor

protected Editor createEditor(FieldType field,
                              int rowIndex,
                              SearchConditionData data,
                              boolean isEditorInAddAttributeRow)

getDataAttribute

protected DataAttribute getDataAttribute(FieldType field)

updateSearchDataForLocalizedValue

protected void updateSearchDataForLocalizedValue(AdvancedSearchData searchData,
                                                 int rowIndex,
                                                 java.lang.Object editorsValue)

updateLocalizedEditorValueOnLanguageSelected

protected void updateLocalizedEditorValueOnLanguageSelected(Editor editor,
                                                            java.lang.Object eventData,
                                                            AdvancedSearchData searchData,
                                                            int rowIndex)

addEnterSupport

protected void addEnterSupport(org.zkoss.zk.ui.Component component)

isReferenceEditor

protected boolean isReferenceEditor(Editor editor)

disableDblClickOnReferenceEditor

protected void disableDblClickOnReferenceEditor(Editor editor)

applyReferenceAdvancedSearch

protected void applyReferenceAdvancedSearch(Editor editor)

Uses AbstractReferenceEditor.PARAM_REFERENCE_ADVANCED_SEARCH_ENABLED from the widget's settings.

prepareAdvancedSearchEditorMappings

protected java.util.Map<java.util.regex.Pattern,java.lang.String> prepareAdvancedSearchEditorMappings()

resolveEditorType

protected java.lang.String resolveEditorType(DataAttribute genericAttribute)

renderTypeSelector

public void renderTypeSelector(org.zkoss.zul.Bandbox typeSelectorBandbox,
                               org.zkoss.zul.Tree typeSelector,
                               DataType rootType)

createTypeSelectorTreeModel

protected TypeSelectorTreeModel createTypeSelectorTreeModel(DataType rootType,
                                                            TypeFacade typeFacade,
                                                            PermissionFacade permissionFacade,
                                                            boolean hideTypesWithoutClazz)

hideTypesWithoutClazz

protected boolean hideTypesWithoutClazz()

addTypeSelectorBandboxEventListeners

protected void addTypeSelectorBandboxEventListeners(org.zkoss.zul.Bandbox typeSelectorBandbox,
                                                    org.zkoss.zul.Tree typeSelector,
                                                    TypeSelectorTreeModel model)

handleTypeSelectorBandboxOnChanging

protected void handleTypeSelectorBandboxOnChanging(org.zkoss.zk.ui.event.Event event,
                                                   org.zkoss.zul.Bandbox typeSelectorBandbox,
                                                   TypeSelectorTreeModel model,
                                                   org.zkoss.zul.Tree typeSelector)

handleTypeSelectorBandboxOnBlur

protected void handleTypeSelectorBandboxOnBlur(org.zkoss.zk.ui.event.Event event,
                                               org.zkoss.zul.Bandbox typeSelectorBandbox,
                                               TypeSelectorTreeModel model,
                                               org.zkoss.zul.Tree typeSelector)

changeTypeSelectorModel

protected void changeTypeSelectorModel(TypeSelectorTreeModel model,
                                       org.zkoss.zul.Tree typeSelector,
                                       java.lang.String filter)

handleTypeSelectorBandboxOnFocus

protected void handleTypeSelectorBandboxOnFocus(org.zkoss.zk.ui.event.Event event,
                                                org.zkoss.zul.Bandbox typeSelectorBandbox,
                                                TypeSelectorTreeModel model,
                                                org.zkoss.zul.Tree typeSelector)

getAttributeLabel

protected java.lang.String getAttributeLabel(java.lang.String qualifier)

rendererGlobalOperator

public void rendererGlobalOperator(org.zkoss.zul.Combobox operatorSelector)

getSearchDataFromModel

protected AdvancedSearchData getSearchDataFromModel()

isNullable

protected boolean isNullable(DataAttribute attribute)

adjustEditor

protected void adjustEditor(SearchAttributeDescriptor searchAttributeDescriptor,
                            ValueComparisonOperator valueComparisonOperator,
                            FieldType fileldType)

adjustSearchDataModel

protected void adjustSearchDataModel(SearchAttributeDescriptor searchAttributeDescriptor,
                                     ValueComparisonOperator valueComparisonOperator)

assignEditorToField

protected void assignEditorToField(SearchAttributeDescriptor searchAttributeDescriptor,
                                   Editor editor)

getEditorForField

protected Editor getEditorForField(SearchAttributeDescriptor searchAttributeDescriptor)

getCockpitLocaleService

protected CockpitLocaleService getCockpitLocaleService()

markEmptyMandatoryField

public void markEmptyMandatoryField(java.lang.String fieldName)

unmarkMandatoryField

public void unmarkMandatoryField(java.lang.String fieldName)

adjustSortOrderColumnVisibility

public void adjustSortOrderColumnVisibility(org.zkoss.zul.Column sortOrder,
                                            AdvancedSearchData advancedSearch)

setEditorsEventConsumer

public void setEditorsEventConsumer(java.util.function.Consumer<org.zkoss.zk.ui.event.Event> editorsEventConsumer)

getWidgetInstanceManager

public WidgetInstanceManager getWidgetInstanceManager()

setWidgetInstanceManager

public void setWidgetInstanceManager(WidgetInstanceManager widgetInstanceManager)

getFieldEditors

public java.util.Map<SearchAttributeDescriptor,Editor> getFieldEditors()

getTypeFacade

public TypeFacade getTypeFacade()

getPermissionFacade

protected PermissionFacade getPermissionFacade()