com.saperion.ngc.events

Class BaseWindow

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

All Implemented Interfaces:

EventChild, EventChildHandler, LogEventChildHandler, 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

Direct Known Subclasses:

AbstractDocumentView, AbstractStructureDialog, IntelligentFormPopupWindow, IntelligentFormViewImpl, LogViewImpl, MainTabViewImpl, MediaViewerImpl, NavigationViewImpl, NewFolderDialog, PdfjsViewerImpl, ResultSetViewImpl, RevisionHistoryDialog, SelectFolderClassDialog, SimpleViewerImpl, UserSelectionDialog, WeblinkHandler

public abstract class BaseWindow
extends org.zkoss.zul.Window
implements EventChild, EventChildHandler

The BaseWindow is the abstract superclass of all window-based components of the webclient that use the default event-handling mechanism. It provides methods to post several types of events.

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

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
BaseWindow()
BaseWindow(String title, String border, boolean closable)

Method Summary

Methods

Modifier and Type	Method and Description
Set<org.zkoss.zk.ui.Component>	getEventtarget(String eventName) Reads the event target for the given event name, if set or the root element.
org.zkoss.zul.Window	getMainWindow()
void	postAddLinkEvent(String name, NavigationNode parent, FolderId destination) Post a AddLinkEvent.
void	postAddToFavoritesEvent(FavoriteQueryInformation favoriteQueryInformation) Posts an add to favorites event.
void	postCancelSelectedEvent(com.saperion.ngc.iform.xml.SaveActionType action) Cancel event.
void	postChangeDocumentSecurityEvent(Set<DocumentId> documentIds, Set<String> acls) Posts a ChangeDocumentSecurityEvent.
void	postChangeFolderSecurityEvent(FolderId folderId, Set<String> acls) Posts a ChangeFolderSecurityEvent.
void	postDeleteSelectedEvent() Delete selected.
void	postDisplayPopupEvent(DocumentId docId, boolean withCtrl, boolean editMode)
void	postDisplayPopupEvent(DocumentId docId, boolean currentRevision, boolean withCtrl, boolean editMode)
void	postDisplayResultItemEvent(DocumentId selectedDocId) Calls EventChildHandler.postDisplayResultItemEvent(int, DocumentId) with all rights enabled.
void	postDisplayResultItemEvent(int maskRights, DocumentId selectedDocId)
void	postDocumentCheckEvent(CheckDataBean.CheckType checkout, DocumentId id) Checkin / checkout selected document.
void	postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, Set<FolderId> folderSysRowIds) Posts a DocumentFilingEvent.
void	postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action, Set<DocumentId> documentIDs, String folderName) Posts a DocumentFilingEvent.
void	postDocumentReleaseEvent(DocumentId id) Release selected document.
void	postDownloadResultItemEvent(List<ResultProperties> items)
void	postEditContentEvent(EditContentEvent.EditContentAction action, DocumentId documentId) Post edit content event.
void	postEditItemSelectedEvent(EditItemSelectedEvent.EditItemEventOrigin origin, String maskName, String ddcName, ResultProperties properties) Edit item event.
void	postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin) Edit event.
void	postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin, boolean readonly) Edit event.
void	postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin, String mask, ResultProperties properties) Edit event.
void	postEditStructureEvent(DocumentId documentId) Posts an edit structure event.
void	postErrorLogEvent(LogMessage message) Posts an event that will create a log-entry at error-level.
void	postErrorLogEvent(LogMessage message, org.zkoss.zk.ui.event.EventListener eventListener) Posts an event that will create a log-entry at error-level.
void	postFieldChangeEvent(ResultProperty property)
void	postFileActionEvent(Map<FolderId,String> folders, FileActionEvent.FileAction action, FolderId fileParent) Posts a file action event.
void	postFileActionEvent(Map<FolderId,String> folders, Map<FolderId,String> masks, FileActionEvent.FileAction action, FolderId fileParent) Posts a file action event.
void	postFormButtonEvent(ButtonInfo info)
void	postIndexResultItemEvent(ResultProperties properties, String componentId)
void	postInfoLogEvent(LogMessage message) Posts an event that will create a log-entry at info-level.
void	postInfoLogEvent(LogMessage message, org.zkoss.zk.ui.event.EventListener eventListener) Posts an event that will create a log-entry at info-level.
void	postLaunchWorkflowEvent(List<String> documentIds, String workflowName, String commentString, List<com.saperion.intf.wf.WorkflowMember> users)
void	postLockDocumentEvent(boolean lock)
void	postLogonEvent(LogonEvent.LogonResult result, String userName)
void	postLogonEvent(LogonEvent.LogonResult result, String userName, boolean bIsSSOUser)
void	postNavigationFolderEvent(FolderNode node, boolean close)
void	postNavigationFormEvent(MaskInfoBean infoBean, boolean close)
void	postNavigationFormEvent(MaskInfoBean infoBean, FolderSearchInfos infos, boolean close)
void	postNavigationWebpartEvent(String adress, String name, boolean close)
void	postNewSelectedEvent(NewSelectedEvent.NewEventOrigin origin, String maskName, String ddcName, FormMode mode) New event.
void	postOpenMaskEvent(String formName, String sysRowId) Post open mask event.
void	postPrintDocumentEvent(List<ResultProperties> rows) Posts a print-document-event.
void	postQueryFavoriteEvent(Favorites favorites, boolean close) Posts an on query favorite event.
void	postRefreshEvent() Posts a refresh event.
void	postResetGuiEvent() Post reset GUI event.
void	postResultFieldEvent(ResultFieldEventBean bean)
void	postSaveDocumentEvent(ResultFieldEventBean bean)
void	postSaveDocumentEvent(ResultFieldEventBean bean, Set<String> acls, String comment, Map<String,DocumentVariable> variables)
void	postSelectTreeItemEvent(FolderId folderId, SelectTreeItemEvent.Destination type)
void	postSendMailResultItemEvent(MailSendType mailSendType, ResultProperties item, MailContentType mailContentType)
void	postStartWorkflowEvent(List<String> documentIds)
void	postTabSelectedEvent(FolderId folderId, MainTabView.MTVTabType tabType, IntelligentFormView formView) Posts a tab selected event.
void	postUnDeleteSelectedEvent() Undelete selected.
void	postUploadDocumentEvent(FolderUploadInfos uploadInfos) Posts an upload document event.
void	postUploadSuccessEvent(FolderId folderId) Posts an upload success event.
void	postWarningLogEvent(LogMessage message) Posts an event that will create a log-entry at warning-level.
void	postWarningLogEvent(LogMessage message, org.zkoss.zk.ui.event.EventListener eventListener) Posts an event that will create a log-entry at warning-level.
void	postWorkflowActionEvent(List<DocumentId> tasks, com.saperion.intf.wf.CommandInfo info, List<String> actors, String commentString, Date actionDate)
void	postWorkflowCommentEvent(List<DocumentId> tasks)
void	setEventtarget(org.zkoss.zk.ui.Component comp, String eventName) Set the event target.

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

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, 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, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, 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 org.zkoss.zk.ui.IdSpace

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

