com.saperion.ngc.viewer.virtualviewer.clientserver

Class CSVirtualViewerApplet

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

com.saperion.ngc.ngapplet.NgApplet

com.saperion.ngc.viewer.virtualviewer.clientserver.CSVirtualViewerApplet

All Implemented Interfaces:

ViewerComponent, Serializable, Cloneable, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class CSVirtualViewerApplet
extends NgApplet
implements ViewerComponent

Client/Server variant of VirtualViewer.

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

Modifier and Type	Field and Description
static String	CONFIG_FILE Configuration file for this viewer component implementation.
static String	CS_VIRTUAL_VIEWER_APPLET_PROPERTIES_PATH Relative path to properties file.
static String	ON_ANNOTATE Event document annotation set.
static String	ON_APPLET_LOADED Event applet is loaded.
static String	ON_DOCUMENT_ROTATE Event document rotate.
static String	ON_SAVE_COMPLETE Event document save complete.
static String	ON_VIEWER_READY Event viewer ready.
static String	VIRTUAL_VIEWER_PROPERTIES_FILE Name of the properties file.

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

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
CSVirtualViewerApplet() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	disable() Disables the viewer.
void	displayDocument(String aDocumentUrl, String aAnnotationsUrl, DocumentArchiveMetaInfo.ElementArchiveMetaInfo elementInfo, DocumentId documentId) Displays a document.
void	displayTemporaryDocument(String documentUrl, TemporaryDocumentId id) Displays a temporary (not yet archived) document.
void	enable() Enables the viewer.
String	getConfigurationFile() Returns the name of the configuration file needed for this implementation of ViewerComponent.
boolean	hasOpenChanges() Returns, if the viewer has open changes.
void	init(String viewerId) Called from parent component to initialize the viewer-component.
void	invoke(String function) Invokes the function of the applet running at the client.
void	invoke(String function, String argument) Invokes the function of the applet running at the client with one argument.
void	invoke(String function, String[] arguments) Invokes the function of the applet running at the client with variable number argument.
void	onAnnotate(org.zkoss.zk.ui.event.Event event) Event handler.
void	onAppletLoaded(org.zkoss.zk.ui.event.Event event) Event handler.
void	onDocumentRotate(org.zkoss.zk.ui.event.Event event) Event handler.
void	onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
void	onPageDetached(org.zkoss.zk.ui.Page page)
void	onSaveComplete(org.zkoss.zk.ui.event.Event event) Event handler.
void	onViewerReady(org.zkoss.zk.ui.event.Event event) Event handler.
void	refreshDocument() Refreshes the viewer using the last opened document.
void	resetView() Resets the view so that the viewer applet will not re-open the last opened document.
void	resetView(boolean showInitImage) Resets the view so that the viewer applet will not re-open the last opened document.
void	setParentViewComponent(DocumentView documentView) Used to pass a reference to the parent component to this ViewerComponent.
void	tabSelected() Method used to notify the ViewerComponent that the tab it is contained in was selected.

Methods inherited from class com.saperion.ngc.ngapplet.NgApplet

getArchive, getCode, getCodebase, getParameters, isIgnoreInvokeErrors, notifyWhenReady, renderProperties, setArchive, setCode, setCodebase, setIgnoreInvokeErrors, setJsonParameters, setParam, setParameters, setParameters

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

clone, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, service, setAction, setClass, setDraggable, 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, beforeChildAdded, 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, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, newExtraCtrl, onChildAdded, onChildRemoved, 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, setVisible, 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.zk.ui.Component

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, 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, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, unsetVariable

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Field Detail

CONFIG_FILE

public static final String CONFIG_FILE

Configuration file for this viewer component implementation.

See Also:

Constant Field Values

ON_VIEWER_READY

public static final String ON_VIEWER_READY

Event viewer ready.

See Also:

Constant Field Values

ON_DOCUMENT_ROTATE

public static final String ON_DOCUMENT_ROTATE

Event document rotate.

See Also:

Constant Field Values

ON_ANNOTATE

public static final String ON_ANNOTATE

Event document annotation set.

See Also:

Constant Field Values

ON_SAVE_COMPLETE

public static final String ON_SAVE_COMPLETE

Event document save complete.

See Also:

Constant Field Values

ON_APPLET_LOADED

public static final String ON_APPLET_LOADED

Event applet is loaded.

See Also:

Constant Field Values

CS_VIRTUAL_VIEWER_APPLET_PROPERTIES_PATH

public static final String CS_VIRTUAL_VIEWER_APPLET_PROPERTIES_PATH

Relative path to properties file.

See Also:

Constant Field Values

VIRTUAL_VIEWER_PROPERTIES_FILE

public static final String VIRTUAL_VIEWER_PROPERTIES_FILE

Name of the properties file.

See Also:

Constant Field Values

Constructor Detail

CSVirtualViewerApplet

public CSVirtualViewerApplet()

Constructor.

Method Detail

displayDocument

public void displayDocument(String aDocumentUrl,
                   String aAnnotationsUrl,
                   DocumentArchiveMetaInfo.ElementArchiveMetaInfo elementInfo,
                   DocumentId documentId)

