com.saperion.ngc.navigation

Class NavigationViewImpl

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Window

com.saperion.ngc.events.BaseWindow

com.saperion.ngc.navigation.NavigationViewImpl

All Implemented Interfaces:

EventChild, EventChildHandler, LogEventChildHandler, NavigationView, Serializable, Cloneable, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.IdSpace, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.api.Window, org.zkoss.zul.ext.Framable, org.zkoss.zul.impl.api.XulElement

public final class NavigationViewImpl
extends BaseWindow
implements NavigationView, EventChild

Implementation of NavigationView.

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 inherited from class org.zkoss.zul.Window

EMBEDDED, HIGHLIGHTED, MODAL, OVERLAPPED, POPUP

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

_zclass

Fields inherited from interface com.saperion.ngc.navigation.NavigationView

ADVANCED_MODE, MULTI_SELECTION, SELECTION_DISABLED, SIMPLE_MODE, SINGLE_SELECTION

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 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_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_EXPAND_NODE, ON_EXPORT, 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_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_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_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

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

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
NavigationViewImpl() The navigation view.
NavigationViewImpl(boolean selectionMode, boolean multiple, boolean privateAllowed, boolean link) The navigation view.

Method Summary

Modifier and Type	Method and Description
void	addChildNodes(NavigationNode node) Adds next level children to the given node.
FastAccessItem	addFastAccess(String ddc, String path, String name, boolean temporary) Adds a new entry to the fast access list.
void	addNode(NavigationNode parent, NavigationNode child)
void	addNodeMenuHandler(NaviTreeNodeMenuHandler handler, NavigationElement.TREE_ITEM_TYPE itemType) Add additional menu handler.
NaviTreeNode	findFolder(FolderId id) Finds the folder with the specified id.
int	getAllowedMaxNrOfNodesPerLevel() Gets the maximum number of allowed nodes per level.
Set<org.zkoss.zk.ui.Component>	getEventtarget(String eventName) Reads the event target for the given event name, if set or the root element.
String	getNavigationMode() Returns the navigation mode.
NaviMenuRights	getNodeMenuRights(NavigationElement.TREE_ITEM_TYPE itemType, NaviTreeNode node) Reads the rights for the given tree item type.
RootNaviTreeNode	getRootNode()
String	getSelectedFolderTable()
Set<NavigationNode>	getSelectedNodes()
Set<NaviTreeNode>	getSelectedUploadNodes() Returns the node selected for uploading.
boolean	getSimpleEFileChildren()
void	handleUploadPanelVisibility(boolean isUploadPanelVisible)
protected void	handleVisibilityOfUploadArea(NaviTreeNode node) Shows or hides the navigation view.
boolean	isAdvancedMode() Returns true if the navigation view is in advanced mode.
boolean	isDdcSelectorVisible() Reads the visibility of the Folder-DDC selector.
boolean	isFastAccessEnabled()
boolean	isLinkMode()
boolean	isMultiSelection()
boolean	isPrivateSelectAllowed()
boolean	isSelectionMode()
boolean	isWebpartsAllowed()
void	onAddLink(org.zkoss.zk.ui.event.Event event) Event handler to add link.
void	onAddToFavorites(org.zkoss.zk.ui.event.Event event) Event handler to add to favorite.
void	onChangeFolderSecurity(org.zkoss.zk.ui.event.Event event) Event handler for change of folder security.
void	onCreate(org.zkoss.zk.ui.event.Event event) OnCreate event handler.
void	onDocumentFiling(org.zkoss.zk.ui.event.Event event) Event handler for document filing events.
void	onFileAction(org.zkoss.zk.ui.event.Event event) Event handler for onFileAction events.
void	onLogon(org.zkoss.zk.ui.event.Event event) Event handler for logon.
void	onRefreshFolder(org.zkoss.zk.ui.event.Event event) Event to trigger the refresh of either folders or workflow folders.
void	onSelectTreeItem(org.zkoss.zk.ui.event.Event event) Event handler to select a tree item.
void	onTabSelected(org.zkoss.zk.ui.event.Event event) Event handler for tab selected event.
void	onUploadSuccess(org.zkoss.zk.ui.event.Event event) OnUploadSuccess event handler.
void	openFolderPropertyMask(FolderId folderId, String maskName) Opens the mask to edit the folder's properties.
void	openFolderPropertyMask(FolderId folderId, String maskName, org.zkoss.zk.ui.event.EventListener cancelListener, String windowTitle) Opens the mask to edit the folders's properties.
void	removeNode(FolderId id) Removes the node identified by the specified id from the view.
void	removeNode(NavigationNode node) Removes the node from the view.
void	renderFastAccess(String ddc, String fastAccessPath) Renders the fast access content.
void	renderNavigationTree(NavigationTree tree) Sets the user settings navigation data tree to be displayed.
void	setAllowedMaxNrOfNodesPerLevel(int limit) Sets the maximum number of allowed nodes per level to the given limit.
void	setDdcSelectorVisible(boolean value) Set visibility of the Folder-DDC selector.
void	setEventtarget(org.zkoss.zk.ui.Component comp, String eventName) Set the event target.
void	setFastAccessEnabled(boolean enabled) Activates or deactivates the fast access list.
void	setFolderTable(String tableName) Sets the folder table to use.
void	setNavigationMode(String mode) Sets the navigation mode.
void	setSelectionMode(String mode) Sets the selection mode.
void	setSimpleEFileChildren(boolean value) If this parameter is set to true, a eFile folder shows only eFile names, that where opened in the session.
void	setWebpartsAllowed(boolean value)
void	showNode(FolderId folderId) Assures that the node with the specified path is visible in the navigation view.