Constructor Detail

BaseWindow

public BaseWindow()

BaseWindow

public BaseWindow(String title,
          String border,
          boolean closable)

Parameters:

title - Title

border - Border

closable - Closable

Method Detail

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:

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

Parameters:

comp - Event target

eventName - Event name or null for main target

See Also:

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

postWorkflowActionEvent

public void postWorkflowActionEvent(List<DocumentId> tasks,
                           com.saperion.intf.wf.CommandInfo info,
                           List<String> actors,
                           String commentString,
                           Date actionDate)

Specified by:

postWorkflowActionEvent in interface EventChildHandler

Parameters:

tasks - Task info

info - Command info

actors - Actor

commentString - Comment

actionDate - Action date

See Also:

EventChildHandler.postWorkflowActionEvent(java.util.List, com.saperion.intf.wf.CommandInfo, java.util.List, java.lang.String, java.util.Date)

postWorkflowCommentEvent

public void postWorkflowCommentEvent(List<DocumentId> tasks)

Specified by:

postWorkflowCommentEvent in interface EventChildHandler

Parameters:

tasks - Task info

See Also:

EventChildHandler.postWorkflowCommentEvent(java.util.List)

postDisplayPopupEvent

public void postDisplayPopupEvent(DocumentId docId,
                         boolean withCtrl,
                         boolean editMode)

