de.hybris.commercesearchbackoffice.widgets.categorytree

Class CategoryTreeController

java.lang.Object

DefaultWidgetController

de.hybris.commercesearchbackoffice.widgets.common.impersonation.AbstractImpersonationController

de.hybris.commercesearchbackoffice.widgets.categorytree.CategoryTreeController

public class CategoryTreeController
extends AbstractImpersonationController

Controller for the category tree widget. It uses CatalogFacade for fetching CategoryHierarchyData.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CategoryTreeController.CategoryTreeRenderer Basic renderer class for tree used to display category tree, its based on CategoryTreeNode objects

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	MODEL_CURRENTCATEGORY
static java.lang.String	SOCKET_IN_CLEAR
static java.lang.String	SOCKET_IN_SITE
static java.lang.String	SOCKET_OUT_CATEGORY

Constructor Summary

Constructors

Constructor and Description
CategoryTreeController()

Method Summary

Modifier and Type	Method and Description
void	clearSelection() Clear all open categories and selection
protected CategoryData	createCategoryDataFromCategory(Category category) Constructs CategoryData instance from a Category widget instance.
protected void	expandNode(<any> mainTreeNode, int depth)
protected CategoryTreeNode[]	generateTree(CategoryHierarchyData data) Simple helper method for translating CategoryHierarchyData based tree into CategoryTreeNode tree
AdvancedCategoryTreeModel	getCategoryTreeModel()
protected void	getData(SiteData siteData) Method for obtaining data for selected site
void	handleNewSite(SiteData newSiteData) New event is detected, new site is selected
protected boolean	hasCatalogVersionChanged(SiteData siteData, SiteData newSiteData)
void	initialize(Component comp) Initializes the widget controller with the root category of the current catalog version.
protected void	selectCategory(CategoryData categoryData) Selects given category in the category tree.
protected boolean	selectedCategoryIsInPickedCatalogVersion(AdvancedCategoryTreeModel tempTreeModel)
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
protected void	setCategoriesSelectionFromPreviousSelection(AdvancedCategoryTreeModel tempTreeModel) Goes through previously selected categories and if found in the newly selected catalog, they are selected in the Catalog.
protected void	setCategoryPath()
void	setCategoryService(CategoryService categoryService)
protected void	setGlobalCategory()

Methods inherited from class de.hybris.commercesearchbackoffice.widgets.common.impersonation.AbstractImpersonationController

createImpersonationContext, executeInContext, getCurrentBaseSite, getCurrentBaseStore, getCurrentCatalogVersion, getCurrentCurrency, getCurrentLanguage

Methods inherited from class java.lang.Object

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

Field Detail

SOCKET_OUT_CATEGORY

public static final java.lang.String SOCKET_OUT_CATEGORY

See Also:

Constant Field Values

SOCKET_IN_SITE

public static final java.lang.String SOCKET_IN_SITE

See Also:

Constant Field Values

SOCKET_IN_CLEAR

public static final java.lang.String SOCKET_IN_CLEAR

See Also:

Constant Field Values

MODEL_CURRENTCATEGORY

protected static final java.lang.String MODEL_CURRENTCATEGORY

See Also:

Constant Field Values

Constructor Detail

CategoryTreeController

public CategoryTreeController()

Method Detail

initialize

public void initialize(Component comp)

Initializes the widget controller with the root category of the current catalog version.

getData

protected void getData(SiteData siteData)

Method for obtaining data for selected site

Parameters:

siteData - is DTO object sent from site selector widget, it contains sideId and catalogId

generateTree

protected CategoryTreeNode[] generateTree(CategoryHierarchyData data)

Simple helper method for translating CategoryHierarchyData based tree into CategoryTreeNode tree

Parameters:

data - CategoryHierarchyData to convert

Returns:

array of CategoryTreeNode objects

handleNewSite

public void handleNewSite(SiteData newSiteData)

New event is detected, new site is selected

Parameters:

newSiteData - DTO object containing new search criterias

clearSelection

public void clearSelection()

Clear all open categories and selection

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

Parameters:

catalogVersionService - the catalogService to set

setCategoryService

public void setCategoryService(CategoryService categoryService)

Parameters:

categoryService - the categoryService to set

getCategoryTreeModel

public AdvancedCategoryTreeModel getCategoryTreeModel()

Returns:

the categoryTreeModel

selectCategory

protected void selectCategory(CategoryData categoryData)

Selects given category in the category tree. It means that the method displays the direct subcategories of the given category in the category tree.

Parameters:

categoryData -

setCategoryPath

protected void setCategoryPath()

setGlobalCategory

protected void setGlobalCategory()

expandNode

protected void expandNode(<any> mainTreeNode,
                          int depth)

Parameters:

mainTreeNode - - Node of the tree to expand.

depth - - Level of depth up to which the subtree of the given node should be expanded

hasCatalogVersionChanged

protected boolean hasCatalogVersionChanged(SiteData siteData,
                                           SiteData newSiteData)

Parameters:

siteData - - previous siteData

newSiteData - - new siteData

Returns:

true/false whether or not the catalog version has been changed

selectedCategoryIsInPickedCatalogVersion

protected boolean selectedCategoryIsInPickedCatalogVersion(AdvancedCategoryTreeModel tempTreeModel)

Returns:

true/false whether or not the selected category in previously browsed catalog version is also contained in the newly-picked catalog version

setCategoriesSelectionFromPreviousSelection

protected void setCategoriesSelectionFromPreviousSelection(AdvancedCategoryTreeModel tempTreeModel)

Goes through previously selected categories and if found in the newly selected catalog, they are selected in the Catalog.

createCategoryDataFromCategory

protected CategoryData createCategoryDataFromCategory(Category category)

Constructs CategoryData instance from a Category widget instance.

Parameters:

category -

Returns:

created CategoryData with categoryId and categoryName