Methods inherited from class com.saperion.ngc.events.BaseWindow

getMainWindow, postAddLinkEvent, postAddToFavoritesEvent, postCancelSelectedEvent, postChangeDocumentSecurityEvent, postChangeFolderSecurityEvent, postDeleteSelectedEvent, postDisplayPopupEvent, postDisplayPopupEvent, postDisplayResultItemEvent, postDisplayResultItemEvent, postDocumentCheckEvent, postDocumentFilingEvent, postDocumentFilingEvent, postDocumentReleaseEvent, postDownloadResultItemEvent, postEditContentEvent, postEditItemSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditStructureEvent, postErrorLogEvent, postErrorLogEvent, postFieldChangeEvent, postFileActionEvent, postFileActionEvent, postFormButtonEvent, postIndexResultItemEvent, postInfoLogEvent, postInfoLogEvent, postLaunchWorkflowEvent, postLockDocumentEvent, postLogonEvent, postLogonEvent, postNavigationFolderEvent, postNavigationFormEvent, postNavigationFormEvent, postNavigationWebpartEvent, postNewSelectedEvent, postOpenMaskEvent, postPrintDocumentEvent, postQueryFavoriteEvent, postRefreshEvent, postResetGuiEvent, postResultFieldEvent, postSaveDocumentEvent, postSaveDocumentEvent, postSelectTreeItemEvent, postSendMailResultItemEvent, postStartWorkflowEvent, postTabSelectedEvent, postUnDeleteSelectedEvent, postUploadDocumentEvent, postUploadSuccessEvent, postWarningLogEvent, postWarningLogEvent, postWorkflowActionEvent, postWorkflowCommentEvent

Methods inherited from class org.zkoss.zul.Window

beforeChildAdded, clone, doEmbedded, doHighlighted, doModal, doOverlapped, doPopup, getBorder, getCaption, getCaptionApi, getContentSclass, getContentStyle, getDefaultActionOnShow, getMinheight, getMinwidth, getMode, getPosition, getTitle, getZclass, inEmbedded, inHighlighted, inModal, inOverlapped, inPopup, insertBefore, isClosable, isCollapsible, isMaximizable, isMaximized, isMinimizable, isMinimized, isShadow, isSizable, onChildRemoved, onClose, onModal, onPageDetached, renderProperties, service, setBorder, setBorder, setClosable, setContentSclass, setContentStyle, setDefaultActionOnShow, setDraggable, setMaximizable, setMaximized, setMinheight, setMinimizable, setMinimized, setMinwidth, setMode, setMode, setPosition, setShadow, setSizable, setTitle, setTopmost, setVisible

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

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

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

focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

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

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, newExtraCtrl, onChildAdded, onPageAttached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderIdSpace, response, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

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

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, unsetVariable

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

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Methods inherited from interface com.saperion.ngc.events.EventChildHandler