Specified by:

postDisplayPopupEvent in interface EventChildHandler

Parameters:

docId - Document id

withCtrl - With CTRL

editMode - edit mode

See Also:

EventChildHandler.postDisplayPopupEvent(com.saperion.ngc.model.document.DocumentId, boolean, boolean)

postDisplayPopupEvent

public void postDisplayPopupEvent(DocumentId docId,
                         boolean currentRevision,
                         boolean withCtrl,
                         boolean editMode)

Specified by:

postDisplayPopupEvent in interface EventChildHandler

Parameters:

docId - Document id

currentRevision - currentRevision

withCtrl - With CTRL

editMode - edit mode

See Also:

EventChildHandler.postDisplayPopupEvent(com.saperion.ngc.model.document.DocumentId, boolean, boolean)

postDisplayResultItemEvent

public void postDisplayResultItemEvent(int maskRights,
                              DocumentId selectedDocId)

Specified by:

postDisplayResultItemEvent in interface EventChildHandler

Parameters:

maskRights - rights enabled in the mask

selectedDocId - selected item's id

See Also:

EventChildHandler.postDisplayResultItemEvent(int, com.saperion.ngc.model.document.DocumentId)

postDisplayResultItemEvent

public void postDisplayResultItemEvent(DocumentId selectedDocId)

Calls EventChildHandler.postDisplayResultItemEvent(int, DocumentId) with all rights enabled.

Specified by:

postDisplayResultItemEvent in interface EventChildHandler

Parameters:

selectedDocId - selected item's ID

See Also:

(com.saperion.ngc.model.document.DocumentId)

postIndexResultItemEvent

public void postIndexResultItemEvent(ResultProperties properties,
                            String componentId)

Specified by:

postIndexResultItemEvent in interface EventChildHandler

Parameters:

properties - Properties

componentId - id of the component firing this event

See Also:

(com.saperion.ngc.model.resultset.ResultProperties,java.lang.String)

postLockDocumentEvent

public void postLockDocumentEvent(boolean lock)

Specified by:

postLockDocumentEvent in interface EventChildHandler

Parameters:

lock - Lock

See Also:

EventChildHandler.postLockDocumentEvent(boolean)

postNewSelectedEvent

public void postNewSelectedEvent(NewSelectedEvent.NewEventOrigin origin,
                        String maskName,
                        String ddcName,
                        FormMode mode)

New event.

Specified by:

postNewSelectedEvent in interface EventChildHandler

Parameters:

origin - event origin

maskName - Mask name

ddcName - DDC name

mode - Form mode

See Also:

(com.saperion.ngc.events.resultset.NewSelectedEvent.NewEventOrigin, java.lang.String, java.lang.String, com.saperion.ngc.iform.FormMode)

postEditItemSelectedEvent

public void postEditItemSelectedEvent(EditItemSelectedEvent.EditItemEventOrigin origin,
                             String maskName,
                             String ddcName,
                             ResultProperties properties)

Edit item event.

Specified by:

postEditItemSelectedEvent in interface EventChildHandler

Parameters:

origin - event origin

maskName - Mask name

ddcName - DDC name

properties - Properties

