Package com.saperion.ngc.navigation

Interface NavigationView

All Superinterfaces:

java.lang.Cloneable, org.zkoss.zk.ui.Component, EventChild, EventChildHandler, LogEventChildHandler, org.zkoss.zk.ui.ext.Scope, java.io.Serializable

All Known Implementing Classes:

NavigationViewImpl

public interface NavigationView
extends org.zkoss.zk.ui.Component, EventChildHandler

The navigation view shows the folder structure as a tree. It provides functions to edit folders and to upload documents.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ADVANCED_MODE	Advanced navigation mode.
static java.lang.String	MULTI_SELECTION	Multi selection mode.
static java.lang.String	SELECTION_DISABLED	Selection mode disabled.
static java.lang.String	SIMPLE_MODE	Simple navigation mode.
static java.lang.String	SINGLE_SELECTION	Single selection mode.

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_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

Method Summary

Modifier and Type	Method	Description
void	addChildNodes(NavigationNode node)	Adds next level children to the given node.
FastAccessItem	addFastAccess(java.lang.String ddc, java.lang.String path, java.lang.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.
java.lang.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()
java.lang.String	getSelectedFolderTable()
java.util.Set<NavigationNode>	getSelectedNodes()
boolean	getSimpleEFileChildren()
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	onDocumentFiling(org.zkoss.zk.ui.event.Event event)	Event handler for document filing events.
void	onLogon(org.zkoss.zk.ui.event.Event event)	Event handler for logon.
void	onSelectTreeItem(org.zkoss.zk.ui.event.Event event)	Event handler to select a tree item.
void	openFolderPropertyMask(FolderId folderId, java.lang.String maskName)	Opens the mask to edit the folder's properties.
void	openFolderPropertyMask(FolderId folderId, java.lang.String maskName, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> cancelEventListener, java.lang.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(java.lang.String ddc, java.lang.String path)	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	setFastAccessEnabled(boolean enabled)	Activates or deactivates the fast access list.
void	setFolderTable(java.lang.String tableName)	Sets the folder table to use.
void	setNavigationMode(java.lang.String mode)	Sets the navigation mode.
void	setSelectionMode(java.lang.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 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 com.saperion.ngc.events.EventChild

getEventtarget, setEventtarget

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

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

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

postErrorLogEvent, postErrorLogEvent, postInfoLogEvent, postInfoLogEvent, postWarningLogEvent, postWarningLogEvent

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

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Field Detail

SIMPLE_MODE

static final java.lang.String SIMPLE_MODE

Simple navigation mode.

See Also:

Constant Field Values

ADVANCED_MODE

static final java.lang.String ADVANCED_MODE

Advanced navigation mode.

See Also:

Constant Field Values

SINGLE_SELECTION

static final java.lang.String SINGLE_SELECTION

Single selection mode.

See Also:

Constant Field Values

MULTI_SELECTION

static final java.lang.String MULTI_SELECTION

Multi selection mode.

See Also:

Constant Field Values

SELECTION_DISABLED

static final java.lang.String SELECTION_DISABLED

Selection mode disabled.

See Also:

Constant Field Values

Method Detail

renderNavigationTree

void renderNavigationTree(NavigationTree tree)

Sets the user settings navigation data tree to be displayed.

Parameters:

tree - The navigation tree data to be displayed.

renderFastAccess

void renderFastAccess(java.lang.String ddc,
                      java.lang.String path)

Renders the fast access content.

Parameters:

ddc - folder ddc

path - Fast access path

addChildNodes

void addChildNodes(NavigationNode node)

Adds next level children to the given node.

Parameters:

node - The navigation node data to be updated.

removeNode

void removeNode(NavigationNode node)

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

Parameters:

node - the node to remove

removeNode

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.

Parameters:

id - id of the folder to remove

addNode

void addNode(NavigationNode parent,
             NavigationNode child)

Parameters:

parent - Node

child - Child

setAllowedMaxNrOfNodesPerLevel

void setAllowedMaxNrOfNodesPerLevel(int limit)

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

Parameters:

limit - the maximum number of allowed nodes per level

getAllowedMaxNrOfNodesPerLevel

int getAllowedMaxNrOfNodesPerLevel()

Gets the maximum number of allowed nodes per level.

Returns:

the maximum number of allowed nodes per level

isSelectionMode

boolean isSelectionMode()

Returns:

true if the navigation view is in selection mode

isMultiSelection

boolean isMultiSelection()

Returns:

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

isLinkMode

boolean isLinkMode()

Returns:

true if the navigation view is in link mode

isPrivateSelectAllowed

boolean isPrivateSelectAllowed()

Returns:

true, if private folder select allowed

getSelectedNodes

java.util.Set<NavigationNode> getSelectedNodes()

Returns:

set of all selected nodes

onLogon

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

Event handler for logon.

Parameters:

event - Event

onSelectTreeItem

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

Event handler to select a tree item.

Parameters:

event - Event

onAddToFavorites

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

Event handler to add to favorite.

Parameters:

event - Event

onDocumentFiling

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

Event handler for document filing events.

Parameters:

event - event

onChangeFolderSecurity

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

Event handler for change of folder security.

Parameters:

event - event

onAddLink

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

Event handler to add link.

Parameters:

event - Event

addFastAccess

FastAccessItem addFastAccess(java.lang.String ddc,
                             java.lang.String path,
                             java.lang.String name,
                             boolean temporary)

Adds a new entry to the fast access list.

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.

setDdcSelectorVisible

void setDdcSelectorVisible(boolean value)

Set visibility of the Folder-DDC selector.

Parameters:

value - True for visible

isDdcSelectorVisible

boolean isDdcSelectorVisible()

Reads the visibility of the Folder-DDC selector.

Returns:

True for visible.

setWebpartsAllowed

void setWebpartsAllowed(boolean value)

Parameters:

value - True for allowed

isWebpartsAllowed

boolean isWebpartsAllowed()

Returns:

True, if webparts allowed

getSelectedFolderTable

java.lang.String getSelectedFolderTable()

Returns:

The actual selected folder DDC

setNavigationMode

void setNavigationMode(java.lang.String mode)

Sets the navigation mode. Default: 'simple'.

Parameters:

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

getNavigationMode

java.lang.String getNavigationMode()

Returns the navigation mode.

Returns:

navigation mode

isAdvancedMode

boolean isAdvancedMode()

Returns true if the navigation view is in advanced mode.

Returns:

is advanced mode

openFolderPropertyMask

void openFolderPropertyMask(FolderId folderId,
                            java.lang.String maskName)

Opens the mask to edit the folder's properties.

Parameters:

folderId - id of the folder to edit

maskName - name of the mask to open

openFolderPropertyMask

void openFolderPropertyMask(FolderId folderId,
                            java.lang.String maskName,
                            org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> cancelEventListener,
                            java.lang.String windowTitle)

Opens the mask to edit the folders's properties.

Parameters:

folderId - id of the folder to edit

maskName - name of the mask to open

cancelEventListener - 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

showNode

void showNode(FolderId folderId)

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

Parameters:

folderId - id of the node

setSelectionMode

void setSelectionMode(java.lang.String mode)

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

Parameters:

mode - selection mode

setFolderTable

void setFolderTable(java.lang.String tableName)

Sets the folder table to use.

Parameters:

tableName - table name

setFastAccessEnabled

void setFastAccessEnabled(boolean enabled)

Activates or deactivates the fast access list.

Parameters:

enabled - enabled

isFastAccessEnabled

boolean isFastAccessEnabled()

Returns:

fast access list enabled/disabled status

findFolder

NaviTreeNode findFolder(FolderId id)

Finds the folder with the specified id.

Parameters:

id - folder id

Returns:

folder matching the id

getRootNode

RootNaviTreeNode getRootNode()

Returns:

the root node of the current tree

addNodeMenuHandler

void addNodeMenuHandler(NaviTreeNodeMenuHandler handler,
                        NavigationElement.TREE_ITEM_TYPE itemType)

Add additional menu handler.

Parameters:

handler - Menu handler

itemType - Tree item type

getNodeMenuRights

NaviMenuRights getNodeMenuRights(NavigationElement.TREE_ITEM_TYPE itemType,
                                 NaviTreeNode node)

Reads the rights for the given tree item type.

Parameters:

itemType - Tree item type

node - navigation node

Returns:

Rights

setSimpleEFileChildren

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.

Parameters:

value - True for simple eFile children.

getSimpleEFileChildren

boolean getSimpleEFileChildren()

Returns:

True, if simple eFile children set.