Package com.saperion.ngc.viewer

Class DocumentViewImpl

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Window

com.saperion.ngc.events.BaseWindow

com.saperion.ngc.viewer.AbstractDocumentView

com.saperion.ngc.viewer.DocumentViewImpl

All Implemented Interfaces:

EventChild, EventChildHandler, LogEventChildHandler, DocumentView, Serializable, Cloneable, 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.ext.Framable

public class DocumentViewImpl
extends AbstractDocumentView

Component to display documents using ViewOneComponent.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.saperion.ngc.viewer.AbstractDocumentView

AbstractDocumentView.AskForDownloadListener

Nested classes/interfaces inherited from class org.zkoss.zul.Window

org.zkoss.zul.Window.Mode

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

Modifier and Type	Field	Description
static final int	DEFAULT_POPUP_HEIGHT
static final int	DEFAULT_POPUP_WIDTH

Fields inherited from class com.saperion.ngc.viewer.AbstractDocumentView

def, dontAskForDownload, localization, mainLayout, maskRights, maxViewSize, multiDocumentList, structureButtonBox, viewerBean, viewerClass, viewerComp, viewerId, viewerPresenter, zkDownloadMode

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

AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Fields inherited from interface com.saperion.ngc.viewer.DocumentView

EDIT_WINDOW_PREFIX, NO_EXTERNAL_WINDOW, POPUP_BEAN_ATTRIBUTE

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

Constructor Summary

Constructors

Constructor	Description
DocumentViewImpl()	Constructor.
DocumentViewImpl(com.saperion.ngc.iform.xml.ViewerType definition, boolean stretch, com.saperion.ngc.iform.xml.PosType panePos, String viewerClassName)	Constructor for iForm usage.
DocumentViewImpl(String viewerClassName)	Constructor for Standalone Viewer to use individual viewer
DocumentViewImpl(String title, String border, boolean closable)	Constructor with title, border, closable option.

Method Summary

Modifier and Type	Method	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.
void	handleLinkElement(DocumentArchiveMetaInfo.ElementArchiveMetaInfo linkElement)	Handles the viewing of a linked element.
protected void	init()	Initializes the viewer classes by setting things like layout, max view size, max document size and so on.
void	onAppletLoaded(org.zkoss.zk.ui.event.Event event)	Event-handler called when the applet is ready to use.
void	onCreate(org.zkoss.zk.ui.event.Event event)	Event handler for onCreate event.
final void	onDisplayPopup(org.zkoss.zk.ui.event.Event event)	EventHandler for external events.
final void	onDisplayResultItem(org.zkoss.zk.ui.event.Event event)	Display document.
final void	onDisplayTemporaryDocument(org.zkoss.zk.ui.event.Event event)	Event listener method for DisplayTemporaryDocumentEvents.
void	onPageDetached(org.zkoss.zk.ui.Page page)
final void	openDocument(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element)	Opens the specified url and displays the document.
void	openDocument(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements, int element, boolean currentRevision)	Opens the specified url and displays the document.
void	openPopup(DisplayPopupEvent orig, DocumentId id)	openPopup Open a PopUp of Document Viewer.
void	openPopup(DisplayPopupEvent orig, DocumentId id, boolean currentRevision)	openPopup Open a PopUp of Document Viewer.
void	openTemporaryDocument(TemporaryDocumentId documentId)	Opens a temporary document.
void	setEventtarget(org.zkoss.zk.ui.Component comp, String eventName)	Set the event target.

Methods inherited from class com.saperion.ngc.viewer.AbstractDocumentView

canDownload, canModifyDocument, canShowRevisions, canView, disable, enable, enableStructureButtonsWhen, fillStructureView, generateRandomViewerId, getElementMetaInfo, getNativeRequest, getPageListStream, getParentForm, getPresenter, getPropertiesFileName, getStructureList, getViewerClass, hasOpenChanges, inIfomPopup, isEnableLoadingMessage, isSizeLimitEnabled, isStructureButtonsBoxShown, isStructureEnabled, makeViewerBean, onLogon, onResetGui, openSubDocument, refreshView, reset, reset, setEnableLoadingMessage, setPropertiesFileName, setStructureButtonsBoxShown, setStructureEnabled, setViewerClass

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

getMainWindow, postAddLinkEvent, postAddToFavoritesEvent, postCancelSelectedEvent, postChangeDocumentSecurityEvent, postChangeFolderSecurityEvent, postDeleteSelectedEvent, postDisplayPopupEvent, postDisplayPopupEvent, postDisplayPopupEvent, postDisplayResultItemEvent, postDisplayResultItemEvent, postDocumentCheckEvent, postDocumentCheckWithShareBaseEvent, postDocumentFilingEvent, postDocumentFilingEvent, postDocumentReleaseEvent, postDownloadResultItemEvent, postEditContentEvent, postEditItemSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditStructureEvent, postErrorLogEvent, postErrorLogEvent, postExternalStorageUploadEvent, postExternalStorageUploadStatusEvent, postFieldChangeEvent, postFileActionEvent, postFileActionEvent, postFormButtonEvent, postIndexResultItemEvent, postInfoLogEvent, postInfoLogEvent, 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, postWarningLogEvent, postWarningLogEvent, postWorkflowActionEvent, postWorkflowCommentEvent, postWorkflowDisplayCommentEvent

Methods inherited from class org.zkoss.zul.Window

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

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

getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

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

addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

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

addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, invalidate, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onPageAttached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

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

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 org.zkoss.zk.ui.sys.ComponentCtrl

invalidatePartial

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 org.zkoss.zk.ui.IdSpace

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

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 Details

DEFAULT_POPUP_WIDTH

public static final int DEFAULT_POPUP_WIDTH

See Also:

• Constant Field Values

DEFAULT_POPUP_HEIGHT

public static final int DEFAULT_POPUP_HEIGHT

See Also:

• Constant Field Values

Constructor Details

DocumentViewImpl

public DocumentViewImpl()

Constructor.

DocumentViewImpl

public DocumentViewImpl(String viewerClassName)

Constructor for Standalone Viewer to use individual viewer

DocumentViewImpl

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

Constructor with title, border, closable option.

Parameters:

title - Title

border - Border

closable - Closable

DocumentViewImpl

public DocumentViewImpl(com.saperion.ngc.iform.xml.ViewerType definition,
 boolean stretch,
 com.saperion.ngc.iform.xml.PosType panePos,
 String viewerClassName)

Constructor for iForm usage.

Parameters:

definition - element definition from QBE

stretch - true if the component should fill its container

panePos - Pane position

viewerClassName - name of the viewer class to override setting in definition

Method Details

onCreate

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

Description copied from class: AbstractDocumentView

Event handler for onCreate event.

Specified by:

onCreate in class AbstractDocumentView

Parameters:

event - ZK event

init

protected void init()

Description copied from class: AbstractDocumentView

Initializes the viewer classes by setting things like layout, max view size, max document size and so on.

Overrides:

init in class AbstractDocumentView

onDisplayTemporaryDocument

public final void onDisplayTemporaryDocument(org.zkoss.zk.ui.event.Event event)

Event listener method for DisplayTemporaryDocumentEvents.

Parameters:

event - The fired event.

onDisplayResultItem

public final void onDisplayResultItem(org.zkoss.zk.ui.event.Event event)

Display document.

Specified by:

onDisplayResultItem in interface DocumentView

Specified by:

onDisplayResultItem in class AbstractDocumentView

Parameters:

event - Event

onDisplayPopup

public final void onDisplayPopup(org.zkoss.zk.ui.event.Event event)

EventHandler for external events.

Parameters:

event - ZK event

openPopup

public void openPopup(DisplayPopupEvent orig,
 DocumentId id)

openPopup Open a PopUp of Document Viewer.

Parameters:

orig - orig

id - id

openPopup

public void openPopup(DisplayPopupEvent orig,
 DocumentId id,
 boolean currentRevision)

openPopup Open a PopUp of Document Viewer.

Parameters:

orig - orig

id - id

currentRevision - currentRevision

getEventtarget

public Set<org.zkoss.zk.ui.Component> getEventtarget(String eventName)

Reads the event target for the given event name, if set or the root element.

Specified by:

getEventtarget in interface EventChild

Overrides:

getEventtarget in class BaseWindow

Parameters:

eventName - Event name or null for main target

Returns:

Set of event targets

See Also:

• EventChild.getEventtarget(java.lang.String)

setEventtarget

public void setEventtarget(org.zkoss.zk.ui.Component comp,
 String eventName)

Set the event target.

Specified by:

setEventtarget in interface EventChild

Overrides:

setEventtarget in class BaseWindow

Parameters:

comp - Event target

eventName - Event name or null for main target

See Also:

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

onPageDetached

public void onPageDetached(org.zkoss.zk.ui.Page page)

Specified by:

onPageDetached in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

onPageDetached in class org.zkoss.zul.Window

See Also:

• Window.onPageDetached(org.zkoss.zk.ui.Page)

onAppletLoaded

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

Event-handler called when the applet is ready to use. Needed for VirtualViewer.

Parameters:

event - the event

openDocument

public void openDocument(DocumentId documentId,
 List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements,
 int element,
 boolean currentRevision)

Opens the specified url and displays the document.

Parameters:

documentId - the document's id

documentElements - the document's elements (sub documents)

element - document element

currentRevision - whether to resolve the current revision or not

See Also:

• DocumentView.openDocument(com.saperion.ngc.model.document.DocumentId, java.util.List, int, boolean)

openDocument

public final void openDocument(DocumentId documentId,
 List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements,
 int element)

Opens the specified url and displays the document.

Specified by:

openDocument in interface DocumentView

Specified by:

openDocument in class AbstractDocumentView

Parameters:

documentId - the document's id

documentElements - the document's elements (sub documents)

element - document element

See Also:

• DocumentView.openDocument(com.saperion.ngc.model.document.DocumentId, java.util.List, int)

openTemporaryDocument

public void openTemporaryDocument(TemporaryDocumentId documentId)

Opens a temporary document. The document must be contained in the temporary document cache. A TemporaryDocumentId can be obtained by using TemporaryDocumentPreviewService to cache the document.

Parameters:

documentId - ID of the temporary document

See Also:

• (com.saperion.ngc.model.document.TemporaryDocumentId)

handleLinkElement

public void handleLinkElement(DocumentArchiveMetaInfo.ElementArchiveMetaInfo linkElement)

Handles the viewing of a linked element. How this is done is up to the implementation of the DocumentView component. The default-implementation opens a popup window to show the document.

Parameters:

linkElement - the linked element to view

See Also:

• (com.saperion.ngc.model.document.intf.DocumentArchiveMetaInfo.ElementArchiveMetaInfo)