See Also:

(com.saperion.ngc.events.resultset.EditItemSelectedEvent.EditItemEventOrigin, java.lang.String, java.lang.String, com.saperion.ngc.model.resultset.ResultProperties)

postEditSelectedEvent

public void postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin)

Edit event.

Specified by:

postEditSelectedEvent in interface EventChildHandler

Parameters:

origin - event origin

See Also:

#postEditSelectedEvent(com.saperion.ngc.events.resultset.EditSelectedEvent.EditEventOrigin)

postEditSelectedEvent

public void postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin,
                         boolean readonly)

Edit event.

Specified by:

postEditSelectedEvent in interface EventChildHandler

Parameters:

origin - event origin

readonly - if true index data will be shown but cannot be edited

See Also:

#postEditSelectedEvent(com.saperion.ngc.events.resultset.EditSelectedEvent.EditEventOrigin, boolean)

postEditSelectedEvent

public void postEditSelectedEvent(EditSelectedEvent.EditEventOrigin origin,
                         String mask,
                         ResultProperties properties)

Edit event.

Specified by:

postEditSelectedEvent in interface EventChildHandler

Parameters:

origin - event origin

mask - name of the mask to use

properties - properties of the document to edit

See Also:

(com.saperion.ngc.events.resultset.EditSelectedEvent.EditEventOrigin, java.lang.String, com.saperion.ngc.model.resultset.ResultProperties)

postResultFieldEvent

public void postResultFieldEvent(ResultFieldEventBean bean)

Specified by:

postResultFieldEvent in interface EventChildHandler

Parameters:

bean - Result field bean

See Also:

#postResultFieldEvent(com.saperion.ngc.events.iform.ResultFieldEventBean)

postSaveDocumentEvent

public void postSaveDocumentEvent(ResultFieldEventBean bean)

Specified by:

postSaveDocumentEvent in interface EventChildHandler

Parameters:

bean - Result field bean

See Also:

#postSaveDocumentEvent(com.saperion.ngc.events.iform.ResultFieldEventBean)

postSaveDocumentEvent

public void postSaveDocumentEvent(ResultFieldEventBean bean,
                         Set<String> acls,
                         String comment,
                         Map<String,DocumentVariable> variables)

Specified by:

postSaveDocumentEvent in interface EventChildHandler

Parameters:

bean - Result field bean

acls - ACLs to use when saving (comma-separated string)

comment - the comment for the new revisionw

variables - the variables to add to the document

See Also:

(com.saperion.ngc.events.iform.ResultFieldEventBean, java.util.Set, java.lang.String, java.util.Map)

postDeleteSelectedEvent

public void postDeleteSelectedEvent()

Delete selected.

Specified by:

postDeleteSelectedEvent in interface EventChildHandler

See Also:

EventChildHandlerImpl.postDeleteSelectedEvent()

postUnDeleteSelectedEvent

public void postUnDeleteSelectedEvent()

Undelete selected.

Specified by:

postUnDeleteSelectedEvent in interface EventChildHandler

See Also:

EventChildHandlerImpl.postUnDeleteSelectedEvent()

postDocumentCheckEvent

public void postDocumentCheckEvent(CheckDataBean.CheckType checkout,
                          DocumentId id)

Checkin / checkout selected document.

Specified by:

postDocumentCheckEvent in interface EventChildHandler

Parameters:

checkout - Checkout / checkin type

id - Document id

See Also:

EventChildHandler.postDocumentCheckEvent(com.saperion.ngc.events.CheckDataBean.CheckType, com.saperion.ngc.model.document.DocumentId)

postDocumentReleaseEvent

public void postDocumentReleaseEvent(DocumentId id)

Release selected document.

Specified by:

postDocumentReleaseEvent in interface EventChildHandler

Parameters:

id - Document id to release

See Also:

EventChildHandler.postDocumentReleaseEvent(com.saperion.ngc.model.document.DocumentId)

