Enterprise Information Portal APIs

com.ibm.mm.viewer.annotation
Class CMBHighlightAnnotation

java.lang.Object
  |
  +--com.ibm.mm.viewer.annotation.CMBPageAnnotation
        |
        +--com.ibm.mm.viewer.annotation.CMBHighlightAnnotation
All Implemented Interfaces:
java.lang.Cloneable, CMBAnnotationConstants, CMBAnnotationPropertiesInterface, java.io.Serializable, java.awt.datatransfer.Transferable

public class CMBHighlightAnnotation
extends CMBPageAnnotation

Deriving from CMBAnnotation, this class specializes CMBPageAnnotation to draw a highlight annotation.

Since:
8.1
See Also:
Serialized Form

Fields inherited from class com.ibm.mm.viewer.annotation.CMBPageAnnotation
allowedToDraw, applyPropertiesNow, canHide, canShow, canUpdate, creationIndex, currentIndex, DEFAULT_BORDER_WIDTH, DEFAULT_TRANSPARENCY, invertedHorz, invertedVert, isInMotion, isVisibleWhileDragging, pageAnnotationFlavor, pageNumber, showHandles, type
 
Fields inherited from interface com.ibm.mm.viewer.annotation.CMBAnnotationConstants
ANN_ARROW, ANN_CIRCLE, ANN_HIGHLIGHT, ANN_LINE, ANN_NAMES, ANN_NOTE, ANN_PEN, ANN_RECT, ANN_STAMP, ANN_TEXT, ANN_UNKNOWN, BOTTOM_HANDLE, BOTTOM_LEFT_HANDLE, BOTTOM_RIGHT_HANDLE, CURSOR_COUNT, DEFAULT_CURSOR, DEFAULT_CURSOR_HOTSPOT, DELETING_ANNOTATION, DOUBLE_CLICK, DRAG_MOVE, DRAG_RESIZE, HANDLE_CURSOR, HANDLE_HEIGHT, HANDLE_HOTSPOT, HANDLE_WIDTH, IDLE, IIDSP_PAGE_SCALE_FACTOR, IIOV_ROTATE_0, IIOV_ROTATE_180, IIOV_ROTATE_270, IIOV_ROTATE_90, INSERTING_ANNOTATION, LEFT_HANDLE, MOVE_CURSOR, MOVE_CURSOR_HOTSPOT, OPAQUE_ALPHA, PRIV_CREATE_ANNOTATION, PRIV_DELETE_ANNOTATION, PRIV_VIEW_ANNOTATION, RIGHT_HANDLE, START_CUSTOM_TYPE, TEXT_OFFSET, TOP_HANDLE, TOP_LEFT_HANDLE, TOP_RIGHT_HANDLE, TRANSPARENT_ALPHA, UPDATE_ANN_WITH_DEFAULTS, UPDATE_ANN_WITH_GUI, UPDATE_DEFAULTS_WITH_ANN, UPDATE_DEFAULTS_WITH_GUI, UPDATE_GUI_WITH_ANN, UPDATE_GUI_WITH_DEFAULTS
 
Constructor Summary
CMBHighlightAnnotation()
           
CMBHighlightAnnotation(java.awt.Rectangle r)
           
CMBHighlightAnnotation(java.awt.Rectangle r, int pageNumber)
           
 
Method Summary
 void addPropertyComponent(java.lang.String propertyName, javax.swing.JComponent component)
           
 void draw(java.awt.Graphics2D g2)
          Draws the annotation on the supplied graphics.
 void drawOutline(java.awt.Graphics2D g2)
          Draws the dashed outline of the annotation.
protected  void drawSelectionBox(java.awt.Graphics2D g)
           
 CMBPropertiesPanel getAnnotationPropertiesPanel()
           
 javax.swing.JPanel getPropertiesPanel()
          Returns the custom properties panel that is used to build the custom properties dialog for the annotation.
 void handlePropertyChange(java.lang.String propName, javax.swing.JComponent comp, int action)
           
 void init()
           
 void updateValues(int action)
           
 
