MST.Annotations

Class MSTAnnotationDocument

java.lang.Object

MST.Annotations.MSTAnnotationDocument

public class MSTAnnotationDocument
extends java.lang.Object

MSTAnnotationDocument class is main class of Annotation SDK.MSTAnnotationDocument contains MSTAnnotationPage class array( Which keeps information of annotation properties).Through MSTAnnotationPage Object annotations can be saved and loaded from/to document.

Author:

MS Technology

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Vector	annotation
MSTAnnotationPage[]	m_AnnPages

Constructor Summary

Constructors

Constructor and Description
MSTAnnotationDocument(int pages) creates an object of MSTAnnotationDocument.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	CheckValidModca(java.io.InputStream annotationStream, byte[] data)
java.util.Vector	getFilenetAnnotation(java.io.InputStream annStreamFilenetNet)
MSTAnnotation[]	getFilenetAnnotations(java.io.InputStream annStream, java.lang.String string)
void	GetRevByte(byte[] pu8IntRev, int nNum)
void	GetRevInt(byte[] pu8IntRev, int nNum)
void	GetRevInt(byte[] pu8IntRev, int nNum, boolean abcd)
void	GetRevInt(byte[] pu8IntRev, long nNum)
int	getWingRatio(MST.Annotations.MSTArrowProperty arrowAnnotation)
MSTAnnotationDocument	loadAnnotation(java.lang.String filePath) Load annotation data from XML (i.e.
MSTAnnotationDocument	loadAnnotation(java.lang.String filePath, float nXResolution, float nYResolution)
void	loadAnnotationset(java.io.InputStream annotationStream, java.lang.String format, int xRes, int yRes)
void	loadFilenetAnnotation(java.io.InputStream annStream, float nXResolution, float nYResolution, java.lang.String repo)
static java.lang.String	printBytes(byte[] array, java.lang.String name)
boolean	saveAnnotationCM8(java.lang.String filePath, MSTAnnotationDocument msAnnDoc, float nXResolution, float nYResolution)
boolean	saveFilenetAnnotation(java.lang.String filePath, MSTAnnotationDocument msAnnDoc, float nXResolution, float nYResolution)
boolean	saveXMLAnnotation(java.lang.String filePath, MSTAnnotationDocument msAnnDoc) Save annotation data into XML (i.e.
void	writeArrow(MST.Annotations.MSTArrowProperty arrowAnnotation)
void	writeCircleBox(MSTAnnotation pageAnnotation)
void	writeFilenetArrow(MST.Annotations.MSTArrowProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetCircle(MST.Annotations.MSTRectangleProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetHighlight(MST.Annotations.MSTRectangleProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetLine(MST.Annotations.MSTLineProperty lineAnnotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetNote(MST.Annotations.MSTNoteProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetPen(MST.Annotations.MSTPenProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetPolygon(MST.Annotations.MSTPolygonProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetPolyline(MST.Annotations.MSTPolylineProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetRectangle(MST.Annotations.MSTRectangleProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetStamp(MST.Annotations.MSTStampProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
void	writeFilenetText(MST.Annotations.MSTTextProperty Annotation, java.lang.String filePath, java.io.OutputStream outputStream)
int	writeFont(java.awt.Font f, int type)
void	writeLine(MST.Annotations.MSTLineProperty lineAnnotation)
void	writeNOP(java.awt.Rectangle rect, int pagenumber)
void	writeNote(MST.Annotations.MSTNoteProperty noteAnnotation)
void	writePage_AnnotationNumber(int nPageNumber, int nAnnNumber)
void	writePen(MST.Annotations.MSTPenProperty penAnnotation)
void	writeStamp(MST.Annotations.MSTStampProperty stampAnnotation)
void	writeText(MST.Annotations.MSTTextProperty textAnnotation)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_AnnPages

public MSTAnnotationPage[] m_AnnPages

annotation

public static java.util.Vector annotation

Constructor Detail

MSTAnnotationDocument

public MSTAnnotationDocument(int pages)
                      throws MST.Annotations.MSTException

creates an object of MSTAnnotationDocument. Which contains no (equal to pages passed in constructor) of array of MSTAnnotationPage class and these array (of MSTAnnoationPage) will contain MSTAnnotaiton object (according to the annotation(s) created in document).

Parameters:

pages - No of Pages of Document

Throws:

MST.Annotations.MSTException

Method Detail

saveXMLAnnotation

public boolean saveXMLAnnotation(java.lang.String filePath,
                        MSTAnnotationDocument msAnnDoc)
                          throws MST.Annotations.MSTException

Save annotation data into XML (i.e. Extended Markup Language) format

Parameters:

filePath - Absolute path of file at which place user want to create annotation XML

msAnnDoc - MSTAnnotationDocument object

Returns:

boolean

Throws:

MST.Annotations.MSTException

saveFilenetAnnotation

public boolean saveFilenetAnnotation(java.lang.String filePath,
                            MSTAnnotationDocument msAnnDoc,
                            float nXResolution,
                            float nYResolution)

loadAnnotation

public MSTAnnotationDocument loadAnnotation(java.lang.String filePath,
                                   float nXResolution,
                                   float nYResolution)
                                     throws java.io.IOException

Throws:

java.io.IOException

loadAnnotation

public MSTAnnotationDocument loadAnnotation(java.lang.String filePath)
                                     throws MST.Annotations.MSTException

Load annotation data from XML (i.e. Extended Markup Language) format

Parameters:

filePath - Absolute path of file at which place user want to get annotation XML

Returns:

MSTAnnotationDocument

Throws:

MST.Annotations.MSTException

loadAnnotationset

public void loadAnnotationset(java.io.InputStream annotationStream,
                     java.lang.String format,
                     int xRes,
                     int yRes)

CheckValidModca

public boolean CheckValidModca(java.io.InputStream annotationStream,
                      byte[] data)

saveAnnotationCM8

public boolean saveAnnotationCM8(java.lang.String filePath,
                        MSTAnnotationDocument msAnnDoc,
                        float nXResolution,
                        float nYResolution)

writeNOP

public void writeNOP(java.awt.Rectangle rect,
            int pagenumber)

writePage_AnnotationNumber

public void writePage_AnnotationNumber(int nPageNumber,
                              int nAnnNumber)

writeArrow

public void writeArrow(MST.Annotations.MSTArrowProperty arrowAnnotation)

GetRevInt

public void GetRevInt(byte[] pu8IntRev,
             int nNum)

GetRevInt

public void GetRevInt(byte[] pu8IntRev,
             long nNum)

GetRevByte

public void GetRevByte(byte[] pu8IntRev,
              int nNum)

GetRevInt

public void GetRevInt(byte[] pu8IntRev,
             int nNum,
             boolean abcd)

getWingRatio

public int getWingRatio(MST.Annotations.MSTArrowProperty arrowAnnotation)

writeCircleBox

public void writeCircleBox(MSTAnnotation pageAnnotation)

writeLine

public void writeLine(MST.Annotations.MSTLineProperty lineAnnotation)

writeNote

public void writeNote(MST.Annotations.MSTNoteProperty noteAnnotation)

writePen

public void writePen(MST.Annotations.MSTPenProperty penAnnotation)

writeStamp

public void writeStamp(MST.Annotations.MSTStampProperty stampAnnotation)

writeFont

public int writeFont(java.awt.Font f,
            int type)

writeText

public void writeText(MST.Annotations.MSTTextProperty textAnnotation)

writeFilenetLine

public void writeFilenetLine(MST.Annotations.MSTLineProperty lineAnnotation,
                    java.lang.String filePath,
                    java.io.OutputStream outputStream)

writeFilenetArrow

public void writeFilenetArrow(MST.Annotations.MSTArrowProperty Annotation,
                     java.lang.String filePath,
                     java.io.OutputStream outputStream)

writeFilenetRectangle

public void writeFilenetRectangle(MST.Annotations.MSTRectangleProperty Annotation,
                         java.lang.String filePath,
                         java.io.OutputStream outputStream)

writeFilenetHighlight

public void writeFilenetHighlight(MST.Annotations.MSTRectangleProperty Annotation,
                         java.lang.String filePath,
                         java.io.OutputStream outputStream)

writeFilenetCircle

public void writeFilenetCircle(MST.Annotations.MSTRectangleProperty Annotation,
                      java.lang.String filePath,
                      java.io.OutputStream outputStream)

writeFilenetPen

public void writeFilenetPen(MST.Annotations.MSTPenProperty Annotation,
                   java.lang.String filePath,
                   java.io.OutputStream outputStream)

writeFilenetStamp

public void writeFilenetStamp(MST.Annotations.MSTStampProperty Annotation,
                     java.lang.String filePath,
                     java.io.OutputStream outputStream)

writeFilenetNote

public void writeFilenetNote(MST.Annotations.MSTNoteProperty Annotation,
                    java.lang.String filePath,
                    java.io.OutputStream outputStream)

writeFilenetText

public void writeFilenetText(MST.Annotations.MSTTextProperty Annotation,
                    java.lang.String filePath,
                    java.io.OutputStream outputStream)

printBytes

public static java.lang.String printBytes(byte[] array,
                          java.lang.String name)

loadFilenetAnnotation

public void loadFilenetAnnotation(java.io.InputStream annStream,
                         float nXResolution,
                         float nYResolution,
                         java.lang.String repo)

getFilenetAnnotations

public MSTAnnotation[] getFilenetAnnotations(java.io.InputStream annStream,
                                    java.lang.String string)

getFilenetAnnotation

public java.util.Vector getFilenetAnnotation(java.io.InputStream annStreamFilenetNet)

writeFilenetPolygon

public void writeFilenetPolygon(MST.Annotations.MSTPolygonProperty Annotation,
                       java.lang.String filePath,
                       java.io.OutputStream outputStream)

writeFilenetPolyline

public void writeFilenetPolyline(MST.Annotations.MSTPolylineProperty Annotation,
                        java.lang.String filePath,
                        java.io.OutputStream outputStream)