postDownloadResultItemEvent

public void postDownloadResultItemEvent(List<ResultProperties> items)

Specified by:

postDownloadResultItemEvent in interface EventChildHandler

Parameters:

items - items to download

See Also:

EventChildHandler.postDownloadResultItemEvent(java.util.List)

postSendMailResultItemEvent

public void postSendMailResultItemEvent(MailSendType mailSendType,
                               ResultProperties item,
                               MailContentType mailContentType)

Specified by:

postSendMailResultItemEvent in interface EventChildHandler

Parameters:

mailSendType - mail send type

item - item to send per mail

mailContentType - mail content type

See Also:

EventChildHandler.postSendMailResultItemEvent(com.saperion.ngc.mail.MailSendType, com.saperion.ngc.model.resultset.ResultProperties, com.saperion.ngc.mail.MailContentType)

postFormButtonEvent

public void postFormButtonEvent(ButtonInfo info)

Specified by:

postFormButtonEvent in interface EventChildHandler

Parameters:

info - Button info

See Also:

EventChildHandlerImpl.postFormButtonEvent(com.saperion.ngc.iform.button.ButtonInfo)

postLaunchWorkflowEvent

public void postLaunchWorkflowEvent(List<String> documentIds,
                           String workflowName,
                           String commentString,
                           List<com.saperion.intf.wf.WorkflowMember> users)

Specified by:

postLaunchWorkflowEvent in interface EventChildHandler

Parameters:

documentIds - Document id's

workflowName - Workflow name

commentString - Comment string

users - Users

See Also:

EventChildHandlerImpl.postLaunchWorkflowEvent(java.util.List, java.lang.String, java.lang.String, java.util.List)

postStartWorkflowEvent

public void postStartWorkflowEvent(List<String> documentIds)

Specified by:

postStartWorkflowEvent in interface EventChildHandler

Parameters:

documentIds - Document IDs

See Also:

EventChildHandler.postStartWorkflowEvent(java.util.List)

postNavigationFormEvent

public void postNavigationFormEvent(MaskInfoBean infoBean,
                           boolean close)

Specified by:

postNavigationFormEvent in interface EventChildHandler

Parameters:

infoBean - Mask info bean

close - Close tab

See Also:

EventChildHandler.postNavigationFormEvent(com.saperion.ngc.events.MaskInfoBean, boolean)

postNavigationFormEvent

public void postNavigationFormEvent(MaskInfoBean infoBean,
                           FolderSearchInfos infos,
                           boolean close)

Specified by:

postNavigationFormEvent in interface EventChildHandler

Parameters:

infoBean - Mask info bean

infos - folder search infos (to search within a folder)

close - Close tab

See Also:

EventChildHandler.postNavigationFormEvent(com.saperion.ngc.events.MaskInfoBean, com.saperion.ngc.events.navigation.FolderSearchInfos, boolean)

postNavigationFolderEvent

public void postNavigationFolderEvent(FolderNode node,
                             boolean close)

Specified by:

postNavigationFolderEvent in interface EventChildHandler

Parameters:

node - Navigation folder node

close - Close tab

See Also:

#postNavigationFolderEvent(com.saperion.ngc.model.navigation.FolderNode, boolean)

postNavigationWebpartEvent

public void postNavigationWebpartEvent(String adress,
                              String name,
                              boolean close)

Specified by:

postNavigationWebpartEvent in interface EventChildHandler

Parameters:

adress - Webpart adress

name - Name

close - Close tab

See Also:

EventChildHandler.postNavigationWebpartEvent(java.lang.String, java.lang.String, boolean)

postFieldChangeEvent

public void postFieldChangeEvent(ResultProperty property)

Specified by:

postFieldChangeEvent in interface EventChildHandler

Parameters:

property - Property

See Also:

EventChildHandler.postFieldChangeEvent(com.saperion.ngc.model.resultset.ResultProperty)

