Package com.saperion.ngc.navigation

Class NaviTreeNode

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Treeitem

com.saperion.ngc.navigation.NaviTreeItem

com.saperion.ngc.navigation.NaviTreeNode

All Implemented Interfaces:

EventChild, Identifiable, NaviNodeAccessor, Serializable, Cloneable, Comparable<NaviTreeNode>, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

Direct Known Subclasses:

AbstractFileNaviTreeNode, CollectionNaviTreeNode, CollectionRootNaviTreeNode, FavoriteNaviTreeNode, FilterNaviTreeNode, FormChildNaviTreeNode, FormNaviTreeNode, LinkNaviTreeNode, MiniFormNode, OutlinerChildNaviTreeNode, RootFavoriteNaviTreeNode, RootFormNaviTreeNode, RootNaviTreeNode, RootPrivateNaviTreeNode, WebpartNaviTreeNode, WorkflowFormNaviTreeNode, WorkflowNaviTreeNode, WorkflowRootNaviTreeNode

public class NaviTreeNode
extends NaviTreeItem
implements EventChild, NaviNodeAccessor, Comparable<NaviTreeNode>, Identifiable

This class holds the ZK navigation tree node representation.

Author:

mak

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields

Modifier and Type	Field	Description
protected org.zkoss.zul.Label	countLabel	Label holder for document counts.
protected NavigationNode	modelNaviNode	Model node of this view node.
static final String	NODE_ATTR_FILEUPLOAD_TARGET	Attribute used to set the target component for fileupload-events.
protected org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>	onClickListener	The onclick event listener of this node.

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Fields inherited from interface com.saperion.ngc.events.EventChild

ALL_EVENTS, ON_ADD_LINK, ON_ADD_LOOKUP, ON_ADD_TO_FAVORITES, ON_AFTER_QUERY, ON_BUTTON, ON_BUTTON_QUERY, ON_CANCEL, ON_CANCEL_AND, ON_CANCEL_EDIT, ON_CHANGE_DOCUMENT_SECURITY, ON_CHANGE_FOLDER_SECURITY, ON_CLEAR, ON_DELETE_SELECTED, ON_DISPLAY_POPUP, ON_DISPLAY_RESULTITEM, ON_DISPLAY_TEMPORARY_DOCUMENT, ON_DOCUMENT_ADDED, ON_DOCUMENT_CHECK, ON_DOCUMENT_FILING, ON_DOCUMENT_LOCKED, ON_DOCUMENT_PROLONG_RETENTION, ON_DOCUMENT_REDUCE_DISPOSITION, ON_DOCUMENT_RELEASE, ON_DOWNLOAD_RESULTITEM, ON_EDIT_CONTENT, ON_EDIT_FOLDER, ON_EDIT_ITEM, ON_EDIT_ITEM_SELECTED, ON_EDIT_LOOKUP, ON_EDIT_SELECTED, ON_EDIT_STRUCTURE, ON_EXPORT, ON_EXTERNAL_STORAGE_UPLOAD, ON_EXTERNAL_STORAGE_UPLOAD_STATUS, ON_FAST_ACCESS_DRAG_OVER, ON_FIELD_CHANGE, ON_FILE_ACTION, ON_FILE_PREVIEW, ON_FILE_SEARCH, ON_FORM_CREATED, ON_FORM_RENDER_ERROR, ON_FORWARD, ON_IGNORE, ON_INDEX, ON_INDEX_CLEAR, ON_INDEX_RESULTITEM, ON_ITEM_DOUBLECLICK, ON_LAUNCH_WORKFLOW, ON_LOG, ON_LOGON, ON_MACRO, ON_NAVIGATION, ON_NAVIGATION_FOLDER, ON_NAVIGATION_FORM, ON_NAVIGATION_WEBPART, ON_NEW_ITEM, ON_NEW_SELECTED, ON_OK, ON_ONEDRIVE_LOGIN, ON_OPEN_INDEX_MASK, ON_OPEN_MASK, ON_OPEN_QUERY_MASK, ON_PASSWORD_EXPIRED, ON_PRINT_DOCUMENTS, ON_QUERY, ON_QUERY_FAVORITE, ON_REFRESH, ON_REFRESH_FOLDER, ON_RESET_GUI, ON_REVISION_CREATED, ON_SAVE_AND, ON_SAVE_DOC, ON_SAVE_FOLDER, ON_SCROLL_NODE, ON_SELECT_TREE_ITEM, ON_SELECTDDC, ON_SEND_MAIL_RESULTITEM, ON_SET_LITIGATION_HOLD, ON_SHAREBASE_DOCUMENT_CHECK, ON_SHAREBASE_LOGIN, ON_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_DOCUMENT, ON_UPLOAD_EXTERNAL_STORAGE_DOCUMENT, ON_UPLOAD_SUCCESS, ON_VARIABLES_AVAILABLE, ON_WF, ON_WF_COMMENT_DIALOG_CANCEL, ON_WF_COMMENT_DIALOG_OK, ON_WFCOMMENTS, ON_WFDELEGATE, ON_WFFORWARD, ON_WFFORWARD1, ON_WFFORWARD2, ON_WFFORWARD3, ON_WFFORWARD4, ON_WFFORWARD5, ON_WFHISTORY, ON_WFPUTBACK, ON_WFREMINDER, ON_WFTAKE, ON_WORKFLOW_ACTION, ON_WORKFLOW_COMMENT, ON_WORKFLOW_DISPLAY_COMMENT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NaviTreeNode(NavigationViewImpl naviView, NavigationTree tree, org.zkoss.zul.Treechildren parent)	Constructor for root level folders.

