Package com.saperion.ngc.navigation

Interface NavigationView

All Superinterfaces:
Cloneable, org.zkoss.zk.ui.Component, EventChild, EventChildHandler, LogEventChildHandler, org.zkoss.zk.ui.ext.Scope, 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 Details

  • Method Details

    • 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(String ddc, 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

      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(String ddc, String path, 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

      String getSelectedFolderTable()
      Returns:
      The actual selected folder DDC

    • setNavigationMode

      void setNavigationMode(String mode)
      Sets the navigation mode. Default: 'simple'.
      Parameters:
      mode - 'simple' or 'advanced' to select mode

    • getNavigationMode

      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, 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, String maskName, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> cancelEventListener, 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(String mode)
      Sets the selection mode. Possible values are 'single', 'multi' and 'disabled'.
      Parameters:
      mode - selection mode

    • setFolderTable

      void setFolderTable(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.