Package com.saperion.ngc.events

Interface EventChild

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.List<java.lang.String> ALL_EVENTS
      All events.
      static java.lang.String ON_ADD_LINK
      Unused.
      static java.lang.String ON_ADD_LOOKUP
      Event used to create new lookup items.
      static java.lang.String ON_ADD_TO_FAVORITES
      Event sent by result list to add a query to the favorites.
      static java.lang.String ON_AFTER_QUERY
      Event fired by result list after a query was performed.
      static java.lang.String ON_BUTTON
      Event sent when the user clicks on a button in a form.
      static java.lang.String ON_BUTTON_QUERY
      Event sent by query-button in a form to start a query.
      static java.lang.String ON_CANCEL
      Event sent when the user clicked cancel in a form popup window.
      static java.lang.String ON_CANCEL_AND
      Event sent when the user clicked on a cancel-and-button in a form popup window.
      static java.lang.String ON_CANCEL_EDIT
      Event sent when the user clicks on a cancel button in an index mask.
      static java.lang.String ON_CHANGE_DOCUMENT_SECURITY
      Event sent by result list to edit the ACLs of a document.
      static java.lang.String ON_CHANGE_FOLDER_SECURITY
      Event sent by navigation to edit the ACLs of a folder.
      static java.lang.String ON_CLEAR
      Unused.
      static java.lang.String ON_DELETE_SELECTED
      Event sent by result list to delete an item.
      static java.lang.String ON_DISPLAY_POPUP
      Event sent by the result list to open the document in the viewer-popup.
      static java.lang.String ON_DISPLAY_RESULTITEM
      Event sent by result list when the user clicks on an item to open the document in the viewer.
      static java.lang.String ON_DISPLAY_TEMPORARY_DOCUMENT
      Event sent to the viewer in an index-form to display a document that was not yet archived.
      static java.lang.String ON_DOCUMENT_ADDED
      Event fired when a new document was added successfully.
      static java.lang.String ON_DOCUMENT_CHECK
      Event sent by result list to check-out or check-in an item.
      static java.lang.String ON_DOCUMENT_FILING
      Event sent when a document is filed in a folder.
      static java.lang.String ON_DOCUMENT_LOCKED
      Event sent to notify other components when a document was locked.
      static java.lang.String ON_DOCUMENT_PROLONG_RETENTION
      Event sent by result list to prolong the retention of a document.
      static java.lang.String ON_DOCUMENT_REDUCE_DISPOSITION
      Event sent by result list to reduce the dispositiontime of a document.
      static java.lang.String ON_DOCUMENT_RELEASE
      Event sent by result list to release a revision.
      static java.lang.String ON_DOWNLOAD_RESULTITEM
      Event sent by result list to start a download.
      static java.lang.String ON_EDIT_CONTENT
      Event sent by the result list to start, cancel or finish the editing of a document (annotations).
      static java.lang.String ON_EDIT_FOLDER
      Event used to show an index form for a folder's properties.
      static java.lang.String ON_EDIT_ITEM
      Event sent to a form to show an index-form to edit a folder or lookup-item.
      static java.lang.String ON_EDIT_ITEM_SELECTED
      Event sent by result list to edit the index-data of an item in the list (only for lookups).
      static java.lang.String ON_EDIT_LOOKUP
      Event used to edit lookup items.
      static java.lang.String ON_EDIT_SELECTED
      Event sent by result list to edit the index-data of an item in the list (not for lookups).
      static java.lang.String ON_EDIT_STRUCTURE
      Event fired when the user clicks on the edit structure menu item in result list.
      static java.lang.String ON_EXPORT
      Event is fired to trigger an export in the result list.
      static java.lang.String ON_EXTERNAL_STORAGE_UPLOAD
      Event fired by clicking on upload to External Storage for a document in resultlist Can be handled by a custom event listener on ResultSetView.
      static java.lang.String ON_EXTERNAL_STORAGE_UPLOAD_STATUS
      Event fired if uploading a document to External Storage is done or failed Can be handled by a custom event listener on ResultSetView.
      static java.lang.String ON_FAST_ACCESS_DRAG_OVER
      Event sent when something is dragged over a fast access item.
      static java.lang.String ON_FIELD_CHANGE
      Event sent by a field in a form when it's value is changed.
      static java.lang.String ON_FILE_ACTION
      Event used to perform actions like create, edit, delete on an eFile.
      static java.lang.String ON_FILE_PREVIEW
      Event used to show an eFiles index data in a preview-form.
      static java.lang.String ON_FILE_SEARCH
      Unused.
      static java.lang.String ON_FORM_CREATED
      Event sent by an iForm when the form was created.
      static java.lang.String ON_FORM_RENDER_ERROR
      Event sent by an iForm when the form in a popup failed to render.
      static java.lang.String ON_FORWARD
      Unused.
      static java.lang.String ON_IGNORE
      Unused.
      static java.lang.String ON_INDEX
      Unused.
      static java.lang.String ON_INDEX_CLEAR
      Event sent by clear-fields-button in a form to clear all fields.
      static java.lang.String ON_INDEX_RESULTITEM
      Event sent by result list when the selected item is changed.
      static java.lang.String ON_ITEM_DOUBLECLICK
      Event fired when the user double-clicks on an item in the result list.
      static java.lang.String ON_LAUNCH_WORKFLOW
      Event sent by result list to launch a workflow.
      static java.lang.String ON_LOG
      Event used to add a message to the log.
      static java.lang.String ON_LOGON
      Event sent to logon or logoff a user.
      static java.lang.String ON_MACRO
      Unused.
      static java.lang.String ON_NAVIGATION
      Navigation event (unused).
      static java.lang.String ON_NAVIGATION_FOLDER
      Event sent by navigation view when the user clicks on a folder.
      static java.lang.String ON_NAVIGATION_FORM
      Event sent by navigation view when the user clicks on an application-node.
      static java.lang.String ON_NAVIGATION_WEBPART
      Event sent by navigation view when the user clicks on a webpart-node.
      static java.lang.String ON_NEW_ITEM
      Event sent to a form to show an index-form to create a new folder or lookup-item.
      static java.lang.String ON_NEW_SELECTED
      Event sent by result list when the user wants to create a new item.
      static java.lang.String ON_OK
      Event sent when the user clicked ok in a form popup window.
      static java.lang.String ON_ONEDRIVE_LOGIN
      Event fired if a user needs to log in for performing any operation related to OneDrive in resultlist Can be handled by a custom event listener on ResultSetView.
      static java.lang.String ON_OPEN_INDEX_MASK
      Event used to open an index form in a popup.
      static java.lang.String ON_OPEN_MASK
      Event sent to iForm view to open a form (unused).
      static java.lang.String ON_OPEN_QUERY_MASK
      Event used to open an query form in a popup.
      static java.lang.String ON_PASSWORD_EXPIRED
      Event is fired when the user logs on with an expired password.
      static java.lang.String ON_PRINT_DOCUMENTS
      Event sent by the result list to print documents.
      static java.lang.String ON_QUERY
      Unused.
      static java.lang.String ON_QUERY_FAVORITE
      Event sent by navigation view to open a favorite-node.
      static java.lang.String ON_REFRESH
      Event used to refresh the contents of a result list.
      static java.lang.String ON_REFRESH_FOLDER
      Event used to refresh a folder in the navigation.
      static java.lang.String ON_RESET_GUI
      Event sent by login view when a new user logs on.
      static java.lang.String ON_REVISION_CREATED
      Event is fired when a new document revision is created in back end.
      static java.lang.String ON_SAVE_AND
      Unused.
      static java.lang.String ON_SAVE_DOC
      Event fired when the save button is clicked.
      static java.lang.String ON_SAVE_FOLDER
      Event used to save a folder's properties.
      static java.lang.String ON_SCROLL_NODE
      Scroll node event (unused).
      static java.lang.String ON_SELECT_TREE_ITEM
      Event sent by iForm to select an item in the navigation tree (only for workflow).
      static java.lang.String ON_SELECTDDC
      Event sent to iForm to open a system form (unused).
      static java.lang.String ON_SEND_MAIL_RESULTITEM
      Event sent by the result list to send items by mail.
      static java.lang.String ON_SET_LITIGATION_HOLD
      Event sent by result list to set litigation hold of a document.
      static java.lang.String ON_SHAREBASE_DOCUMENT_CHECK
      Event sent by result list to check-out or check-in an item.
      static java.lang.String ON_SHAREBASE_LOGIN
      Event fired if a user needs to log in for uploading a document to ShareBase in resultlist Can be handled by a custom event listener on ResultSetView.
      static java.lang.String ON_START_WORKFLOW
      Event sent by result list to start a workflow (shows definition selection dialog).
      static java.lang.String ON_TAB_SELECTED
      Event used to synchronize the navigation- and the main-tab-view.
      static java.lang.String ON_UNDELETE_SELECTED
      Event sent by result list to un-delete an item.
      static java.lang.String ON_UPLOAD_DOCUMENT
      Event used to upload new documents.
      static java.lang.String ON_UPLOAD_EXTERNAL_STORAGE_DOCUMENT
      Event used to upload new External Storage documents.
      static java.lang.String ON_UPLOAD_SUCCESS
      Event sent when uploading a document succeeded.
      static java.lang.String ON_VARIABLES_AVAILABLE
      Event is fired when a field can pull it's value from document variables.
      static java.lang.String ON_WF
      Unused.
      static java.lang.String ON_WF_COMMENT_DIALOG_CANCEL
      Unused.
      static java.lang.String ON_WF_COMMENT_DIALOG_OK
      Unused.
      static java.lang.String ON_WFCOMMENTS
      Unused.
      static java.lang.String ON_WFDELEGATE
      Unused.
      static java.lang.String ON_WFFORWARD
      Unused.
      static java.lang.String ON_WFFORWARD1
      Unused.
      static java.lang.String ON_WFFORWARD2
      Unused.
      static java.lang.String ON_WFFORWARD3
      Unused.
      static java.lang.String ON_WFFORWARD4
      Unused.
      static java.lang.String ON_WFFORWARD5
      Unused.
      static java.lang.String ON_WFHISTORY
      Unused.
      static java.lang.String ON_WFPUTBACK
      Unused.
      static java.lang.String ON_WFREMINDER
      Unused.
      static java.lang.String ON_WFTAKE
      Unused.
      static java.lang.String ON_WORKFLOW_ACTION
      Event sent by result list to perform a workflow-action.
      static java.lang.String ON_WORKFLOW_COMMENT
      Event sent by result list to handle workflow-comments.
      static java.lang.String ON_WORKFLOW_DISPLAY_COMMENT
      Event sent by result list to display workflow-comments.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Set<org.zkoss.zk.ui.Component> getEventtarget​(java.lang.String eventName)
      Reads the event target for the given event name, if set or the root element.
      void setEventtarget​(org.zkoss.zk.ui.Component comp, java.lang.String eventName)
      Set the event target.

    • Field Detail

      • ON_NAVIGATION

        static final java.lang.String ON_NAVIGATION
        Navigation event (unused).
        See Also:
        Constant Field Values

      • ON_NAVIGATION_WEBPART

        static final java.lang.String ON_NAVIGATION_WEBPART
        Event sent by navigation view when the user clicks on a webpart-node. Handled by MainTabView.
        See Also:
        Constant Field Values

      • ON_OPEN_MASK

        static final java.lang.String ON_OPEN_MASK
        Event sent to iForm view to open a form (unused).
        See Also:
        Constant Field Values

      • ON_SELECTDDC

        static final java.lang.String ON_SELECTDDC
        Event sent to iForm to open a system form (unused).
        See Also:
        Constant Field Values

      • ON_INDEX_CLEAR

        static final java.lang.String ON_INDEX_CLEAR
        Event sent by clear-fields-button in a form to clear all fields. Handled by IntelligentField.
        See Also:
        Constant Field Values

      • ON_BUTTON_QUERY

        static final java.lang.String ON_BUTTON_QUERY
        Event sent by query-button in a form to start a query. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_DISPLAY_RESULTITEM

        static final java.lang.String ON_DISPLAY_RESULTITEM
        Event sent by result list when the user clicks on an item to open the document in the viewer. Handled by DocumentView.
        See Also:
        Constant Field Values

      • ON_DISPLAY_TEMPORARY_DOCUMENT

        static final java.lang.String ON_DISPLAY_TEMPORARY_DOCUMENT
        Event sent to the viewer in an index-form to display a document that was not yet archived. Handled by DocumentView.
        See Also:
        Constant Field Values

      • ON_DISPLAY_POPUP

        static final java.lang.String ON_DISPLAY_POPUP
        Event sent by the result list to open the document in the viewer-popup. Handled by DocumentView.
        See Also:
        Constant Field Values

      • ON_DOWNLOAD_RESULTITEM

        static final java.lang.String ON_DOWNLOAD_RESULTITEM
        Event sent by result list to start a download. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_SEND_MAIL_RESULTITEM

        static final java.lang.String ON_SEND_MAIL_RESULTITEM
        Event sent by the result list to send items by mail. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_START_WORKFLOW

        static final java.lang.String ON_START_WORKFLOW
        Event sent by result list to start a workflow (shows definition selection dialog). Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_LAUNCH_WORKFLOW

        static final java.lang.String ON_LAUNCH_WORKFLOW
        Event sent by result list to launch a workflow. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_WORKFLOW_ACTION

        static final java.lang.String ON_WORKFLOW_ACTION
        Event sent by result list to perform a workflow-action. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_WORKFLOW_COMMENT

        static final java.lang.String ON_WORKFLOW_COMMENT
        Event sent by result list to handle workflow-comments. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_WORKFLOW_DISPLAY_COMMENT

        static final java.lang.String ON_WORKFLOW_DISPLAY_COMMENT
        Event sent by result list to display workflow-comments. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_FIELD_CHANGE

        static final java.lang.String ON_FIELD_CHANGE
        Event sent by a field in a form when it's value is changed. Handled by FormMashup.
        See Also:
        Constant Field Values

      • ON_SELECT_TREE_ITEM

        static final java.lang.String ON_SELECT_TREE_ITEM
        Event sent by iForm to select an item in the navigation tree (only for workflow). Handled by NavigationView.
        See Also:
        Constant Field Values

      • ON_EDIT_CONTENT

        static final java.lang.String ON_EDIT_CONTENT
        Event sent by the result list to start, cancel or finish the editing of a document (annotations). Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_SCROLL_NODE

        static final java.lang.String ON_SCROLL_NODE
        Scroll node event (unused).
        See Also:
        Constant Field Values

      • ON_FORM_RENDER_ERROR

        static final java.lang.String ON_FORM_RENDER_ERROR
        Event sent by an iForm when the form in a popup failed to render. Handled by ResultSetView
        See Also:
        Constant Field Values

      • ON_FAST_ACCESS_DRAG_OVER

        static final java.lang.String ON_FAST_ACCESS_DRAG_OVER
        Event sent when something is dragged over a fast access item. Handled by FastAccessItem.
        See Also:
        Constant Field Values

      • ON_NEW_SELECTED

        static final java.lang.String ON_NEW_SELECTED
        Event sent by result list when the user wants to create a new item. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_NEW_ITEM

        static final java.lang.String ON_NEW_ITEM
        Event sent to a form to show an index-form to create a new folder or lookup-item. Handled by IntelligentFormView.
        See Also:
        Constant Field Values

      • ON_DELETE_SELECTED

        static final java.lang.String ON_DELETE_SELECTED
        Event sent by result list to delete an item. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_UNDELETE_SELECTED

        static final java.lang.String ON_UNDELETE_SELECTED
        Event sent by result list to un-delete an item. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_DOCUMENT_CHECK

        static final java.lang.String ON_DOCUMENT_CHECK
        Event sent by result list to check-out or check-in an item. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_SHAREBASE_DOCUMENT_CHECK

        static final java.lang.String ON_SHAREBASE_DOCUMENT_CHECK
        Event sent by result list to check-out or check-in an item. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_DOCUMENT_RELEASE

        static final java.lang.String ON_DOCUMENT_RELEASE
        Event sent by result list to release a revision. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_CANCEL_EDIT

        static final java.lang.String ON_CANCEL_EDIT
        Event sent when the user clicks on a cancel button in an index mask. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_PRINT_DOCUMENTS

        static final java.lang.String ON_PRINT_DOCUMENTS
        Event sent by the result list to print documents. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_DOCUMENT_FILING

        static final java.lang.String ON_DOCUMENT_FILING
        Event sent when a document is filed in a folder. Handled by NavigationView.
        See Also:
        Constant Field Values

      • ON_WF_COMMENT_DIALOG_OK

        static final java.lang.String ON_WF_COMMENT_DIALOG_OK
        Unused.
        See Also:
        Constant Field Values

      • ON_WF_COMMENT_DIALOG_CANCEL

        static final java.lang.String ON_WF_COMMENT_DIALOG_CANCEL
        Unused.
        See Also:
        Constant Field Values

      • ON_ADD_TO_FAVORITES

        static final java.lang.String ON_ADD_TO_FAVORITES
        Event sent by result list to add a query to the favorites. Handled by NavigationView.
        See Also:
        Constant Field Values

      • ON_CHANGE_DOCUMENT_SECURITY

        static final java.lang.String ON_CHANGE_DOCUMENT_SECURITY
        Event sent by result list to edit the ACLs of a document. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_CHANGE_FOLDER_SECURITY

        static final java.lang.String ON_CHANGE_FOLDER_SECURITY
        Event sent by navigation to edit the ACLs of a folder. Handled by NavigationView.
        See Also:
        Constant Field Values

      • ON_UPLOAD_EXTERNAL_STORAGE_DOCUMENT

        static final java.lang.String ON_UPLOAD_EXTERNAL_STORAGE_DOCUMENT
        Event used to upload new External Storage documents. Handled by IntelligentFormView.
        See Also:
        Constant Field Values

      • ON_UPLOAD_SUCCESS

        static final java.lang.String ON_UPLOAD_SUCCESS
        Event sent when uploading a document succeeded. Handled by NavigationView.
        See Also:
        Constant Field Values

      • ON_EDIT_FOLDER

        static final java.lang.String ON_EDIT_FOLDER
        Event used to show an index form for a folder's properties. Handled by NavigationView.
        See Also:
        Constant Field Values

      • ON_REFRESH_FOLDER

        static final java.lang.String ON_REFRESH_FOLDER
        Event used to refresh a folder in the navigation. Handled by NavigationView.
        See Also:
        Constant Field Values

      • ON_FILE_ACTION

        static final java.lang.String ON_FILE_ACTION
        Event used to perform actions like create, edit, delete on an eFile. Handled by NavigationView.
        See Also:
        Constant Field Values

      • ON_TAB_SELECTED

        static final java.lang.String ON_TAB_SELECTED
        Event used to synchronize the navigation- and the main-tab-view. Handled by NavigationView.
        See Also:
        Constant Field Values

      • ON_DOCUMENT_ADDED

        static final java.lang.String ON_DOCUMENT_ADDED
        Event fired when a new document was added successfully. Can be handled by a custom event listener on an IntelligentFormView.
        See Also:
        Constant Field Values

      • ON_REVISION_CREATED

        static final java.lang.String ON_REVISION_CREATED
        Event is fired when a new document revision is created in back end. Can be handled by a custom event listener on an IntelligentFormView.
        See Also:
        Constant Field Values

      • ON_VARIABLES_AVAILABLE

        static final java.lang.String ON_VARIABLES_AVAILABLE
        Event is fired when a field can pull it's value from document variables. Handled by IntelligentField.
        See Also:
        Constant Field Values

      • ON_PASSWORD_EXPIRED

        static final java.lang.String ON_PASSWORD_EXPIRED
        Event is fired when the user logs on with an expired password. Handled by AuthorizationView.
        See Also:
        Constant Field Values

      • ON_EDIT_STRUCTURE

        static final java.lang.String ON_EDIT_STRUCTURE
        Event fired when the user clicks on the edit structure menu item in result list. Handled by ResultSetView.
        See Also:
        Constant Field Values

      • ON_ITEM_DOUBLECLICK

        static final java.lang.String ON_ITEM_DOUBLECLICK
        Event fired when the user double-clicks on an item in the result list. Can be handled by a custom event listener on ResultSetView.
        See Also:
        Constant Field Values

      • ON_AFTER_QUERY

        static final java.lang.String ON_AFTER_QUERY
        Event fired by result list after a query was performed. Can be handled by a custom event listener on ResultSetView.
        See Also:
        Constant Field Values

      • ON_EXTERNAL_STORAGE_UPLOAD

        static final java.lang.String ON_EXTERNAL_STORAGE_UPLOAD
        Event fired by clicking on upload to External Storage for a document in resultlist Can be handled by a custom event listener on ResultSetView.
        See Also:
        Constant Field Values

      • ON_SHAREBASE_LOGIN

        static final java.lang.String ON_SHAREBASE_LOGIN
        Event fired if a user needs to log in for uploading a document to ShareBase in resultlist Can be handled by a custom event listener on ResultSetView.
        See Also:
        Constant Field Values

      • ON_EXTERNAL_STORAGE_UPLOAD_STATUS

        static final java.lang.String ON_EXTERNAL_STORAGE_UPLOAD_STATUS
        Event fired if uploading a document to External Storage is done or failed Can be handled by a custom event listener on ResultSetView.
        See Also:
        Constant Field Values

      • ON_ONEDRIVE_LOGIN

        static final java.lang.String ON_ONEDRIVE_LOGIN
        Event fired if a user needs to log in for performing any operation related to OneDrive in resultlist Can be handled by a custom event listener on ResultSetView.
        See Also:
        Constant Field Values

      • ON_DOCUMENT_PROLONG_RETENTION

        static final java.lang.String ON_DOCUMENT_PROLONG_RETENTION
        Event sent by result list to prolong the retention of a document. Can be handled by a custom event listener on ResultSetView.
        See Also:
        Constant Field Values

      • ON_DOCUMENT_REDUCE_DISPOSITION

        static final java.lang.String ON_DOCUMENT_REDUCE_DISPOSITION
        Event sent by result list to reduce the dispositiontime of a document. Can be handled by a custom event listener on ResultSetView.
        See Also:
        Constant Field Values

      • ON_SET_LITIGATION_HOLD

        static final java.lang.String ON_SET_LITIGATION_HOLD
        Event sent by result list to set litigation hold of a document. Can be handled by a custom event listener on ResultSetView.
        See Also:
        Constant Field Values

      • ALL_EVENTS

        static final java.util.List<java.lang.String> ALL_EVENTS
        All events.

    • Method Detail

      • setEventtarget

        void setEventtarget​(org.zkoss.zk.ui.Component comp,
                    java.lang.String eventName)
        Set the event target.
        Parameters:
        comp - Event target
        eventName - Event name or null for main target

      • getEventtarget

        java.util.Set<org.zkoss.zk.ui.Component> getEventtarget​(java.lang.String eventName)
        Reads the event target for the given event name, if set or the root element.
        Parameters:
        eventName - Event name or null for main target
        Returns:
        Set of event targets