Methods inherited from class com.ibm.mm.viewer.annotation.CMBPageAnnotation
addAnnotationPropertiesListener, canHide, canShow, canUpdate, clone, contains, dispose, dontDraw, drawHandles, firePropertiesChangeEvent, firePropertiesWillChangeEvent, getAnnotationRotation, getBorderColor, getBorderWidth, getCreationIndex, getCurrentIndex, getDefaultHandleHeight, getDefaultHandleWidth, getDrawRect, getFillColor, getFillRect, getFont, getInvertHorizontal, getInvertVertical, getName, getOutlineStroke, getPageNumber, getPropertiesGroupTitle, getRefreshRect, getRotateWithImage, getRotation, getTransferData, getTransferDataFlavors, getTransparent, getType, getVisibleWhileDragging, growBy, handlesShowing, isDataFlavorSupported, modifyDeltas, pleaseDraw, pointInHandle, resizeDrawRect, rotateDocRect, scaleRectangle, setAnnotationRotation, setApplyNow, setBorderColor, setBorderWidth, setCanHide, setCanShow, setCanUpdate, setCurrentIndex, setDrawRect, setFillColor, setFont, setImageHeight, setImageWidth, setInMotion, setInvertHorizontal, setInvertVertical, setPageNumber, setRotateWithImage, setRotation, setScaleNum, setTransparent, setVisibleWhileDragging, showHandles, toString, translateBy, translateDocRect, translateRotateDocRect
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CMBHighlightAnnotation

public CMBHighlightAnnotation()

CMBHighlightAnnotation

public CMBHighlightAnnotation(java.awt.Rectangle r)

CMBHighlightAnnotation

public CMBHighlightAnnotation(java.awt.Rectangle r,
                              int pageNumber)
Method Detail

init

public void init()

draw

public void draw(java.awt.Graphics2D g2)
Description copied from class: CMBPageAnnotation
Draws the annotation on the supplied graphics. This is always overriden by the subclasses
Overrides:
draw in class CMBPageAnnotation
Following copied from class: com.ibm.mm.viewer.annotation.CMBPageAnnotation
Parameters:
g2 - - Graphics to draw on

drawOutline

public void drawOutline(java.awt.Graphics2D g2)
Description copied from class: CMBPageAnnotation
Draws the dashed outline of the annotation. Useful when dragging it or resizing it. This is always overriden by the subclasses
Overrides:
drawOutline in class CMBPageAnnotation
Following copied from class: com.ibm.mm.viewer.annotation.CMBPageAnnotation
Parameters:
g2 - - Graphics to draw on

drawSelectionBox

protected void drawSelectionBox(java.awt.Graphics2D g)
Overrides:
drawSelectionBox in class CMBPageAnnotation

getAnnotationPropertiesPanel

public CMBPropertiesPanel getAnnotationPropertiesPanel()
Returns:
JPanel The panel used for this annotation type in the properties dialog to edit the properties of this annotation.

getPropertiesPanel

public javax.swing.JPanel getPropertiesPanel()
Description copied from interface: CMBAnnotationPropertiesInterface
Returns the custom properties panel that is used to build the custom properties dialog for the annotation.
Overrides:
getPropertiesPanel in class CMBPageAnnotation
Following copied from class: com.ibm.mm.viewer.annotation.CMBPageAnnotation
Returns:
JPanel The panel used for this annotation type in the properties dialog to edit the properties of this annotation.

handlePropertyChange

public void handlePropertyChange(java.lang.String propName,
                                 javax.swing.JComponent comp,
                                 int action)
Overrides:
handlePropertyChange in class CMBPageAnnotation
Following copied from interface: com.ibm.mm.viewer.annotation.CMBAnnotationPropertiesInterface
Parameters:
String -  
JComponent -  
int -  

updateValues

public void updateValues(int action)
Overrides:
updateValues in class CMBPageAnnotation
Following copied from interface: com.ibm.mm.viewer.annotation.CMBAnnotationPropertiesInterface
Parameters:
int -  

addPropertyComponent

public void addPropertyComponent(java.lang.String propertyName,
                                 javax.swing.JComponent component)
Overrides:
addPropertyComponent in class CMBPageAnnotation
Following copied from interface: com.ibm.mm.viewer.annotation.CMBAnnotationPropertiesInterface
Parameters:
String -  
JComponent -  

EIP JavaBeans

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.