Method Summary

Modifier and Type	Method	Description
void	addChild(NavigationNode child)	Adds a new child node to the tree.
void	addChildNodes(NavigationNode node)	Adds the already existing model children of the given navigation model node to the associated view tree node.
protected void	addContextMenu()	Add context menu.
protected void	addCreateCollectionMenuItem()
protected boolean	addCreateFolderMenuItem()	Add menu item for creating folder.
protected boolean	addDeleteFolderMenuItem()	Add delete folder menu item.
protected void	addEditFolderPropertiesMenuItem()	Adds the menu item to edit the folder's properties.
protected void	addEmptyMenuItem()	Empty menu item.
protected boolean	addFastAccessMenuItem()	Fast access context menu.
protected boolean	addFolderSecurityMenuItem()	Add folder security menu item.
protected void	addMainContextMenu()	Add main context menu.
protected void	addMenuItem(org.zkoss.zul.Menuitem item, boolean withSeparator)	Adds a new item to the context menu.
protected void	addOnClickEventListener()	Adds the event listener for onClick event.
protected void	addOnDoubleClickEventListener()	Add double click event listener.
protected void	addOnOpenEventListener()	Add on open event listener, should load children on demand.
protected void	addRefreshMenuItem()	Adds refresh menu item.
protected boolean	addRenameFolderMenuItem()	Add menu item for delete folder.
protected void	addSearchFolderMenuItem()	Adds the menu item to search for folders with a mask.
protected void	addSeparator()	Add separator.
protected final void	addTreeRow(boolean selectionMode)	Add tree row and register event listeners.
protected boolean	addUploadMenuItem()	Add folder security menu item.
protected void	clearChildren()	Clear children.
int	compareTo(NaviTreeNode o)
protected void	copyFolder(NaviTreeNode folderToCopy, NaviTreeNode target)	Copies a folder.
protected List<org.zkoss.zul.Treecell>	createCells()	Creates the ZK Treecells to display this tree node.
protected void	createTreerow()	Creates a new treerow.
String	generateUUID()
protected NodeContextMenuCreator	getContextCreator()
protected String	getCountValue()	Builds and returns the value of this nodes count label.
NaviMenuRights	getDefaultMenuRights()	This method returns the default NaviMenuRights for the context menu containing all rights.
protected String	getDragableIdentifiers()
protected String	getDroppableIdentifiers()	Returns a comma separated string with the identifiers of items that can be dropped on this item or 'false'/'true' if no/all items can be dropped on this item.
protected EventChildHandler	getEventProvider()	Returns the event provider.
Set<org.zkoss.zk.ui.Component>	getEventtarget(String eventName)	Reads the event target for the given event name, if set or the root element.
FolderClass	getFolderClass()	Reads the folder class.
String	getMaskDDC()	Reads the mask ddc name.
protected org.zkoss.zul.Menupopup	getMenuPopup()
NavigationNode	getModelNaviNode()
protected NavigationPresenter	getNavigationPresenter()
protected NavigationViewImpl	getNavigationView()
protected boolean	getNextLevelFolders()	Initiates lazy loading of next level folders.
NaviNodeAccessor	getParentNaviNode()	Returns the parent node (in case of root node null) of this node.
protected org.zkoss.zul.Treecell	getTreeCell()
boolean	hideChildren()	Checks if this node will hide it's children or not.
boolean	isPrivate()
boolean	isWorkflow()
protected void	moveFolder(NaviTreeNode sourceNode)	Moves a folder to another.
void	onPageDetached(org.zkoss.zk.ui.Page page)
protected void	openNode()	Expands the node.
void	postErrorLogEvent(LogMessage message)	Posts an error log event.
void	postInfoLogEvent(LogMessage message)	Posts an info log event.
void	postLogonEvent(LogonEvent.LogonResult result, String username)	Posts a logon event.
protected void	raiseTabClear()	Raise tab clear.
protected void	refreshCurrentNode()	Refreshes the current node only.
protected void	refreshCurrentNode(boolean includeChildren)	Refreshes the current node.
protected void	refreshParent()	Refreshes the parent view of the current node.
protected void	registerChildrensColumns()	Registers the columns used by the child nodes at the column manager.
void	remove(NavigationNode node)	Removes the associated child node.
void	render()	Renders the children of this node based on the given model node.
protected void	renderChildNodes(List<NavigationNode> nodes)
void	setEventtarget(org.zkoss.zk.ui.Component comp, String eventName)	Set the event target.
protected void	setTreecells(List<org.zkoss.zul.Treecell> newCells)
protected boolean	shouldCreateWebpartFolderMenuItem()	Determines if WebpartFolderMenuItem should be created.
protected void	unregisterChildrensColumns()	Unregisters the columns used by the child nodes at the column manager.
void	updateCounter(com.saperion.folder.FolderUpdateInfo folderUpdateInfo)	Updates the count label of this node.
void	updateCounter(com.saperion.wf.BoxCount count)	Updates the count label of this node.

Methods inherited from class com.saperion.ngc.navigation.NaviTreeItem

getDisplayName, setDisplayName

Methods inherited from class org.zkoss.zul.Treeitem

beforeChildAdded, beforeParentChanged, clone, getImage, getIndex, getLabel, getLevel, getParentItem, getSrc, getTree, getTreechildren, getTreerow, getValue, getVisibleItemCount, indexOf, insertBefore, isCheckable, isContainer, isDisabled, isEmpty, isLoaded, isOpen, isRendered, isSelectable, isSelected, onChildAdded, onChildRemoved, redrawChildren, renderProperties, service, setCheckable, setDisabled, setHflex, setImage, setLabel, setOpen, setParent, setSelectable, setSelected, setSrc, setStubonly, setStubonly, setValue, setVisible, setWidth, unload

Methods inherited from class org.zkoss.zul.impl.XulElement

getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, invalidate, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, onPageAttached, onWrongValue, query, queryAll, redraw, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zkoss.zk.ui.Component

addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride

Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

invalidatePartial

Methods inherited from interface com.saperion.ngc.model.navigation.intf.NaviNodeAccessor

getTreechildren

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Field Details

NODE_ATTR_FILEUPLOAD_TARGET

public static final String NODE_ATTR_FILEUPLOAD_TARGET

Attribute used to set the target component for fileupload-events.

See Also:

• Constant Field Values

modelNaviNode

protected NavigationNode modelNaviNode

Model node of this view node.

countLabel

protected org.zkoss.zul.Label countLabel

Label holder for document counts.

onClickListener

protected transient org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> onClickListener

The onclick event listener of this node.

Constructor Details

NaviTreeNode

protected NaviTreeNode(NavigationViewImpl naviView,
 NavigationTree tree,
 org.zkoss.zul.Treechildren parent)

Constructor for root level folders.

Parameters:

naviView - navigation view

tree - model navigation tree

parent - parent tree element

Method Details

addTreeRow

protected final void addTreeRow(boolean selectionMode)

Add tree row and register event listeners.

Parameters:

selectionMode - selection mode enabled or disabled

getTreeCell

protected org.zkoss.zul.Treecell getTreeCell()

Returns:

Treecell

setTreecells

protected void setTreecells(List<org.zkoss.zul.Treecell> newCells)

Parameters:

newCells - New cells

clearChildren

protected void clearChildren()

Clear children.

createTreerow

protected void createTreerow()

Creates a new treerow.

createCells

protected List<org.zkoss.zul.Treecell> createCells()

Creates the ZK Treecells to display this tree node.

Returns:

a list of the created Treecells.

getCountValue

protected String getCountValue()

Builds and returns the value of this nodes count label.

Returns:

the value of this nodes count label.

updateCounter

public void updateCounter(com.saperion.folder.FolderUpdateInfo folderUpdateInfo)

Updates the count label of this node.

Parameters:

folderUpdateInfo - The FolderUpdateInfo describing the update values.

updateCounter

public void updateCounter(com.saperion.wf.BoxCount count)

Updates the count label of this node.

Parameters:

count - count for a workflow inbox

getDroppableIdentifiers

protected String getDroppableIdentifiers()

Returns a comma separated string with the identifiers of items that can be dropped on this item or 'false'/'true' if no/all items can be dropped on this item.

Returns:

identifiers of droppable items

getDragableIdentifiers

protected String getDragableIdentifiers()

Returns:

Dragable identifier

addOnDoubleClickEventListener

protected void addOnDoubleClickEventListener()

Add double click event listener.

getNextLevelFolders

protected boolean getNextLevelFolders()
                               throws AuthenticationException,
NgcUiException

Initiates lazy loading of next level folders.

Returns:

false if limit of node count is exceeded

Throws:

AuthenticationException - authentication exception

NgcUiException - exception to be handled by view

addOnOpenEventListener

protected void addOnOpenEventListener()

Add on open event listener, should load children on demand.

openNode

protected void openNode()

Expands the node.

addContextMenu

protected void addContextMenu()

Add context menu.

addMainContextMenu

protected void addMainContextMenu()

Add main context menu.

shouldCreateWebpartFolderMenuItem

protected boolean shouldCreateWebpartFolderMenuItem()

Determines if WebpartFolderMenuItem should be created.

Returns:

true if WebpartFolderMenuItem should be created, false otherwise.

addCreateCollectionMenuItem

protected void addCreateCollectionMenuItem()

addMenuItem

protected void addMenuItem(org.zkoss.zul.Menuitem item,
 boolean withSeparator)

Adds a new item to the context menu.

Parameters:

item - the new item

withSeparator - adds a separator before the item if necessary

addSeparator

protected void addSeparator()

Add separator.

addRefreshMenuItem

protected void addRefreshMenuItem()

Adds refresh menu item.

addEmptyMenuItem

protected void addEmptyMenuItem()

Empty menu item.

addFastAccessMenuItem

protected boolean addFastAccessMenuItem()

Fast access context menu.

Returns:

true if menu item was added

getNavigationPresenter

protected NavigationPresenter getNavigationPresenter()

Returns:

Navigation presenter

addCreateFolderMenuItem

