|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.viewer.annotation.CMBAnnotationSet
CMBAnnotationSet represents the set of annotations associated with a document. This represents the logical format to which the annotations in physical format are converted to by CMBAnnotationServices. Provides methods to query annotation properties and has an array property that provides access to each CMBPageAnnotation object that represents a single annotation in the document.
There is no public constructor for CMBAnnotationSet. Use CMBAnnotationServices.loadAnnotations()
to obtain an instance of CMBAnnotationSet.
CMBAnnotationServices
,
CMBAnnotationEngine
, Serialized FormMethod Summary | |
void |
addAnnCreatedListener(CMBAnnotationCreatedListener listener)
Adds a listener to the list of annotation created event listeners. |
void |
addAnnDeletedListener(CMBAnnotationDeletedListener listener)
Adds a listener to the list of annotation deleted event listeners. |
void |
addAnnMovedListener(CMBAnnotationMovedListener listener)
Adds a listener to the list of annotation moved event listeners. |
void |
addAnnotation(CMBPageAnnotation a)
Adds a new annotation to the set |
void |
addAnnPropertiesUpdatedListener(CMBAnnotationPropertiesUpdatedListener listener)
Adds a listener to the list of annotation properties updated event listeners. |
void |
addAnnReorderedListener(CMBAnnotationReorderedListener listener)
Adds a listener to the list of annotation reordered event listeners. |
void |
addAnnResizedListener(CMBAnnotationResizedListener listener)
Adds a listener to the list of annotation resized event listeners. |
void |
addAnnSelectedListener(CMBAnnotationSelectedListener listener)
Adds a listener to the list of annotation selected event listeners. |
void |
dispose()
Disposes the annotation set and all the page annotations. |
void |
fireCMBAnnCreatedEvent(CMBAnnotationView view,
CMBPageAnnotation annotation)
Notifies all the listeners that an annotation was created. |
void |
fireCMBAnnDeletedEvent(CMBAnnotationView view,
CMBPageAnnotation annotation,
CMBPageAnnotation nextAnno)
Notifies all the listeners that an annotation was deleted. |
void |
fireCMBAnnMovedEvent(CMBAnnotationView view,
CMBPageAnnotation annotation,
java.awt.Point newPoint,
java.awt.Point oldPoint)
Notifies all the listeners that an annotation was moved. |
void |
fireCMBAnnPropertiesUpdatedEvent(CMBAnnotationView view,
CMBPageAnnotation annotation)
Notifies all the listeners that an annotation's properties was changed. |
void |
fireCMBAnnReorderedEvent(CMBAnnotationView view,
CMBPageAnnotation annotation,
int newIndex)
Notifies all the listeners that an annotation was reordered. |
void |
fireCMBAnnResizedEvent(CMBAnnotationView view,
CMBPageAnnotation annotation,
java.awt.Point deltaSize,
java.awt.Point oldSize)
Notifies all the listeners that an annotation was resized. |
void |
fireCMBAnnSelectedEvent(CMBAnnotationView view,
CMBPageAnnotation annotation)
Notifies all the listeners that an annotation was resized. |
CMBPageAnnotation |
getAnnotationAt(int index)
|
int |
getAnnotationCount()
Returns the annotation count. |
java.lang.String |
getAnnotationFormat()
Returns the annotation format of this annotation set. |
int |
getAnnotationPartNumber()
Gets the annotation part number that this set belongs to. |
boolean |
getCanLoadAnnotationFormat(java.lang.String format)
Tests if the engine can load the specified annotation format. |
boolean |
getCanSaveAnnotationFormat(java.lang.String srcFormat,
java.lang.String dstFormat)
Tests if the engine can save annotations to the specified annotation format. |
int |
getImageHeight()
|
int |
getImageWidth()
|
java.util.Iterator |
getIterator()
Returns an Iterator instance to the caller. |
java.util.Iterator |
getIterator(int pageNum)
Returns the iterator that lists the annotations on the specified page. |
CMBPageAnnotation[] |
getPageAnnotations()
Returns an array of all the page annotations in this set. |
CMBPageAnnotation[] |
getPageAnnotations(int pageNum)
Returns an array of page annotations corresponding to the specified page. |
boolean |
getPrivilege(int privilege)
|
int |
getRotation()
|
int |
getScale()
Returns the scale factor. |
boolean |
isDirty()
|
void |
removeAnnCreatedListener(CMBAnnotationCreatedListener listener)
Removes the annotation created event listener from the list. |
void |
removeAnnDeletedListener(CMBAnnotationDeletedListener listener)
Removes the annotation deleted event listener from the list. |
void |
removeAnnMovedListener(CMBAnnotationMovedListener listener)
Removes the annotation moved event listener from the list. |
CMBPageAnnotation |
removeAnnotation(CMBPageAnnotation a)
Removes an annotation from the set |
void |
removeAnnPropertiesUpdatedListener(CMBAnnotationPropertiesUpdatedListener listener)
Removes the annotation properties updated event listener from the list. |
void |
removeAnnReorderedListener(CMBAnnotationReorderedListener listener)
Removes the annotation reordered event listener from the list. |
void |
removeAnnResizedListener(CMBAnnotationResizedListener listener)
Removes the annotation resized event listener from the list. |
void |
removeAnnSelectedListener(CMBAnnotationSelectedListener listener)
Removes the annotation resized event listener from the list. |
void |
reorderAnnotation(CMBPageAnnotation a,
int index)
Change the order of the annotations. |
void |
saveAnnotations()
Calls the engine to save the annotations. |
void |
setDirty(boolean bAnnoDirty)
|
void |
setImageSize(int wd,
int ht)
|
void |
setRotation(int rotation)
|
void |
setRotation(int rotation,
int pageNumber)
|
void |
setScale(int scale)
|
java.lang.String |
toString()
|
void |
updateAnnotation(CMBPageAnnotation a,
int index)
Updates the annotation with the specified annotation at the specified index. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public boolean getCanLoadAnnotationFormat(java.lang.String format)
format
- the annotation formatpublic boolean getCanSaveAnnotationFormat(java.lang.String srcFormat, java.lang.String dstFormat)
srcFormat
- the annotation format that was initially loadeddestFormat
- the annotation format to convert topublic java.lang.String getAnnotationFormat()
public boolean getPrivilege(int privilege)
public CMBPageAnnotation[] getPageAnnotations()
public CMBPageAnnotation[] getPageAnnotations(int pageNum)
pageNum
- The page number of the page to which returned array of
annotations belong.public int getAnnotationCount()
public int getAnnotationPartNumber()
public void addAnnotation(CMBPageAnnotation a)
a
- The annotation to addpublic CMBPageAnnotation removeAnnotation(CMBPageAnnotation a)
a
- The annotation to removepublic void reorderAnnotation(CMBPageAnnotation a, int index)
a
- The page annotation to be re-ordered.index
- The new index of the page annotation.public CMBPageAnnotation getAnnotationAt(int index)
public void updateAnnotation(CMBPageAnnotation a, int index)
a
- The page annotation to update.index
- The index of the page annotation to be updated.public void saveAnnotations() throws java.io.IOException
public java.util.Iterator getIterator()
public java.util.Iterator getIterator(int pageNum)
pageNum
- The Iterator that contains annotations on this page.public void addAnnCreatedListener(CMBAnnotationCreatedListener listener)
listener
- An instance of a class implementing the CMBAnnotationCreatedListener interface.public void removeAnnCreatedListener(CMBAnnotationCreatedListener listener)
listener
- An instance of a class implementing the CMBAnnotationCreatedListener interface.public void fireCMBAnnCreatedEvent(CMBAnnotationView view, CMBPageAnnotation annotation)
annotation
- The annotation that is created.public void addAnnDeletedListener(CMBAnnotationDeletedListener listener)
listener
- An instance of a class implementing the CMBAnnotationDeletedListener interface.public void removeAnnDeletedListener(CMBAnnotationDeletedListener listener)
listener
- An instance of a class implementing the CMBAnnotationDeletedListener interface.public void fireCMBAnnDeletedEvent(CMBAnnotationView view, CMBPageAnnotation annotation, CMBPageAnnotation nextAnno)
annotation
- The annotation that is deleted.nextAnno
- The annotation that is next in the set that must be selected.public void addAnnPropertiesUpdatedListener(CMBAnnotationPropertiesUpdatedListener listener)
listener
- An instance of a class implementing the CMBAnnotationPropertiesUpdatedListener interface.public void removeAnnPropertiesUpdatedListener(CMBAnnotationPropertiesUpdatedListener listener)
listener
- An instance of a class implementing the CMBAnnotationPropertiesUpdatedListener interface.public void fireCMBAnnPropertiesUpdatedEvent(CMBAnnotationView view, CMBPageAnnotation annotation)
annotation
- The annotation whose property was changed.public void addAnnReorderedListener(CMBAnnotationReorderedListener listener)
listener
- An instance of a class implementing the CMBAnnotationReorderedListener interface.public void removeAnnReorderedListener(CMBAnnotationReorderedListener listener)
listener
- An instance of a class implementing the CMBAnnotationReorderedListener interface.public void fireCMBAnnReorderedEvent(CMBAnnotationView view, CMBPageAnnotation annotation, int newIndex)
annotation
- The annotation that is reordered.newIndex
- The new index of the annotation that is reordered.public void addAnnMovedListener(CMBAnnotationMovedListener listener)
listener
- An instance of a class implementing the CMBAnnotationMovedListener interface.public void removeAnnMovedListener(CMBAnnotationMovedListener listener)
listener
- An instance of a class implementing the CMBAnnotationMovedListener interface.public void fireCMBAnnMovedEvent(CMBAnnotationView view, CMBPageAnnotation annotation, java.awt.Point newPoint, java.awt.Point oldPoint)
annotation
- The annotation that is moved.newPoint
- The new point to which the annotation is moved.oldPoint
- The old point from which the annotation is moved.public void addAnnResizedListener(CMBAnnotationResizedListener listener)
listener
- An instance of a class implementing the CMBAnnotationResizedListener interface.public void removeAnnResizedListener(CMBAnnotationResizedListener listener)
listener
- An instance of a class implementing the CMBAnnotationResizedListener interface.public void fireCMBAnnResizedEvent(CMBAnnotationView view, CMBPageAnnotation annotation, java.awt.Point deltaSize, java.awt.Point oldSize)
annotation
- The annotation that is resized.deltaSize
- The values of the changed width and height of the specified annotation.oldSize
- The original size of the annotation.public void addAnnSelectedListener(CMBAnnotationSelectedListener listener)
listener
- An instance of a class implementing the CMBAnnotationSelectedListener interface.public void removeAnnSelectedListener(CMBAnnotationSelectedListener listener)
listener
- An instance of a class implementing the CMBAnnotationSelecteddListener interface.public void fireCMBAnnSelectedEvent(CMBAnnotationView view, CMBPageAnnotation annotation)
annotation
- The annotation that is resized.public void setRotation(int rotation)
public int getRotation()
public void setRotation(int rotation, int pageNumber)
public void setScale(int scale)
scale
- The new scale to set.public int getScale()
public void setImageSize(int wd, int ht)
public int getImageHeight()
public int getImageWidth()
public void setDirty(boolean bAnnoDirty)
public boolean isDirty()
public void dispose()
public java.lang.String toString()
toString
in class java.lang.Object
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |