Package com.saperion.ngc.viewer.hylandviewer

Class HylandViewerImpl

    • Field Detail

      • CONFIG_FILE

        public static final java.lang.String CONFIG_FILE
        Name of the configuration file for hyland viewer.
        See Also:
        Constant Field Values

      • HYLAND_RENDERING_CONVERSION_SERVICE_URL

        public static final java.lang.String HYLAND_RENDERING_CONVERSION_SERVICE_URL
        Use the ecm service to communicate with the hyland rendering and conversion service.
        See Also:
        Constant Field Values

      • DEFAULT_HYLAND_RENDERING_CONVERSION_SERVICE_URL

        public static final java.lang.String DEFAULT_HYLAND_RENDERING_CONVERSION_SERVICE_URL
        See Also:
        Constant Field Values

    • Constructor Detail

      • HylandViewerImpl

        public HylandViewerImpl()

    • Method Detail

      • displayDocument

        public void displayDocument​(java.lang.String documentUrl,
                            java.lang.String annotationUrl,
                            DocumentArchiveMetaInfo.ElementArchiveMetaInfo pageMetaInfo,
                            DocumentId documentId)
        Description copied from interface: ViewerComponent
        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:
        documentUrl - the document url
        annotationUrl - the annotation url
        pageMetaInfo - meta information about the page to be displayed
        documentId - Id of the document

      • displayTemporaryDocument

        public void displayTemporaryDocument​(java.lang.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.

      • init

        public void init​(java.lang.String viewerId)
        Description copied from interface: ViewerComponent
        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

      • resetView

        public void resetView()
        Description copied from interface: ViewerComponent
        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

      • resetView

        public void resetView​(boolean showInitImage)
        Description copied from interface: ViewerComponent
        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

      • hasOpenChanges

        public boolean hasOpenChanges()
        Description copied from interface: ViewerComponent
        Returns, if the viewer has open changes.
        Specified by:
        hasOpenChanges in interface ViewerComponent
        Returns:
        Has open changes

      • setParentViewComponent

        public void setParentViewComponent​(DocumentView documentView)
        Description copied from interface: ViewerComponent
        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

      • tabSelected

        public void tabSelected()
        Description copied from interface: ViewerComponent
        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

      • getConfigurationFile

        public java.lang.String getConfigurationFile()
        Description copied from interface: ViewerComponent
        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

      • canModifyDocument

        public boolean canModifyDocument()
        Description copied from interface: ViewerComponent
        Used by the webclient to determine if this type of viewer is able to edit documents.
        Specified by:
        canModifyDocument in interface ViewerComponent
        Returns:
        whether this viewer can edit documents

      • canShowRevisions

        public boolean canShowRevisions()
        Description copied from interface: ViewerComponent
        Used by web client to determine if this type of viewer can show the document revisions
        Specified by:
        canShowRevisions in interface ViewerComponent
        Returns:
        whether this viewer enables revision viewing

      • getExternalViewerWindowPath

        public java.lang.String getExternalViewerWindowPath()
        Description copied from interface: ViewerComponent
        Returns the relative path to the JSP used as external window or null if this viewer does not offer an external window.
        Specified by:
        getExternalViewerWindowPath in interface ViewerComponent
        Returns:
        path to the JSP or null if not supported

      • isDefault

        public static boolean isDefault()
        Checks if this viewer is configured as default.
        Returns:
        is default