com.ibm.mm.viewer.annotation

Interface CMBAnnotationConstants

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int ANN_ARROW
      Returned from CMBPageAnnotation.getType() to indicate the annotation is an arrow.
      static int ANN_CIRCLE
      Returned from CMBPageAnnotation.getType() to indicate the annotation is a circle.
      static int ANN_ERASE
      Used to indicate that the annotation tool selected is the eraser.
      static int ANN_HIGHLIGHT
      Returned from CMBPageAnnotation.getType() to indicate the annotation is a highlight.
      static int ANN_LINE
      Returned from CMBPageAnnotation.getType() to indicate the annotation is a line.
      static int ANN_MASK
      Returned from CMBPageAnnotation.getType() to indicate the annotation is a mask.
      static java.lang.String[] ANN_NAMES
      Deprecated. 
      This constant is used internally by annotation services and should not be used by applications.
      static int ANN_NOTE
      Returned from CMBPageAnnotation.getType() to indicate the annotation is a note.
      static int ANN_PEN
      Returned from CMBPageAnnotation.getType() to indicate the annotation is a pen.
      static int ANN_RECT
      Returned from CMBPageAnnotation.getType() to indicate the annotation is a rectangle.
      static int ANN_SELECT_AREA
      Used to indicate that the select area tool is selected.
      static int ANN_STAMP
      Returned from CMBPageAnnotation.getType() to indicate the annotation is a stamp.
      static int ANN_TEXT
      Returned from CMBPageAnnotation.getType() to indicate the annotation is text.
      static int ANN_UNKNOWN
      Returned from CMBPageAnnotation.getType() to indicate an unknown or unset type of annotation
      static int BOTTOM_HANDLE
      Returned by CMBPageAnnotation.getCurrentHandleType to indicate the bottom handle is the currently selected resize handle.
      static int BOTTOM_LEFT_HANDLE
      Returned by CMBPageAnnotation.getCurrentHandleType to indicate the bottom left handle is the currently selected resize handle.
      static int BOTTOM_RIGHT_HANDLE
      Returned by CMBPageAnnotation.getCurrentHandleType to indicate the bottom right handle is the currently selected resize handle.
      static int CURSOR_COUNT
      The count of the number of cursor names specified in the HANDLE_CURSOR array
      static java.awt.Color DEFAULT_BORDER_COLOR
      The default border color on annotations.
      static int DEFAULT_BORDER_WIDTH
      The default border width for annotations.
      static int DEFAULT_CURSOR
      Index into the HANDLE_CURSOR array for the name of the cursor to use by default.
      static java.awt.Point DEFAULT_CURSOR_HOTSPOT
      The location of the hotspot on the default cursor shown when the mouse is over the surface of the page and annotations can be selected.
      static boolean DEFAULT_DONT_ROTATE_WITH_IMAGE
      The default setting of the Rotate With Image property for text and note annotations.
      static java.awt.Color DEFAULT_FILL_COLOR
      The default fill color on annotations.
      static boolean DEFAULT_ROTATE_WITH_IMAGE
      The default setting of the Rotate With Image property for annotations.
      static boolean DEFAULT_TRANSPARENCY
      The default transparency for annotations.
      static boolean DEFAULT_VWD
      The default setting of the Visible While Dragging property for annotations.
      static int DELETING_ANNOTATION
      Deprecated. 
      This constant is used internally by annotation services and should not be used by applications.
      static int DISTANCE
      The amount that an annotation is moved or resized when the action is performed through the keyboard.
      static int DOUBLE_CLICK
      Deprecated. 
      This constant is used internally by annotation services and should not be used by applications.
      static java.lang.String DOWN
      Deprecated. 
      This constant is used internally and shouldn't be used by applications.
      static int DRAG_MOVE
      Deprecated. 
      This constant is used internally by annotation services and should not be used by applications.
      static int DRAG_RESIZE
      Deprecated. 
      This constant is used internally by annotation services and should not be used by applications.
      static java.lang.String[] HANDLE_CURSOR
      The names of the GIF files for the cursors used for when the mouse is over a resize handle.
      static int HANDLE_HEIGHT
      The height of annotation resize handles.
      static java.awt.Point HANDLE_HOTSPOT
      The location of the hotspot on the resize handle cursors shown when resizing annotations.
      static int HANDLE_WIDTH
      The width of annotation resize handles.
      static int IDLE
      Deprecated. 
      This constant is used internally by annotation services and should not be used by applications.
      static int IIDSP_PAGE_SCALE_FACTOR
      The scale factor used on the scale value on the CMBAnnotationSet.setScale().
      static int IIOV_ROTATE_0
      Rotation constant indicating no rotation.
      static int IIOV_ROTATE_180
      Rotation constant indicating rotation of 180 degrees.
      static int IIOV_ROTATE_270
      Rotation constant indicating rotation of 270 degrees.
      static int IIOV_ROTATE_90
      Rotation constant indicating rotation of 90 degrees.
      static int INITIAL_ANN_HEIGHT
      The height of a new annotation that is added
      static int INITIAL_ANN_WIDTH
      The width of a new annotation that is added
      static int INSERTING_ANNOTATION
      Deprecated. 
      This constant is used internally by annotation services and should not be used by applications.
      static java.lang.String LEFT
      Deprecated. 
      This constant is used internally and shouldn't be used by applications.
      static int LEFT_HANDLE
      Returned by CMBPageAnnotation.getCurrentHandleType to indicate the left handle is the currently selected resize handle.
      static int MAX_ANGLE
      The maximum angle for stamp annotations.
      static int MAX_BORDER_WIDTH
      The maximum border width for annotations.
      static int MAX_FONTSIZE
      The maxiumum font size for annotations.
      static int MIN_ANGLE
      The minimum angle for stamp annotations.
      static int MIN_BORDER_WIDTH
      The minimum border width for annotations.
      static int MIN_FONTSIZE
      The minimum font size for annotations.
      static int MOVE_CURSOR
      Index into the HANDLE_CURSOR array for the name of the cursor to use when moving annotations.
      static java.awt.Point MOVE_CURSOR_HOTSPOT
      The location of the hotspot on the move cursor shown when the mouse is over an annotation that can be moved.
      static java.lang.String[] NOTE_FONTS
      The allowed fonts for note annotations (prior to 8.3.0.1).
      static java.lang.String NOTE_SIZES
      The allowed sizes for note annotations.
      static int OPAQUE_ALPHA
      The amount of alpha on a color that is considered to be the opaque (not transparent) setting for annotations.
      static int PRIV_CREATE_ANNOTATION
      Annotation privilege to create new annotations
      static int PRIV_DELETE_ANNOTATION
      Annotation privilege to delete annotations
      static int PRIV_UPDATE_ANNOTATION
      Annotation privilege to update properties of annotations
      static int PRIV_VIEW_ANNOTATION
      Annotation privilege to view annotations
      static java.lang.String RIGHT
      Deprecated. 
      This constant is used internally and shouldn't be used by applications.
      static int RIGHT_HANDLE
      Returned by CMBPageAnnotation.getCurrentHandleType to indicate the right handle is the currently selected resize handle.
      static int START_CUSTOM_TYPE
      Starting value from which custom annotation types should be defined.
      static int TEXT_OFFSET
      The offset from the corner of a text annotation to the start of the text within the annotation.
      static int TOP_HANDLE
      Returned by CMBPageAnnotation.getCurrentHandleType to indicate the top handle is the currently selected resize handle.
      static int TOP_LEFT_HANDLE
      Returned by CMBPageAnnotation.getCurrentHandleType to indicate the top left handle is the currently selected resize handle.
      static int TOP_RIGHT_HANDLE
      Returned by CMBPageAnnotation.getCurrentHandleType to indicate the top right handle is the currently selected resize handle.
      static int TRANSPARENT_ALPHA
      The amount of alpha on a color that is considered to be the transparent setting for annotations.
      static java.lang.String UP
      Deprecated. 
      This constant is used internally and shouldn't be used by applications.
      static int UPDATE_ANN_WITH_DEFAULTS
      Action code, used with handlePropertyChange to indicate that the annotation properties should be updated with the default annotation properties (used when new annotations are created).
      static int UPDATE_ANN_WITH_GUI
      Action code, used with handlePropertyChange to indicate that the annotation properties should be updated with the values showing in the properties panel.
      static int UPDATE_DEFAULTS_WITH_ANN
      Action code, used with handlePropertyChange to indicate that the default annotation properties (used when new annotations are created) should be updated with the property values of the annotation.
      static int UPDATE_DEFAULTS_WITH_GUI
      Action code, used with handlePropertyChange to indicate that the default annotation properties (used when new annotations are created) should be updated with the property values of the annotation.
      static int UPDATE_GUI_WITH_ANN
      Action code, used with handlePropertyChange to indicate that the annotation properties panel should be updated with the property values of the annotation.
      static int UPDATE_GUI_WITH_DEFAULTS
      Action code, used with handlePropertyChange to indicate that the annotation properties panel should be updated with the default annotation properties (used when new annotations are created).
    • Field Detail

      • ANN_UNKNOWN

        static final int ANN_UNKNOWN
        Returned from CMBPageAnnotation.getType() to indicate an unknown or unset type of annotation
        See Also:
        Constant Field Values
      • ANN_ARROW

        static final int ANN_ARROW
        Returned from CMBPageAnnotation.getType() to indicate the annotation is an arrow.
        See Also:
        Constant Field Values
      • ANN_CIRCLE

        static final int ANN_CIRCLE
        Returned from CMBPageAnnotation.getType() to indicate the annotation is a circle.
        See Also:
        Constant Field Values
      • ANN_HIGHLIGHT

        static final int ANN_HIGHLIGHT
        Returned from CMBPageAnnotation.getType() to indicate the annotation is a highlight.
        See Also:
        Constant Field Values
      • ANN_LINE

        static final int ANN_LINE
        Returned from CMBPageAnnotation.getType() to indicate the annotation is a line.
        See Also:
        Constant Field Values
      • ANN_NOTE

        static final int ANN_NOTE
        Returned from CMBPageAnnotation.getType() to indicate the annotation is a note.
        See Also:
        Constant Field Values
      • ANN_PEN

        static final int ANN_PEN
        Returned from CMBPageAnnotation.getType() to indicate the annotation is a pen.
        See Also:
        Constant Field Values
      • ANN_RECT

        static final int ANN_RECT
        Returned from CMBPageAnnotation.getType() to indicate the annotation is a rectangle.
        See Also:
        Constant Field Values
      • ANN_STAMP

        static final int ANN_STAMP
        Returned from CMBPageAnnotation.getType() to indicate the annotation is a stamp.
        See Also:
        Constant Field Values
      • ANN_TEXT

        static final int ANN_TEXT
        Returned from CMBPageAnnotation.getType() to indicate the annotation is text.
        See Also:
        Constant Field Values
      • ANN_MASK

        static final int ANN_MASK
        Returned from CMBPageAnnotation.getType() to indicate the annotation is a mask.
        See Also:
        Constant Field Values
      • ANN_ERASE

        static final int ANN_ERASE
        Used to indicate that the annotation tool selected is the eraser.
        See Also:
        Constant Field Values
      • ANN_SELECT_AREA

        static final int ANN_SELECT_AREA
        Used to indicate that the select area tool is selected.
        See Also:
        Constant Field Values
      • START_CUSTOM_TYPE

        static final int START_CUSTOM_TYPE
        Starting value from which custom annotation types should be defined.
        See Also:
        Constant Field Values
      • ANN_NAMES

        static final java.lang.String[] ANN_NAMES
        Deprecated. This constant is used internally by annotation services and should not be used by applications.
        An array of the names of all built-in annotations. The index into this array is the annotation type constant (obtained from CMBPageAnnotation.getType()).
      • DRAG_RESIZE

        static final int DRAG_RESIZE
        Deprecated. This constant is used internally by annotation services and should not be used by applications.
        The controller is in this state when resizing an annotation object
        See Also:
        Constant Field Values
      • DRAG_MOVE

        static final int DRAG_MOVE
        Deprecated. This constant is used internally by annotation services and should not be used by applications.
        The controller is in this state when moving an annotation object
        See Also:
        Constant Field Values
      • IDLE

        static final int IDLE
        Deprecated. This constant is used internally by annotation services and should not be used by applications.
        The controller is in this state when not moving, resizing, inserting, or deleting annotations.
        See Also:
        Constant Field Values
      • INSERTING_ANNOTATION

        static final int INSERTING_ANNOTATION
        Deprecated. This constant is used internally by annotation services and should not be used by applications.
        The controller is in this state when an annotation is about to be inserted.
        See Also:
        Constant Field Values
      • DELETING_ANNOTATION

        static final int DELETING_ANNOTATION
        Deprecated. This constant is used internally by annotation services and should not be used by applications.
        The controller is in this state when an annotation is about to be deleted.
        See Also:
        Constant Field Values
      • DOUBLE_CLICK

        static final int DOUBLE_CLICK
        Deprecated. This constant is used internally by annotation services and should not be used by applications.
        Indicates a double-click mouse event.
        See Also:
        Constant Field Values
      • IIDSP_PAGE_SCALE_FACTOR

        static final int IIDSP_PAGE_SCALE_FACTOR
        The scale factor used on the scale value on the CMBAnnotationSet.setScale().
        See Also:
        Constant Field Values
      • HANDLE_WIDTH

        static final int HANDLE_WIDTH
        The width of annotation resize handles.
        See Also:
        Constant Field Values
      • HANDLE_HEIGHT

        static final int HANDLE_HEIGHT
        The height of annotation resize handles.
        See Also:
        Constant Field Values
      • TEXT_OFFSET

        static final int TEXT_OFFSET
        The offset from the corner of a text annotation to the start of the text within the annotation.
        See Also:
        Constant Field Values
      • TRANSPARENT_ALPHA

        static final int TRANSPARENT_ALPHA
        The amount of alpha on a color that is considered to be the transparent setting for annotations.
        See Also:
        Constant Field Values
      • OPAQUE_ALPHA

        static final int OPAQUE_ALPHA
        The amount of alpha on a color that is considered to be the opaque (not transparent) setting for annotations.
        See Also:
        Constant Field Values
      • NOTE_FONTS

        static final java.lang.String[] NOTE_FONTS
        The allowed fonts for note annotations (prior to 8.3.0.1).
      • NOTE_SIZES

        static final java.lang.String NOTE_SIZES
        The allowed sizes for note annotations.
        See Also:
        Constant Field Values
      • HANDLE_CURSOR

        static final java.lang.String[] HANDLE_CURSOR
        The names of the GIF files for the cursors used for when the mouse is over a resize handle.
      • TOP_HANDLE

        static final int TOP_HANDLE
        Returned by CMBPageAnnotation.getCurrentHandleType to indicate the top handle is the currently selected resize handle.
        See Also:
        Constant Field Values
      • TOP_RIGHT_HANDLE

        static final int TOP_RIGHT_HANDLE
        Returned by CMBPageAnnotation.getCurrentHandleType to indicate the top right handle is the currently selected resize handle.
        See Also:
        Constant Field Values
      • RIGHT_HANDLE

        static final int RIGHT_HANDLE
        Returned by CMBPageAnnotation.getCurrentHandleType to indicate the right handle is the currently selected resize handle.
        See Also:
        Constant Field Values
      • BOTTOM_RIGHT_HANDLE

        static final int BOTTOM_RIGHT_HANDLE
        Returned by CMBPageAnnotation.getCurrentHandleType to indicate the bottom right handle is the currently selected resize handle.
        See Also:
        Constant Field Values
      • BOTTOM_HANDLE

        static final int BOTTOM_HANDLE
        Returned by CMBPageAnnotation.getCurrentHandleType to indicate the bottom handle is the currently selected resize handle.
        See Also:
        Constant Field Values
      • BOTTOM_LEFT_HANDLE

        static final int BOTTOM_LEFT_HANDLE
        Returned by CMBPageAnnotation.getCurrentHandleType to indicate the bottom left handle is the currently selected resize handle.
        See Also:
        Constant Field Values
      • LEFT_HANDLE

        static final int LEFT_HANDLE
        Returned by CMBPageAnnotation.getCurrentHandleType to indicate the left handle is the currently selected resize handle.
        See Also:
        Constant Field Values
      • TOP_LEFT_HANDLE

        static final int TOP_LEFT_HANDLE
        Returned by CMBPageAnnotation.getCurrentHandleType to indicate the top left handle is the currently selected resize handle.
        See Also:
        Constant Field Values
      • MOVE_CURSOR

        static final int MOVE_CURSOR
        Index into the HANDLE_CURSOR array for the name of the cursor to use when moving annotations.
        See Also:
        Constant Field Values
      • DEFAULT_CURSOR

        static final int DEFAULT_CURSOR
        Index into the HANDLE_CURSOR array for the name of the cursor to use by default.
        See Also:
        Constant Field Values
      • CURSOR_COUNT

        static final int CURSOR_COUNT
        The count of the number of cursor names specified in the HANDLE_CURSOR array
        See Also:
        Constant Field Values
      • HANDLE_HOTSPOT

        static final java.awt.Point HANDLE_HOTSPOT
        The location of the hotspot on the resize handle cursors shown when resizing annotations.
      • MOVE_CURSOR_HOTSPOT

        static final java.awt.Point MOVE_CURSOR_HOTSPOT
        The location of the hotspot on the move cursor shown when the mouse is over an annotation that can be moved.
      • DEFAULT_CURSOR_HOTSPOT

        static final java.awt.Point DEFAULT_CURSOR_HOTSPOT
        The location of the hotspot on the default cursor shown when the mouse is over the surface of the page and annotations can be selected.
      • INITIAL_ANN_WIDTH

        static final int INITIAL_ANN_WIDTH
        The width of a new annotation that is added
        See Also:
        Constant Field Values
      • INITIAL_ANN_HEIGHT

        static final int INITIAL_ANN_HEIGHT
        The height of a new annotation that is added
        See Also:
        Constant Field Values
      • UPDATE_ANN_WITH_GUI

        static final int UPDATE_ANN_WITH_GUI
        Action code, used with handlePropertyChange to indicate that the annotation properties should be updated with the values showing in the properties panel.
        See Also:
        Constant Field Values
      • UPDATE_GUI_WITH_ANN

        static final int UPDATE_GUI_WITH_ANN
        Action code, used with handlePropertyChange to indicate that the annotation properties panel should be updated with the property values of the annotation.
        See Also:
        Constant Field Values
      • UPDATE_DEFAULTS_WITH_ANN

        static final int UPDATE_DEFAULTS_WITH_ANN
        Action code, used with handlePropertyChange to indicate that the default annotation properties (used when new annotations are created) should be updated with the property values of the annotation.
        See Also:
        Constant Field Values
      • UPDATE_ANN_WITH_DEFAULTS

        static final int UPDATE_ANN_WITH_DEFAULTS
        Action code, used with handlePropertyChange to indicate that the annotation properties should be updated with the default annotation properties (used when new annotations are created).
        See Also:
        Constant Field Values
      • UPDATE_GUI_WITH_DEFAULTS

        static final int UPDATE_GUI_WITH_DEFAULTS
        Action code, used with handlePropertyChange to indicate that the annotation properties panel should be updated with the default annotation properties (used when new annotations are created).
        See Also:
        Constant Field Values
      • UPDATE_DEFAULTS_WITH_GUI

        static final int UPDATE_DEFAULTS_WITH_GUI
        Action code, used with handlePropertyChange to indicate that the default annotation properties (used when new annotations are created) should be updated with the property values of the annotation.
        See Also:
        Constant Field Values
      • IIOV_ROTATE_0

        static final int IIOV_ROTATE_0
        Rotation constant indicating no rotation. Used on methods that take a rotation value.
        See Also:
        Constant Field Values
      • IIOV_ROTATE_90

        static final int IIOV_ROTATE_90
        Rotation constant indicating rotation of 90 degrees. Used on methods that take a rotation value.
        See Also:
        Constant Field Values
      • IIOV_ROTATE_180

        static final int IIOV_ROTATE_180
        Rotation constant indicating rotation of 180 degrees. Used on methods that take a rotation value.
        See Also:
        Constant Field Values
      • IIOV_ROTATE_270

        static final int IIOV_ROTATE_270
        Rotation constant indicating rotation of 270 degrees. Used on methods that take a rotation value.
        See Also:
        Constant Field Values
      • PRIV_VIEW_ANNOTATION

        static final int PRIV_VIEW_ANNOTATION
        Annotation privilege to view annotations
        See Also:
        Constant Field Values
      • PRIV_CREATE_ANNOTATION

        static final int PRIV_CREATE_ANNOTATION
        Annotation privilege to create new annotations
        See Also:
        Constant Field Values
      • PRIV_DELETE_ANNOTATION

        static final int PRIV_DELETE_ANNOTATION
        Annotation privilege to delete annotations
        See Also:
        Constant Field Values
      • PRIV_UPDATE_ANNOTATION

        static final int PRIV_UPDATE_ANNOTATION
        Annotation privilege to update properties of annotations
        See Also:
        Constant Field Values
      • MIN_BORDER_WIDTH

        static final int MIN_BORDER_WIDTH
        The minimum border width for annotations.
        See Also:
        Constant Field Values
      • MAX_BORDER_WIDTH

        static final int MAX_BORDER_WIDTH
        The maximum border width for annotations.
        See Also:
        Constant Field Values
      • MIN_ANGLE

        static final int MIN_ANGLE
        The minimum angle for stamp annotations.
        See Also:
        Constant Field Values
      • MAX_ANGLE

        static final int MAX_ANGLE
        The maximum angle for stamp annotations.
        See Also:
        Constant Field Values
      • MIN_FONTSIZE

        static final int MIN_FONTSIZE
        The minimum font size for annotations.
        See Also:
        Constant Field Values
      • MAX_FONTSIZE

        static final int MAX_FONTSIZE
        The maxiumum font size for annotations.
        See Also:
        Constant Field Values
      • UP

        static final java.lang.String UP
        Deprecated. This constant is used internally and shouldn't be used by applications.
        Constant indicating move or resize the annotation upward.
        See Also:
        Constant Field Values
      • DOWN

        static final java.lang.String DOWN
        Deprecated. This constant is used internally and shouldn't be used by applications.
        Constant indicating move or resize the annotation downward.
        See Also:
        Constant Field Values
      • RIGHT

        static final java.lang.String RIGHT
        Deprecated. This constant is used internally and shouldn't be used by applications.
        Constant indicating move or resize the annotation to the right.
        See Also:
        Constant Field Values
      • LEFT

        static final java.lang.String LEFT
        Deprecated. This constant is used internally and shouldn't be used by applications.
        Constant indicating move or resize the annotation to the left.
        See Also:
        Constant Field Values
      • DISTANCE

        static final int DISTANCE
        The amount that an annotation is moved or resized when the action is performed through the keyboard.
        See Also:
        Constant Field Values
      • DEFAULT_BORDER_COLOR

        static final java.awt.Color DEFAULT_BORDER_COLOR
        The default border color on annotations.
      • DEFAULT_FILL_COLOR

        static final java.awt.Color DEFAULT_FILL_COLOR
        The default fill color on annotations.
      • DEFAULT_BORDER_WIDTH

        static final int DEFAULT_BORDER_WIDTH
        The default border width for annotations.
        See Also:
        Constant Field Values
      • DEFAULT_VWD

        static final boolean DEFAULT_VWD
        The default setting of the Visible While Dragging property for annotations.
        See Also:
        Constant Field Values
      • DEFAULT_TRANSPARENCY

        static final boolean DEFAULT_TRANSPARENCY
        The default transparency for annotations.
        See Also:
        Constant Field Values
      • DEFAULT_ROTATE_WITH_IMAGE

        static final boolean DEFAULT_ROTATE_WITH_IMAGE
        The default setting of the Rotate With Image property for annotations.
        See Also:
        Constant Field Values
      • DEFAULT_DONT_ROTATE_WITH_IMAGE

        static final boolean DEFAULT_DONT_ROTATE_WITH_IMAGE
        The default setting of the Rotate With Image property for text and note annotations.
        See Also:
        Constant Field Values