postAddLinkEvent, postAddToFavoritesEvent, postCancelSelectedEvent, postChangeDocumentSecurityEvent, postChangeFolderSecurityEvent, postDeleteSelectedEvent, postDisplayPopupEvent, postDisplayPopupEvent, postDisplayResultItemEvent, postDisplayResultItemEvent, postDocumentCheckEvent, postDocumentFilingEvent, postDocumentFilingEvent, postDocumentReleaseEvent, postDownloadResultItemEvent, postEditContentEvent, postEditItemSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditStructureEvent, postFieldChangeEvent, postFileActionEvent, postFileActionEvent, postFormButtonEvent, postIndexResultItemEvent, postLaunchWorkflowEvent, postLockDocumentEvent, postLogonEvent, postLogonEvent, postNavigationFolderEvent, postNavigationFormEvent, postNavigationFormEvent, postNavigationWebpartEvent, postNewSelectedEvent, postOpenMaskEvent, postPrintDocumentEvent, postQueryFavoriteEvent, postRefreshEvent, postResetGuiEvent, postResultFieldEvent, postSaveDocumentEvent, postSaveDocumentEvent, postSelectTreeItemEvent, postSendMailResultItemEvent, postStartWorkflowEvent, postTabSelectedEvent, postUnDeleteSelectedEvent, postUploadDocumentEvent, postUploadSuccessEvent, postWorkflowActionEvent, postWorkflowCommentEvent

Methods inherited from interface com.saperion.ngc.events.LogEventChildHandler

postErrorLogEvent, postErrorLogEvent, postInfoLogEvent, postInfoLogEvent, postWarningLogEvent, postWarningLogEvent

Methods inherited from interface org.zkoss.zul.impl.api.XulElement

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

focus, getHeight, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZindex, getZIndex, setDroppable, setFocus, setHeight, setLeft, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow

Constructor Detail

NavigationViewImpl

public NavigationViewImpl()

The navigation view.

NavigationViewImpl

public NavigationViewImpl(boolean selectionMode,
                          boolean multiple,
                          boolean privateAllowed,
                          boolean link)
                   throws org.zkoss.util.InvalidValueException

The navigation view.

Parameters:

selectionMode - set to true to use the view in selection mode. Will load the tree automatically.

multiple - multiple selection mode

privateAllowed - private selection allowed

link - Link mode variant

Throws:

org.zkoss.util.InvalidValueException - if navigation mode setting is unknown

Method Detail

handleUploadPanelVisibility

public void handleUploadPanelVisibility(boolean isUploadPanelVisible)

Parameters:

isUploadPanelVisible - True for activate

renderFastAccess

public void renderFastAccess(String ddc,
                             String fastAccessPath)

Renders the fast access content.

Specified by:

renderFastAccess in interface NavigationView

Parameters:

ddc - folder ddc

fastAccessPath - Fast access path

See Also:

NavigationView.renderFastAccess(java.lang.String, java.lang.String)

renderNavigationTree

public void renderNavigationTree(NavigationTree tree)

Sets the user settings navigation data tree to be displayed.

Specified by:

renderNavigationTree in interface NavigationView

Parameters:

tree - The navigation tree data to be displayed.

addChildNodes

public void addChildNodes(NavigationNode node)

Adds next level children to the given node.

Specified by:

addChildNodes in interface NavigationView

Parameters:

node - The navigation node data to be updated.

removeNode

public void removeNode(FolderId id)

Removes the node identified by the specified id from the view. Only the view-representation is removed, the folder itself remains on the archive.

Specified by:

removeNode in interface NavigationView

Parameters:

id - id of the folder to remove

See Also:

NavigationView.removeNode(com.saperion.ngc.model.FolderId)

removeNode

public void removeNode(NavigationNode node)

Removes the node from the view. Only the view-representation is removed, the folder itself remains on the archive.

Specified by:

removeNode in interface NavigationView

Parameters:

node - the node to remove

See Also:

NavigationView.removeNode(com.saperion.ngc.model.navigation.intf.NavigationNode)

addNode

public void addNode(NavigationNode parent,
                    NavigationNode child)

Specified by:

addNode in interface NavigationView

Parameters:

parent - Node

child - Child

See Also:

NavigationView.addNode(com.saperion.ngc.model.navigation.intf.NavigationNode, com.saperion.ngc.model.navigation.intf.NavigationNode)

findFolder

public NaviTreeNode findFolder(FolderId id)

Finds the folder with the specified id.

Specified by:

findFolder in interface NavigationView

Parameters:

id - folder id

Returns:

folder matching the id

See Also:

NavigationView.findFolder(com.saperion.ngc.model.FolderId)

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

Overrides:

getEventtarget in class BaseWindow

Parameters:

eventName - Event name or null for main target

Returns:

Set of event targets

See Also:

EventChild.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

Overrides:

setEventtarget in class BaseWindow

Parameters:

comp - Event target

eventName - Event name or null for main target

See Also:

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

setDdcSelectorVisible

public void setDdcSelectorVisible(boolean value)

Set visibility of the Folder-DDC selector.

Specified by:

setDdcSelectorVisible in interface NavigationView

Parameters:

value - True for visible

See Also:

NavigationView.setDdcSelectorVisible(boolean)

isDdcSelectorVisible

public boolean isDdcSelectorVisible()

Reads the visibility of the Folder-DDC selector.

Specified by:

isDdcSelectorVisible in interface NavigationView

Returns:

True for visible.

See Also:

NavigationView.isDdcSelectorVisible()

getAllowedMaxNrOfNodesPerLevel

public int getAllowedMaxNrOfNodesPerLevel()

Gets the maximum number of allowed nodes per level.

Specified by:

getAllowedMaxNrOfNodesPerLevel in interface NavigationView

Returns:

the maximum number of allowed nodes per level

See Also:

NavigationView.getAllowedMaxNrOfNodesPerLevel()

setAllowedMaxNrOfNodesPerLevel

public void setAllowedMaxNrOfNodesPerLevel(int limit)

Sets the maximum number of allowed nodes per level to the given limit.

Specified by:

setAllowedMaxNrOfNodesPerLevel in interface NavigationView

Parameters:

limit - the maximum number of allowed nodes per level

See Also:

NavigationView.setAllowedMaxNrOfNodesPerLevel(int)

isSelectionMode

public boolean isSelectionMode()

Specified by:

isSelectionMode in interface NavigationView

Returns:

true if the navigation view is in selection mode

See Also:

NavigationView.isSelectionMode()

isMultiSelection

public boolean isMultiSelection()

Specified by:

isMultiSelection in interface NavigationView

Returns:

true if multiple items can be selected. Only true if isSelectionMode is true, too.

See Also:

NavigationView.isMultiSelection()

isLinkMode

public boolean isLinkMode()

Specified by:

isLinkMode in interface NavigationView

Returns:

true if the navigation view is in link mode

See Also:

NavigationView.isLinkMode()

isPrivateSelectAllowed

public boolean isPrivateSelectAllowed()

Specified by:

isPrivateSelectAllowed in interface NavigationView

Returns:

true, if private folder select allowed

See Also:

NavigationView.isPrivateSelectAllowed()

getSelectedNodes

public Set<NavigationNode> getSelectedNodes()

Specified by:

getSelectedNodes in interface NavigationView

Returns:

set of all selected nodes

See Also:

NavigationView.getSelectedNodes()

getSelectedUploadNodes

public Set<NaviTreeNode> getSelectedUploadNodes()

Returns the node selected for uploading.

Returns:

nodes selected for uploading

onLogon

public void onLogon(org.zkoss.zk.ui.event.Event event)

Event handler for logon.

Specified by:

onLogon in interface NavigationView

Parameters:

event - Event

See Also:

NavigationView.onLogon(org.zkoss.zk.ui.event.Event)

onSelectTreeItem

public void onSelectTreeItem(org.zkoss.zk.ui.event.Event event)

Event handler to select a tree item.

Specified by:

onSelectTreeItem in interface NavigationView

Parameters:

event - Event

See Also:

NavigationView.onSelectTreeItem(org.zkoss.zk.ui.event.Event)

onAddToFavorites

public void onAddToFavorites(org.zkoss.zk.ui.event.Event event)

Event handler to add to favorite.

Specified by:

onAddToFavorites in interface NavigationView

Parameters:

event - Event

See Also:

NavigationView.onAddToFavorites(org.zkoss.zk.ui.event.Event)

onDocumentFiling

public void onDocumentFiling(org.zkoss.zk.ui.event.Event event)

Event handler for document filing events.

Specified by:

onDocumentFiling in interface NavigationView

Parameters:

event - event

See Also:

NavigationView.onDocumentFiling(org.zkoss.zk.ui.event.Event)

onChangeFolderSecurity

public void onChangeFolderSecurity(org.zkoss.zk.ui.event.Event event)

Event handler for change of folder security.

Specified by:

onChangeFolderSecurity in interface NavigationView

Parameters:

event - event

See Also:

NavigationView.onChangeFolderSecurity(org.zkoss.zk.ui.event.Event)

onAddLink

public void onAddLink(org.zkoss.zk.ui.event.Event event)

Event handler to add link.

Specified by:

onAddLink in interface NavigationView

Parameters:

event - Event

See Also:

NavigationView.onAddLink(org.zkoss.zk.ui.event.Event)

onCreate

public void onCreate(org.zkoss.zk.ui.event.Event event)
              throws org.zkoss.util.InvalidValueException

OnCreate event handler.

Parameters:

event - event

Throws:

org.zkoss.util.InvalidValueException - if navigation mode contains an invalid value

onUploadSuccess

public void onUploadSuccess(org.zkoss.zk.ui.event.Event event)

OnUploadSuccess event handler.

Parameters:

event - event

onFileAction

public void onFileAction(org.zkoss.zk.ui.event.Event event)

Event handler for onFileAction events.

Parameters:

event - event

onTabSelected

public void onTabSelected(org.zkoss.zk.ui.event.Event event)

Event handler for tab selected event.

Parameters:

event - event

onRefreshFolder

public void onRefreshFolder(org.zkoss.zk.ui.event.Event event)

Event to trigger the refresh of either folders or workflow folders.

Parameters:

event - Refresh Event.

addFastAccess

public FastAccessItem addFastAccess(String ddc,
                                    String path,
                                    String name,
                                    boolean temporary)

Adds a new entry to the fast access list.

Specified by:

addFastAccess in interface NavigationView

Parameters:

ddc - folder ddc

path - path of the tree part to show

name - name of the entry

temporary - temporary items are not saved in user settings

Returns:

the new fast access item. Null will be returned if the item was already present in the list or if an error occurred.

See Also:

NavigationView.addFastAccess(java.lang.String, java.lang.String, java.lang.String, boolean)

isWebpartsAllowed

public boolean isWebpartsAllowed()

Specified by:

isWebpartsAllowed in interface NavigationView

Returns:

True, if webparts allowed

See Also:

NavigationView.isWebpartsAllowed()

setWebpartsAllowed

public void setWebpartsAllowed(boolean value)

Specified by:

setWebpartsAllowed in interface NavigationView

Parameters:

value - True for allowed

See Also:

NavigationView.setWebpartsAllowed(boolean)

getSelectedFolderTable

public String getSelectedFolderTable()

Specified by:

getSelectedFolderTable in interface NavigationView

Returns:

The actual selected folder DDC

See Also:

NavigationView.getSelectedFolderTable()

setNavigationMode

public void setNavigationMode(String mode)

Sets the navigation mode. Default: 'simple'.

Specified by:

setNavigationMode in interface NavigationView

Parameters:

mode - 'simple' or 'advanced' to select mode

See Also:

NavigationView.setNavigationMode(java.lang.String)

getNavigationMode

public String getNavigationMode()

Returns the navigation mode.

Specified by:

getNavigationMode in interface NavigationView

Returns:

navigation mode

See Also:

NavigationView.getNavigationMode()

isAdvancedMode

public boolean isAdvancedMode()

Returns true if the navigation view is in advanced mode.

Specified by:

isAdvancedMode in interface NavigationView

Returns:

is advanced mode

See Also:

NavigationView.isAdvancedMode()

openFolderPropertyMask

public void openFolderPropertyMask(FolderId folderId,
                                   String maskName)

Opens the mask to edit the folder's properties.

Specified by:

openFolderPropertyMask in interface NavigationView

Parameters:

folderId - id of the folder to edit

maskName - name of the mask to open

See Also:

NavigationView.openFolderPropertyMask(FolderId, String)

