Class JadiceAnnotationConverter

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] convert​(java.lang.String original, java.lang.String ixosAnnotationsIni, int ixosPage)
      Converts the annotations to the desired format.
      void setDimension​(int width, int height)
      Set document dimension.
      void setDocumentInfos​(OpenDocumentBean openDocumentBean)
      Used to pass information about the document to the converter.
      void setEmpty​(boolean empty)
      Used to notify the converter that the document has no annotations.
      void setSession​(javax.servlet.http.HttpSession session)
      Passes the current session to the converter, if it is available.
      void setViewerId​(java.lang.String id)
      Used to pass the ID of the viewer that requested the annotations to the converter.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • JadiceAnnotationConverter

        public JadiceAnnotationConverter()
    • Method Detail

      • setSession

        public void setSession​(javax.servlet.http.HttpSession session)
        Description copied from interface: AnnotationConverter
        Passes the current session to the converter, if it is available.
        Specified by:
        setSession in interface AnnotationConverter
        Parameters:
        session - the session
      • setEmpty

        public void setEmpty​(boolean empty)
        Description copied from interface: AnnotationConverter
        Used to notify the converter that the document has no annotations.
        Specified by:
        setEmpty in interface AnnotationConverter
        Parameters:
        empty - true if the document has no annotations
      • setDocumentInfos

        public void setDocumentInfos​(OpenDocumentBean openDocumentBean)
        Description copied from interface: AnnotationConverter
        Used to pass information about the document to the converter.
        Specified by:
        setDocumentInfos in interface AnnotationConverter
        Parameters:
        openDocumentBean - the bean containing information about the opened document
      • convert

        public byte[] convert​(java.lang.String original,
                              java.lang.String ixosAnnotationsIni,
                              int ixosPage)
                       throws ConvertAnnotationException
        Description copied from interface: AnnotationConverter
        Converts the annotations to the desired format.
        Specified by:
        convert in interface AnnotationConverter
        Parameters:
        original - original annotations represented as String
        ixosAnnotationsIni - IXOS annotations
        ixosPage - IXOS page number
        Returns:
        converted annotations represented as byte array
        Throws:
        ConvertAnnotationException - when converting the annotations failed
      • setViewerId

        public void setViewerId​(java.lang.String id)
        Description copied from interface: AnnotationConverter
        Used to pass the ID of the viewer that requested the annotations to the converter.
        Specified by:
        setViewerId in interface AnnotationConverter
        Parameters:
        id - ID of the viewer
      • setDimension

        public void setDimension​(int width,
                                 int height)
        Description copied from interface: AnnotationConverter
        Set document dimension.
        Specified by:
        setDimension in interface AnnotationConverter
        Parameters:
        width - Width
        height - Height