protected boolean addCreateFolderMenuItem()

Add menu item for creating folder.

Returns:

true if item was created

addRenameFolderMenuItem

protected boolean addRenameFolderMenuItem()

Add menu item for delete folder.

Returns:

true if item was created

addEditFolderPropertiesMenuItem

protected void addEditFolderPropertiesMenuItem()

Adds the menu item to edit the folder's properties.

addSearchFolderMenuItem

protected void addSearchFolderMenuItem()

Adds the menu item to search for folders with a mask.

addOnClickEventListener

protected void addOnClickEventListener()

Adds the event listener for onClick event. Override this method to listen to click events.

raiseTabClear

protected void raiseTabClear()

Raise tab clear.

addDeleteFolderMenuItem

protected boolean addDeleteFolderMenuItem()

Add delete folder menu item.

Returns:

true if item was created

addFolderSecurityMenuItem

protected boolean addFolderSecurityMenuItem()

Add folder security menu item.

Returns:

true if item was created

addUploadMenuItem

protected boolean addUploadMenuItem()

Add folder security menu item.

Returns:

true if item was created

render

public void render()

Renders the children of this node based on the given model node.

Specified by:

render in interface NaviNodeAccessor

getMenuPopup

protected org.zkoss.zul.Menupopup getMenuPopup()

Returns:

Menu popup

renderChildNodes

protected void renderChildNodes(List<NavigationNode> nodes)
                         throws NgcUiException,
AuthenticationException

Parameters:

nodes - Nodes

Throws:

AuthenticationException - authentication exception

NgcUiException - exception to be handled by view

getNavigationView

protected NavigationViewImpl getNavigationView()

Returns:

navigation view - root panel element.

getModelNaviNode

public NavigationNode getModelNaviNode()

Specified by:

getModelNaviNode in interface NaviNodeAccessor

Returns:

Model node

addChildNodes

public void addChildNodes(NavigationNode node)

Adds the already existing model children of the given navigation model node to the associated view tree node.

Specified by:

addChildNodes in interface NaviNodeAccessor

Parameters:

node - navigation model node

See Also:

• #addChildNodes(com.saperion.ngc.model.navigation.intf.NavigationNode)

remove

public void remove(NavigationNode node)

Removes the associated child node.

Specified by:

remove in interface NaviNodeAccessor

Parameters:

node - navigation model node

See Also:

• #remove(com.saperion.ngc.model.navigation.intf.NavigationNode)

compareTo

public int compareTo(NaviTreeNode o)

Specified by:

compareTo in interface Comparable<NaviTreeNode>

See Also:

• Comparable.compareTo(java.lang.Object)

addChild

public void addChild(NavigationNode child)

Adds a new child node to the tree.

Specified by:

addChild in interface NaviNodeAccessor

Parameters:

child - child node

See Also:

• #addChild(com.saperion.ngc.model.navigation.intf.NavigationNode)

getEventtarget

public Set<org.zkoss.zk.ui.Component> getEventtarget(String eventName)

Reads the event target for the given event name, if set or the root element.

Specified by:

getEventtarget in interface EventChild

Parameters:

eventName - Event name or null for main target

Returns:

Set of event targets

See Also:

• EventChildHandlerImpl.getEventtarget(java.lang.String)

setEventtarget

public void setEventtarget(org.zkoss.zk.ui.Component comp,
 String eventName)

Set the event target.

Specified by:

setEventtarget in interface EventChild

Parameters:

comp - Event target

eventName - Event name or null for main target

See Also:

• EventChildHandlerImpl.setEventtarget(org.zkoss.zk.ui.Component, java.lang.String)

postErrorLogEvent

public void postErrorLogEvent(LogMessage message)

Posts an error log event.

Parameters:

message - error message

See Also:

• LogEventChildHandler.postErrorLogEvent(com.saperion.ngc.service.LogMessage)

postInfoLogEvent

public void postInfoLogEvent(LogMessage message)

Posts an info log event.

Parameters:

message - info message

See Also:

• LogEventChildHandler.postInfoLogEvent(com.saperion.ngc.service.LogMessage)

postLogonEvent

public void postLogonEvent(LogonEvent.LogonResult result,
 String username)

Posts a logon event.

Parameters:

result - logon result

username - username

See Also:

• EventChildHandler.postLogonEvent(com.saperion.ngc.events.LogonEvent.LogonResult, java.lang.String)

getEventProvider

protected EventChildHandler getEventProvider()

Returns the event provider.

Returns:

event provider

moveFolder

protected void moveFolder(NaviTreeNode sourceNode)
                   throws NgcUiException

Moves a folder to another.

Parameters:

sourceNode - the node which has to be included before this node.

Throws:

NgcUiException - exception to be handled by view

copyFolder

protected void copyFolder(NaviTreeNode folderToCopy,
 NaviTreeNode target)
                   throws AuthenticationException,
NgcUiException

Copies a folder.

Parameters:

folderToCopy - folder to copy

target - target folder

Throws:

AuthenticationException - authentication exception

NgcUiException - exception to be handled by view

getParentNaviNode

public NaviNodeAccessor getParentNaviNode()

Returns the parent node (in case of root node null) of this node.

Specified by:

getParentNaviNode in interface NaviNodeAccessor

Returns:

parent node

isPrivate

public boolean isPrivate()

Specified by:

isPrivate in interface NaviNodeAccessor

Returns:

Is private folder

See Also:

• NaviNodeAccessor.isPrivate()

isWorkflow

public boolean isWorkflow()

Specified by:

isWorkflow in interface NaviNodeAccessor

Returns:

Is workflow folder

See Also:

• NaviNodeAccessor.isWorkflow()

refreshParent

protected void refreshParent()
                      throws AuthenticationException,
NgcUiException

Refreshes the parent view of the current node.

Throws:

NgcUiException - exception to be handled by view

AuthenticationException - re-logon required

refreshCurrentNode

protected void refreshCurrentNode(boolean includeChildren)
                           throws AuthenticationException,
NgcUiException

Refreshes the current node. Optional boolean parameter to update children laying under the current node.

Parameters:

includeChildren - Shall the children of the current node be updated, too?

Throws:

AuthenticationException - AuthentificationException

NgcUiException - NgcUiException

refreshCurrentNode

protected void refreshCurrentNode()
                           throws AuthenticationException,
NgcUiException

Refreshes the current node only.

Throws:

AuthenticationException - AuthentificationException

NgcUiException - NgcUiException

getMaskDDC

public String getMaskDDC()

Reads the mask ddc name. (Traverses the tree upwards to search).

Returns:

Mask ddc name or null, if not found.

unregisterChildrensColumns

protected void unregisterChildrensColumns()

Unregisters the columns used by the child nodes at the column manager.

registerChildrensColumns

protected void registerChildrensColumns()

Registers the columns used by the child nodes at the column manager.

getFolderClass

public FolderClass getFolderClass()

Reads the folder class.

Specified by:

getFolderClass in interface NaviNodeAccessor

Returns:

Folder class object

getContextCreator

protected NodeContextMenuCreator getContextCreator()

Returns:

the context menu item creator

generateUUID

public String generateUUID()

Specified by:

generateUUID in interface Identifiable

Returns:

the generated uuid for the DOM tree

hideChildren

public boolean hideChildren()

Checks if this node will hide it's children or not. Other node-types can override this method to decide whether to hide children or not.

Returns:

hide children or not

onPageDetached

public void onPageDetached(org.zkoss.zk.ui.Page page)

Specified by:

onPageDetached in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

onPageDetached in class org.zkoss.zk.ui.AbstractComponent

getDefaultMenuRights

public NaviMenuRights getDefaultMenuRights()

This method returns the default NaviMenuRights for the context menu containing all rights. This method is supposed to be overridden in extending classes to handle node type specific rights.

Returns:

default menu rights