openFolderPropertyMask

public void openFolderPropertyMask(FolderId folderId,
                                   String maskName,
                                   org.zkoss.zk.ui.event.EventListener cancelListener,
                                   String windowTitle)

Opens the mask to edit the folders's properties.

Specified by:

openFolderPropertyMask in interface NavigationView

Parameters:

folderId - id of the folder to edit

maskName - name of the mask to open

cancelListener - event listener notified when the user presses cancel. The event sent to the listener contains the id of the folder that was edited in it's data-field.

windowTitle - title of the window

See Also:

NavigationView.openFolderPropertyMask(com.saperion.ngc.model.FolderId, java.lang.String, org.zkoss.zk.ui.event.EventListener, java.lang.String)

showNode

public void showNode(FolderId folderId)

Assures that the node with the specified path is visible in the navigation view.

Specified by:

showNode in interface NavigationView

Parameters:

folderId - id of the node

See Also:

NavigationView.showNode(com.saperion.ngc.model.FolderId)

setSelectionMode

public void setSelectionMode(String mode)
                      throws org.zkoss.util.InvalidValueException

Sets the selection mode. Possible values are 'single', 'multi' and 'disabled'.

Specified by:

setSelectionMode in interface NavigationView

Parameters:

mode - selection mode

Throws:

org.zkoss.util.InvalidValueException - invalid value in zul file

See Also:

NavigationView.setSelectionMode(java.lang.String)

setFolderTable

public void setFolderTable(String tableName)

Sets the folder table to use.

Specified by:

setFolderTable in interface NavigationView

Parameters:

tableName - table name

See Also:

NavigationView.setFolderTable(java.lang.String)

setFastAccessEnabled

public void setFastAccessEnabled(boolean enabled)

Activates or deactivates the fast access list.

Specified by:

setFastAccessEnabled in interface NavigationView

Parameters:

enabled - enabled

See Also:

NavigationView.setFastAccessEnabled(boolean)

isFastAccessEnabled

public boolean isFastAccessEnabled()

Specified by:

isFastAccessEnabled in interface NavigationView

Returns:

fast access list enabled/disabled status

See Also:

NavigationView.isFastAccessEnabled()

getRootNode

public RootNaviTreeNode getRootNode()

Specified by:

getRootNode in interface NavigationView

Returns:

the root node of the current tree

See Also:

NavigationView.getRootNode()

handleVisibilityOfUploadArea

protected void handleVisibilityOfUploadArea(NaviTreeNode node)

Shows or hides the navigation view.

Parameters:

node - selected node

addNodeMenuHandler

public void addNodeMenuHandler(NaviTreeNodeMenuHandler handler,
                               NavigationElement.TREE_ITEM_TYPE itemType)

Add additional menu handler.

Specified by:

addNodeMenuHandler in interface NavigationView

Parameters:

handler - Menu handler

itemType - Tree item type

See Also:

(com.saperion.ngc.navigation.NaviTreeNodeMenuHandler, com.saperion.ngc.model.navigation.intf.NavigationElement.TREE_ITEM_TYPE)

getNodeMenuRights

public NaviMenuRights getNodeMenuRights(NavigationElement.TREE_ITEM_TYPE itemType,
                                        NaviTreeNode node)

Reads the rights for the given tree item type.

Specified by:

getNodeMenuRights in interface NavigationView

Parameters:

itemType - Tree item type

node - navigation node

Returns:

Rights

See Also:

(com.saperion.ngc.model.navigation.intf.NavigationElement.TREE_ITEM_TYPE, com.saperion.ngc.navigation.NaviTreeNode)

setSimpleEFileChildren

public void setSimpleEFileChildren(boolean value)

If this parameter is set to true, a eFile folder shows only eFile names, that where opened in the session. If it is set to false, all eFiles for this eFile application are shown.

Specified by:

setSimpleEFileChildren in interface NavigationView

Parameters:

value - True for simple eFile children.

See Also:

NavigationView.setSimpleEFileChildren(boolean)

getSimpleEFileChildren

public boolean getSimpleEFileChildren()

Specified by:

getSimpleEFileChildren in interface NavigationView

Returns:

True, if simple eFile children set.

See Also:

NavigationView.getSimpleEFileChildren()