de.hybris.platform.cmscockpit.navigationnode.browserarea.tree

Class NavigationNodeController

java.lang.Object

de.hybris.platform.cmscockpit.navigationnode.browserarea.tree.NavigationNodeController

All Implemented Interfaces:

SelectableComponent<Tree,Treeitem,TypedObject>, PositionAwareTreeController<TypedObject>, TreeController<TypedObject>

public class NavigationNodeController
extends java.lang.Object
implements PositionAwareTreeController<TypedObject>

Controller of 'navigation node' tree, see related class: NavigationNodeBrowserModel

Spring Bean ID:

navigationNodeController

Constructor Summary

Constructors

Constructor and Description
NavigationNodeController()

Method Summary

Modifier and Type	Method and Description
void	add(Tree tree, java.lang.Object object, TypedObject target) Adds given object as a child of 'target' node (by default as last child), if null then new object is created
void	add(Tree tree, java.lang.Object object, TypedObject target, int index) Adds given object as a child of 'target' node, if null then new object is created
TypedObject	create(Tree tree, TypedObject target) Creates new object as a child of 'target' node
TypedObject	create(Tree tree, TypedObject target, int index) Creates new object as a child of 'target' node
java.lang.Object	customAction(Tree tree, Event event, TypedObject node) If some custom actions were added to the tree, this method will be called for each of them
void	delete(Tree tree, TypedObject node) Deletes given node
protected void	detachDialog(Window dialog)
void	doubleClicked(Tree tree, TypedObject currentNode) Called when given node was double clicked in tree
protected java.util.Set<TypedObject>	extractSelectedItem(java.util.Set<Treeitem> selectedItems)
CMSNavigationService	getCmsNavigationService()
protected ModelService	getModelService()
static Window	getMoveItemModalDialog(Tree tree, TypedObject typedObject, TypedObject targetNodeObj, CMSNavigationService cmsNavigationService) Returns window dialog with options when dropping content page.
java.lang.String	getNavigationNodeWizardId()
protected java.util.List<java.util.List<java.lang.Integer>>	getOpenedNodes(Tree tree, int depth)
protected java.util.List<java.lang.Integer>	getPathToRoot(Treeitem treeItem)
java.lang.String	getRelatedResourceWizardId()
java.util.Set<TypedObject>	getSelected()
protected SynchronizationService	getSynchronizationService()
protected java.util.List<SyncItemJobModel>[]	getSyncJobs(ListViewAction.Context context)
protected SystemService	getSystemService()
protected TypeService	getTypeService()
void	move(Tree tree, TypedObject node, TypedObject target, boolean addAsChild) Moves given node in place of 'target' node.
void	move(Tree tree, TypedObject node, TypedObject target, boolean addAsChild, boolean append) Moves given node in place of 'target' node.
void	openCreatedNode(Tree tree, TypedObject typedObject, boolean addAsAChild)
protected void	openPath(Tree tree, java.util.List<java.lang.Integer> path) Opens specified path
void	refresh(Tree tree)
protected void	restoreOpenedState(Tree tree, java.util.List<java.util.List<java.lang.Integer>> openedNodes) Restores opened state
protected void	restoreSelectionState(Tree tree) Restores whatever was selected (before tree invalidation etc) Call it after tree open state is restored see restoreOpenedState(Tree, List) because only opened nodes are search through.
protected Treeitem	searchForSelectedNode(java.util.List<Treeitem> treeitems, TypedObject selectedItem)
void	selected(Tree tree, java.util.Set<Treeitem> selectedTreeItems) Called every time the tree node was selected
protected void	sendUpdateEvents(Tree tree, TypedObject node)
void	setCmsNavigationService(CMSNavigationService navigationNodeService)
void	setModelService(ModelService modelService)
void	setNavigationNodeWizardId(java.lang.String navigationNodeWizardId)
void	setRelatedResourceWizardId(java.lang.String relatedResourceWizardId)
void	setSynchronizationService(SynchronizationService synchronizationService)
void	setSystemService(SystemService systemService)
void	setTypeService(TypeService typeService)
protected void	showNodeActions(Tree tree, java.util.Set<Treeitem> selectedItems) Shows actions next to selected row and hides actions from previously selected row

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationNodeController

public NavigationNodeController()

Method Detail

selected

public void selected(Tree tree,
                     java.util.Set<Treeitem> selectedTreeItems)

Description copied from interface: SelectableComponent

Called every time the tree node was selected

Specified by:

selected in interface SelectableComponent<Tree,Treeitem,TypedObject>

Parameters:

tree - in case an update is needed

selectedTreeItems - set of currently selected items

getSelected

public java.util.Set<TypedObject> getSelected()

Specified by:

getSelected in interface SelectableComponent<Tree,Treeitem,TypedObject>

Returns:

currently selected set of items

showNodeActions

protected void showNodeActions(Tree tree,
                               java.util.Set<Treeitem> selectedItems)

Shows actions next to selected row and hides actions from previously selected row

create

public TypedObject create(Tree tree,
                          TypedObject target)

Description copied from interface: TreeController

Creates new object as a child of 'target' node

Specified by:

create in interface TreeController<TypedObject>

Parameters:

tree - after successful creation, tree will be notified to update itself

target - that will have new 'object' added.

Returns:

created object

create

public TypedObject create(Tree tree,
                          TypedObject target,
                          int index)

Description copied from interface: TreeController

Creates new object as a child of 'target' node

Specified by:

create in interface TreeController<TypedObject>

Parameters:

tree - after successful creation, tree will be notified to update itself

target - that will have new 'object' added.

index - at which the new 'object' will be added within 'target' child set

Returns:

created object

add

public void add(Tree tree,
                java.lang.Object object,
                TypedObject target)

Description copied from interface: TreeController

Adds given object as a child of 'target' node (by default as last child), if null then new object is created

Specified by:

add in interface TreeController<TypedObject>

Parameters:

tree - after successful addition, tree will be notified to update itself

object - e.g. the dragged component which contains something to add to the 'target' node, null indicates that new object shall be created or anything else

target - that will have 'object' added.

move

public void move(Tree tree,
                 TypedObject node,
                 TypedObject target,
                 boolean addAsChild)

Description copied from interface: TreeController

Moves given node in place of 'target' node.

Specified by:

move in interface TreeController<TypedObject>

Parameters:

tree - after successful movement, tree will be notified to update itself

node - to be moved

target - node to be shifted. In place of this 'target' node the 'node' will be moved.

addAsChild - flag indicating whether node should be added as a child or not.

move

public void move(Tree tree,
                 TypedObject node,
                 TypedObject target,
                 boolean addAsChild,
                 boolean append)

Description copied from interface: PositionAwareTreeController

Moves given node in place of 'target' node.

Specified by:

move in interface PositionAwareTreeController<TypedObject>

Parameters:

tree - after successful movement, tree will be notified to update itself

node - to be moved

target - node to be shifted. In place of this 'target' node the 'node' will be moved.

addAsChild - flag indicating whether node should be added as a child or not.

append - if true the element will be placed after (addAsChild false) or in the very end (addAsChild true)

getMoveItemModalDialog

public static Window getMoveItemModalDialog(Tree tree,
                                            TypedObject typedObject,
                                            TypedObject targetNodeObj,
                                            CMSNavigationService cmsNavigationService)

Returns window dialog with options when dropping content page. Also handles click events.

Parameters:

tree - to find selected node

typedObject - to move/copy

targetNodeObj - - target node over which content page is dropped

cmsNavigationService -

Returns:

- dialog window

add

public void add(Tree tree,
                java.lang.Object object,
                TypedObject target,
                int index)

Description copied from interface: TreeController

