com.saperion.ngc.viewer

Class SapDocumentViewImpl

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

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 SapDocumentViewImpl
extends AbstractDocumentView

Document Viewer for SAP Web Viewer. User: chg Date: 07.03.12 Time: 16:36

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

AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED

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

EDIT_WINDOW_PREFIX, NO_EXTERNAL_WINDOW, POPUP_BEAN_ATTRIBUTE

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface com.saperion.ngc.events.EventChild

ALL_EVENTS, ON_ADD_LINK, ON_ADD_LOOKUP, ON_ADD_TO_FAVORITES, ON_AFTER_QUERY, ON_BUTTON, ON_BUTTON_QUERY, ON_CANCEL, ON_CANCEL_AND, ON_CANCEL_EDIT, ON_CHANGE_DOCUMENT_SECURITY, ON_CHANGE_FOLDER_SECURITY, ON_CLEAR, ON_DELETE_SELECTED, ON_DISPLAY_POPUP, ON_DISPLAY_RESULTITEM, ON_DISPLAY_TEMPORARY_DOCUMENT, ON_DOCUMENT_ADDED, ON_DOCUMENT_CHECK, ON_DOCUMENT_FILING, ON_DOCUMENT_LOCKED, ON_DOCUMENT_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_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.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
SapDocumentViewImpl()

Method Summary

Modifier and Type	Method and Description
DocumentId	getLastDocId()
String	getSapNotesUserInfo() Get the user info string.
String	getSapNotesUserName() Get the user name string.
void	handleLinkElement(DocumentArchiveMetaInfo.ElementArchiveMetaInfo linkElement) Handles the viewing of a linked element.
boolean	isSapNotes() True, if the SAP notes editor is enabled.
void	onCreate(org.zkoss.zk.ui.event.Event event) Event handler for onCreate event.
void	onDisplayResultItem(org.zkoss.zk.ui.event.Event event) Display document.
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	openTemporaryDocument(TemporaryDocumentId documentId) Opens a temporary document.
void	setSapNotes(boolean value) Set the visibility of SAP notes editor.
void	setSapNotesUserInfo(String userInfo, String userName) Set the user information for the sap notes editor.
void	setSapNotesUserName(String value) Set the user name string.

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

canDownload, canModifyDocument, canView, disable, enable, enableStructureButtonsWhen, fillStructureView, generateRandomViewerId, getElementMetaInfo, getNativeRequest, getPageListStream, getParentForm, getPresenter, getPropertiesFileName, getStructureList, getViewerClass, hasOpenChanges, inIfomPopup, init, 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

getEventtarget, getMainWindow, postAddLinkEvent, postAddToFavoritesEvent, postCancelSelectedEvent, postChangeDocumentSecurityEvent, postChangeFolderSecurityEvent, postDeleteSelectedEvent, postDisplayPopupEvent, postDisplayPopupEvent, postDisplayResultItemEvent, postDisplayResultItemEvent, postDocumentCheckEvent, postDocumentFilingEvent, postDocumentFilingEvent, postDocumentReleaseEvent, postDownloadResultItemEvent, postEditContentEvent, postEditItemSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditStructureEvent, postErrorLogEvent, postErrorLogEvent, postFieldChangeEvent, postFileActionEvent, postFileActionEvent, postFormButtonEvent, postIndexResultItemEvent, postInfoLogEvent, postInfoLogEvent, postLaunchWorkflowEvent, postLockDocumentEvent, postLogonEvent, postLogonEvent, postNavigationFolderEvent, postNavigationFormEvent, postNavigationFormEvent, postNavigationWebpartEvent, postNewSelectedEvent, postOpenMaskEvent, postPrintDocumentEvent, postQueryFavoriteEvent, postRefreshEvent, postResetGuiEvent, postResultFieldEvent, postSaveDocumentEvent, postSaveDocumentEvent, postSelectTreeItemEvent, postSendMailResultItemEvent, postStartWorkflowEvent, postTabSelectedEvent, postUnDeleteSelectedEvent, postUploadDocumentEvent, postUploadSuccessEvent, postWarningLogEvent, postWarningLogEvent, postWorkflowActionEvent, postWorkflowCommentEvent, setEventtarget

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, onPageDetached, 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, 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, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, 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, equals, 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, isChildable, 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

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

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

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

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

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

postErrorLogEvent, postErrorLogEvent, postInfoLogEvent, postInfoLogEvent, postWarningLogEvent, postWarningLogEvent

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

getEventtarget, setEventtarget

Methods inherited from interface org.zkoss.zk.ui.IdSpace

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

Constructor Detail

SapDocumentViewImpl

public SapDocumentViewImpl()

Method Detail

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

onCreate

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

Event handler for onCreate event.

Specified by:

onCreate in class AbstractDocumentView

Parameters:

event - ZK event

isSapNotes

public final boolean isSapNotes()

True, if the SAP notes editor is enabled.

Returns:

SAP notes editor enabled

setSapNotes

public final void setSapNotes(boolean value)

Set the visibility of SAP notes editor.

Parameters:

value - True for set SAP notes viewer visible

setSapNotesUserInfo

public void setSapNotesUserInfo(String userInfo,
                                String userName)

Set the user information for the sap notes editor. This text will be added to the text, if the note must be appended. The tag #date will be replaced with the actual date.

Parameters:

userInfo - User information text

userName - Username

getSapNotesUserInfo

public String getSapNotesUserInfo()

Get the user info string.

Returns:

the userInfoString.

getSapNotesUserName

public String getSapNotesUserName()

Get the user name string.

Returns:

the userInfoString.

setSapNotesUserName

public void setSapNotesUserName(String value)

Set the user name string.

Parameters:

value - Username

getLastDocId

public DocumentId getLastDocId()

Returns:

Last document id

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)

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)

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. This operation is not supported by SapDocumentViewImpl.

Parameters:

documentId - ID of the temporary document

See Also:

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