postLogonEvent

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

Specified by:

postLogonEvent in interface EventChildHandler

Parameters:

result - Logon result

userName - User name

See Also:

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

postLogonEvent

public void postLogonEvent(LogonEvent.LogonResult result,
                  String userName,
                  boolean bIsSSOUser)

Specified by:

postLogonEvent in interface EventChildHandler

Parameters:

result - Logon result

userName - User name

bIsSSOUser - indicate SSOUser

See Also:

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

postCancelSelectedEvent

public void postCancelSelectedEvent(com.saperion.ngc.iform.xml.SaveActionType action)

Cancel event.

Specified by:

postCancelSelectedEvent in interface EventChildHandler

Parameters:

action - save action

See Also:

EventChildHandler.postCancelSelectedEvent(com.saperion.ngc.iform.xml.SaveActionType)

postSelectTreeItemEvent

public void postSelectTreeItemEvent(FolderId folderId,
                           SelectTreeItemEvent.Destination type)

Specified by:

postSelectTreeItemEvent in interface EventChildHandler

Parameters:

folderId - folderId or null, if not needed

type - Destination type

See Also:

EventChildHandler.postSelectTreeItemEvent(com.saperion.ngc.model.FolderId, com.saperion.ngc.events.navigation.SelectTreeItemEvent.Destination)

postResetGuiEvent

public void postResetGuiEvent()

Post reset GUI event.

Specified by:

postResetGuiEvent in interface EventChildHandler

See Also:

EventChildHandler.postResetGuiEvent()

postEditContentEvent

public void postEditContentEvent(EditContentEvent.EditContentAction action,
                        DocumentId documentId)

Post edit content event.

Specified by:

postEditContentEvent in interface EventChildHandler

Parameters:

action - edit action

documentId - document id

See Also:

EventChildHandler.postEditContentEvent(com.saperion.ngc.events.resultset.EditContentEvent.EditContentAction, com.saperion.ngc.model.document.DocumentId)

postAddToFavoritesEvent

public void postAddToFavoritesEvent(FavoriteQueryInformation favoriteQueryInformation)

Posts an add to favorites event.

Specified by:

postAddToFavoritesEvent in interface EventChildHandler

Parameters:

favoriteQueryInformation - FavoriteQueryInformation

See Also:

(com.saperion.ngc.favorites.FavoriteQueryInformation)

postQueryFavoriteEvent

public void postQueryFavoriteEvent(Favorites favorites,
                          boolean close)

Posts an on query favorite event.

Specified by:

postQueryFavoriteEvent in interface EventChildHandler

Parameters:

favorites - Favorites

close - Close tab

See Also:

EventChildHandler.postQueryFavoriteEvent(com.saperion.ngc.favorites.xml.Favorites, boolean)

postDocumentFilingEvent

public void postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action,
                           Set<DocumentId> documentIDs,
                           Set<FolderId> folderSysRowIds)

Posts a DocumentFilingEvent.

Specified by:

postDocumentFilingEvent in interface EventChildHandler

Parameters:

action - action to perform

documentIDs - document IDs

folderSysRowIds - folder sysrowids

See Also:

(com.saperion.ngc.events.navigation.DocumentFilingEvent.DocumentFilingAction, java.util.Set, java.util.Set)

postDocumentFilingEvent

public void postDocumentFilingEvent(DocumentFilingEvent.DocumentFilingAction action,
                           Set<DocumentId> documentIDs,
                           String folderName)

Posts a DocumentFilingEvent.

Specified by:

postDocumentFilingEvent in interface EventChildHandler

Parameters:

action - action to perform.

documentIDs - document IDs

folderName - name for new folder

See Also:

#postDocumentFilingEvent(com.saperion.ngc.events.navigation.DocumentFilingEvent.DocumentFilingAction, java.util.Set, java.lang.String)

postChangeDocumentSecurityEvent