Adds given object as a child of 'target' node, if null then new object is created

Specified by:

add in interface TreeController<TypedObject>

Parameters:

tree - after successful addition, tree will be notified to update itself

object - e.g. the dragged component which contains something to add to the 'target' node, or anything else

target - that will have 'object' added.

index - at which the 'object' will be added within 'target' child set

delete

public void delete(Tree tree,
                   TypedObject node)

Description copied from interface: TreeController

Deletes given node

Specified by:

delete in interface TreeController<TypedObject>

Parameters:

tree - after successful deletion, tree will be notified to update itself

node - to delete

doubleClicked

public void doubleClicked(Tree tree,
                          TypedObject currentNode)

Description copied from interface: TreeController

Called when given node was double clicked in tree

Specified by:

doubleClicked in interface TreeController<TypedObject>

Parameters:

tree - to play with after whatever was done

currentNode - which was double clicked

extractSelectedItem

protected java.util.Set<TypedObject> extractSelectedItem(java.util.Set<Treeitem> selectedItems)

getOpenedNodes

protected java.util.List<java.util.List<java.lang.Integer>> getOpenedNodes(Tree tree,
                                                                           int depth)

openCreatedNode

public void openCreatedNode(Tree tree,
                            TypedObject typedObject,
                            boolean addAsAChild)

getPathToRoot

protected java.util.List<java.lang.Integer> getPathToRoot(Treeitem treeItem)

restoreSelectionState

protected void restoreSelectionState(Tree tree)

Restores whatever was selected (before tree invalidation etc) Call it after tree open state is restored see restoreOpenedState(Tree, List) because only opened nodes are search through.

searchForSelectedNode

protected Treeitem searchForSelectedNode(java.util.List<Treeitem> treeitems,
                                         TypedObject selectedItem)

Returns:

treeitem to be selected, null if nothing found

restoreOpenedState

protected void restoreOpenedState(Tree tree,
                                  java.util.List<java.util.List<java.lang.Integer>> openedNodes)

Restores opened state

openPath

protected void openPath(Tree tree,
                        java.util.List<java.lang.Integer> path)

Opens specified path

getCmsNavigationService

public CMSNavigationService getCmsNavigationService()

setCmsNavigationService

public void setCmsNavigationService(CMSNavigationService navigationNodeService)

getSyncJobs

protected java.util.List<SyncItemJobModel>[] getSyncJobs(ListViewAction.Context context)

customAction

public java.lang.Object customAction(Tree tree,
                                     Event event,
                                     TypedObject node)

Description copied from interface: TreeController

If some custom actions were added to the tree, this method will be called for each of them

Specified by:

customAction in interface TreeController<TypedObject>

Parameters:

tree - to play with if necessary

event - original event that was sent when custom action button was clicked

node - from selected tree item

Returns:

whatever you implement

sendUpdateEvents

protected void sendUpdateEvents(Tree tree,
                                TypedObject node)

refresh

public void refresh(Tree tree)

detachDialog

protected void detachDialog(Window dialog)

getModelService

protected ModelService getModelService()

getTypeService

protected TypeService getTypeService()

getSystemService

protected SystemService getSystemService()

getSynchronizationService

protected SynchronizationService getSynchronizationService()

setTypeService

public void setTypeService(TypeService typeService)

setSystemService

public void setSystemService(SystemService systemService)

setModelService

public void setModelService(ModelService modelService)

getNavigationNodeWizardId

public java.lang.String getNavigationNodeWizardId()

setNavigationNodeWizardId

public void setNavigationNodeWizardId(java.lang.String navigationNodeWizardId)

setSynchronizationService

public void setSynchronizationService(SynchronizationService synchronizationService)

getRelatedResourceWizardId

public java.lang.String getRelatedResourceWizardId()

setRelatedResourceWizardId

public void setRelatedResourceWizardId(java.lang.String relatedResourceWizardId)