Displays a document. The content of the document and of the annotations can be retrieved by using the URLs passed to the viewer. Alternatively, the document can by identified by the ID. The filename is passed only to inform the viewer about the document.

Specified by:

displayDocument in interface ViewerComponent

Parameters:

aDocumentUrl - the document url

aAnnotationsUrl - the annotation url

elementInfo - meta information about the page to be displayed

documentId - Id of the document

displayTemporaryDocument

public void displayTemporaryDocument(String documentUrl,
                            TemporaryDocumentId id)

Description copied from interface: ViewerComponent

Displays a temporary (not yet archived) document. The content of the temporary document can be retrieved by using the URL and id passed to the viewer.

Specified by:

displayTemporaryDocument in interface ViewerComponent

Parameters:

documentUrl - The URL to the download servlet.

id - The id of the temporary document.

refreshDocument

public void refreshDocument()

Refreshes the viewer using the last opened document.

Specified by:

refreshDocument in interface ViewerComponent

See Also:

ViewerComponent.refreshDocument()

resetView

public void resetView()

Resets the view so that the viewer applet will not re-open the last opened document. The opened document will be closed.

Specified by:

resetView in interface ViewerComponent

See Also:

ViewerComponent.resetView()

disable

public void disable()

Disables the viewer.

Specified by:

disable in interface ViewerComponent

See Also:

ViewerComponent.disable()

enable

public void enable()

Enables the viewer.

Specified by:

enable in interface ViewerComponent

See Also:

ViewerComponent.enable()

onViewerReady

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

Event handler. Called when the applet has successfully rendered a page.

Parameters:

event - Event

onAppletLoaded

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

Event handler. Called when the applet was initialized after first load.

Parameters:

event - Event Applet is loaded.

onAnnotate

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

Event handler. Called when an annotation was added/edited.

Parameters:

event - Event

onSaveComplete

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

Event handler. Called when the document was saved.

Parameters:

event - Event

onDocumentRotate

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

Event handler. Called when the page was rotated.

Parameters:

event - Event

hasOpenChanges

public boolean hasOpenChanges()

Returns, if the viewer has open changes.

Specified by:

hasOpenChanges in interface ViewerComponent

Returns:

Has open changes

See Also:

ViewerComponent.hasOpenChanges()

init

public void init(String viewerId)

Called from parent component to initialize the viewer-component.

Specified by:

init in interface ViewerComponent

Parameters:

viewerId - the id of the viewer, passed only as additional information

See Also:

ViewerComponent.init(java.lang.String)

resetView

public void resetView(boolean showInitImage)

Resets the view so that the viewer applet will not re-open the last opened document. The opened document will be closed.

Specified by:

resetView in interface ViewerComponent

Parameters:

showInitImage - if true, the viewer will show an initial image

See Also:

ViewerComponent.resetView(boolean)

onPageAttached

public void onPageAttached(org.zkoss.zk.ui.Page newpage,
                  org.zkoss.zk.ui.Page oldpage)

Specified by:

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

Overrides:

onPageAttached in class org.zkoss.zk.ui.AbstractComponent

See Also:

AbstractComponent.onPageAttached(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Page)

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

See Also:

AbstractComponent.onPageDetached(org.zkoss.zk.ui.Page)

setParentViewComponent

public void setParentViewComponent(DocumentView documentView)

Used to pass a reference to the parent component to this ViewerComponent. Optional.

Specified by:

setParentViewComponent in interface ViewerComponent

Parameters:

documentView - the new parent view component

See Also:

ViewerComponent.setParentViewComponent(com.saperion.ngc.viewer.DocumentView)

tabSelected

public void tabSelected()

Method used to notify the ViewerComponent that the tab it is contained in was selected. Not used if the component is not contained in a tab.

Specified by:

tabSelected in interface ViewerComponent

See Also:

ViewerComponent.tabSelected()

invoke

public void invoke(String function)

Invokes the function of the applet running at the client.

Overrides:

invoke in class NgApplet

Parameters:

function - name of the function

See Also:

NgApplet.invoke(java.lang.String)

invoke

public void invoke(String function,
          String argument)

Invokes the function of the applet running at the client with one argument.

Overrides:

invoke in class NgApplet

Parameters:

function - name of the function

argument - the argument

See Also:

NgApplet.invoke(java.lang.String, java.lang.String)

invoke

public void invoke(String function,
          String[] arguments)

Invokes the function of the applet running at the client with variable number argument.

Overrides:

invoke in class NgApplet

Parameters:

function - name of the function

arguments - the arguments

See Also:

NgApplet.invoke(java.lang.String, java.lang.String[])

getConfigurationFile

public String getConfigurationFile()

Returns the name of the configuration file needed for this implementation of ViewerComponent. If no file is needed, null should be returned. The name of the file must include the path relative to the configuration folders (/config/ and /custom-config/.

Specified by:

getConfigurationFile in interface ViewerComponent

Returns:

name of the configuration file or null if no configuration file is needed

See Also:

ViewerComponent.getConfigurationFile()