public void postChangeDocumentSecurityEvent(Set<DocumentId> documentIds,
                                   Set<String> acls)

Posts a ChangeDocumentSecurityEvent.

Specified by:

postChangeDocumentSecurityEvent in interface EventChildHandler

Parameters:

documentIds - document ids

acls - set of acl names

See Also:

(java.util.Set, java.util.Set)

postChangeFolderSecurityEvent

public void postChangeFolderSecurityEvent(FolderId folderId,
                                 Set<String> acls)

Posts a ChangeFolderSecurityEvent.

Specified by:

postChangeFolderSecurityEvent in interface EventChildHandler

Parameters:

folderId - folder id

acls - set of ACL names

See Also:

EventChildHandler.postChangeFolderSecurityEvent(com.saperion.ngc.model.FolderId, java.util.Set)

postAddLinkEvent

public void postAddLinkEvent(String name,
                    NavigationNode parent,
                    FolderId destination)

Post a AddLinkEvent.

Specified by:

postAddLinkEvent in interface EventChildHandler

Parameters:

name - Name

parent - Parent

destination - Destination

See Also:

EventChildHandler.postAddLinkEvent(java.lang.String, com.saperion.ngc.model.navigation.intf.NavigationNode, com.saperion.ngc.model.FolderId)

postRefreshEvent

public void postRefreshEvent()

Posts a refresh event.

Specified by:

postRefreshEvent in interface EventChildHandler

See Also:

EventChildHandler.postRefreshEvent()

postErrorLogEvent

public void postErrorLogEvent(LogMessage message)

Posts an event that will create a log-entry at error-level. A messagebox with the provided log-message will be shown.

Specified by:

postErrorLogEvent in interface LogEventChildHandler

Parameters:

message - error message

See Also:

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

postInfoLogEvent

public void postInfoLogEvent(LogMessage message)

Posts an event that will create a log-entry at info-level. A messagebox with the provided log-message will be shown only when forced by the log-message.

Specified by:

postInfoLogEvent in interface LogEventChildHandler

Parameters:

message - info message

See Also:

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

postWarningLogEvent

public void postWarningLogEvent(LogMessage message)

Posts an event that will create a log-entry at warning-level. A messagebox with the provided log-message will be shown only when forced by the log-message.

Specified by:

postWarningLogEvent in interface LogEventChildHandler

Parameters:

message - warning message

See Also:

LogEventChildHandler.postWarningLogEvent(com.saperion.ngc.service.LogMessage)

postErrorLogEvent

public void postErrorLogEvent(LogMessage message,
                     org.zkoss.zk.ui.event.EventListener eventListener)

Posts an event that will create a log-entry at error-level. A messagebox with the provided log-message will be shown.

Specified by:

postErrorLogEvent in interface LogEventChildHandler

Parameters:

message - error message

eventListener - listener that will be called when the messagebox caused by this event is closed

See Also:

LogEventChildHandler.postErrorLogEvent(com.saperion.ngc.service.LogMessage, org.zkoss.zk.ui.event.EventListener)

postInfoLogEvent

public void postInfoLogEvent(LogMessage message,
                    org.zkoss.zk.ui.event.EventListener eventListener)

Posts an event that will create a log-entry at info-level. A messagebox with the provided log-message will be shown only when forced by the log-message.

Specified by:

postInfoLogEvent in interface LogEventChildHandler

Parameters:

message - info message

eventListener - listener that will be called when the messagebox caused by this event is closed

See Also:

LogEventChildHandler.postInfoLogEvent(com.saperion.ngc.service.LogMessage, org.zkoss.zk.ui.event.EventListener)

postWarningLogEvent

public void postWarningLogEvent(LogMessage message,
                       org.zkoss.zk.ui.event.EventListener eventListener)

Posts an event that will create a log-entry at warning-level. A messagebox with the provided log-message will be shown only when forced by the log-message.

Specified by:

postWarningLogEvent in interface LogEventChildHandler

Parameters:

message - warning message

eventListener - listener that will be called when the messagebox caused by this event is closed

See Also:

LogEventChildHandler.postWarningLogEvent(com.saperion.ngc.service.LogMessage, org.zkoss.zk.ui.event.EventListener)

postUploadDocumentEvent

public void postUploadDocumentEvent(FolderUploadInfos uploadInfos)

Posts an upload document event.

Specified by:

postUploadDocumentEvent in interface EventChildHandler

Parameters:

uploadInfos - infos about the upload operation

See Also:

(com.saperion.ngc.model.navigation.FolderUploadInfos)

postUploadSuccessEvent

public void postUploadSuccessEvent(FolderId folderId)

Posts an upload success event.

Specified by:

postUploadSuccessEvent in interface EventChildHandler

Parameters:

folderId - id of the folder the document was filed in

See Also:

EventChildHandler.postUploadSuccessEvent(com.saperion.ngc.model.FolderId)

postOpenMaskEvent

public void postOpenMaskEvent(String formName,
                     String sysRowId)

Post open mask event.

Specified by:

postOpenMaskEvent in interface EventChildHandler

Parameters:

formName - Form name

sysRowId - SysRowId for selection

See Also:

EventChildHandler.postOpenMaskEvent(java.lang.String, java.lang.String)

postFileActionEvent

public void postFileActionEvent(Map<FolderId,String> folders,
                       FileActionEvent.FileAction action,
                       FolderId fileParent)

Posts a file action event.

Specified by:

postFileActionEvent in interface EventChildHandler

Parameters:

folders - map with ids and class names of the selected folders

action - file item action

fileParent - id of the parent node for the file

See Also:

EventChildHandler.postFileActionEvent(java.util.Map, com.saperion.ngc.events.resultset.FileActionEvent.FileAction, com.saperion.ngc.model.FolderId)

postFileActionEvent

public void postFileActionEvent(Map<FolderId,String> folders,
                       Map<FolderId,String> masks,
                       FileActionEvent.FileAction action,
                       FolderId fileParent)

Posts a file action event.

Specified by:

postFileActionEvent in interface EventChildHandler

Parameters:

folders - map with ids and class names of the selected folders

masks - map with ids and query mask names of the selected folders. Query mask names will override the query masks set in the classes.

action - file item action

fileParent - id of the parent node for the file

See Also:

EventChildHandler.postFileActionEvent(java.util.Map, com.saperion.ngc.events.resultset.FileActionEvent.FileAction, com.saperion.ngc.model.FolderId)

postTabSelectedEvent

public void postTabSelectedEvent(FolderId folderId,
                        MainTabView.MTVTabType tabType,
                        IntelligentFormView formView)

Posts a tab selected event.

Specified by:

postTabSelectedEvent in interface EventChildHandler

Parameters:

folderId - folder id

tabType - tab type

formView - The intelligent form contained in the selected tab.

See Also:

EventChildHandler.postTabSelectedEvent(FolderId, MainTabView.MTVTabType, IntelligentFormView)

postPrintDocumentEvent

public void postPrintDocumentEvent(List<ResultProperties> rows)

Posts a print-document-event.

Specified by:

postPrintDocumentEvent in interface EventChildHandler

Parameters:

rows - rows selected for printing

See Also:

EventChildHandler.postPrintDocumentEvent(java.util.List)

postEditStructureEvent

public void postEditStructureEvent(DocumentId documentId)

Posts an edit structure event.

Specified by:

postEditStructureEvent in interface EventChildHandler

Parameters:

documentId - ID of the document to edit

See Also:

EventChildHandler.postEditStructureEvent(com.saperion.ngc.model.document.DocumentId)

getMainWindow

public org.zkoss.zul.Window getMainWindow()

Returns:

main window of the current session or null if no main window was registered