IDrawingLayer (IQM 3.5 API)

All Superinterfaces:

IDrawingLayerSupport

All Known Implementing Classes:

DefaultDrawingLayer, TransparentROILayer
```
public interface IDrawingLayer
extends IDrawingLayerSupport
```
This interface declares methods for a layer where the user may draw regions of interest (ROIs) of various shapes.

Author:

Philipp Kainz

Field Summary

Fields
Modifier and Type	Field and Description
`static Integer`	`ACTIVE_FRONT_LAYER` This constant defines the layer where the topmost component goes.
`static Integer`	`DEFAULT_IMAGE_LAYER` This constant defines the default position of the image layer.
`static Color`	`DEFAULT_LAYER_COLOR` The standard color for a new layer.
`static String`	`DEFAULT_LAYER_COLOR_NAME` The variable name of the default layer color.
`static BasicStroke`	`DEFAULT_LAYER_STROKE` The standard stroke of the layer.
`static String`	`DEFAULT_LAYER_STROKE_NAME` The variable name of the default layer stroke.
`static Integer`	`DRAGGING_LAYER` The dragging layer in this layer, where the mouse dragged gestures are drawn.
`static Color`	`HIGHLIGHT_COLOR` The color for highlighting a ROI shape on the layer.
`static String`	`HIGHLIGHT_COLOR_NAME` The variable name of the highlight layer color.
`static BasicStroke`	`HIGHLIGHT_STROKE` The standard stroke for highlighting a shape on the layer.
`static String`	`HIGHLIGHT_STROKE_NAME` The variable name of the stroke for highlighting a shape.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addAllDefaultListeners()` Adds all default listeners.
`void`	`addDefaultCanvasMover()` (Re-)Adds the default key listener.
`void`	`fireNewProperties(javax.media.jai.ROIShape roi)` This method updates the additional information in the `ImageInfoPanel` according to the given `ROIShape`.
`List<javax.media.jai.ROIShape>`	`getAllROIShapes()` Get the list of all `ROIShape`s in this layer.
`ArrayList<AngleROI>`	`getAngleROIs()` Get all `AngleROI`s drawn in this layer.
`GeneralPath`	`getAngleShape()` A helper variable used by mouse event handlers to draw `AngleROI`s.
`javax.media.jai.ROIShape`	`getClickedROIShape()` Get the previously clicked `ROIShape`.
`AngleROI`	`getCurrentAngleROI()` Get the current `AngleROI` in this layer.
`EllipseROI`	`getCurrentEllipseROI()` Get the current `EllipseROI` in this layer.
`FreehandROI`	`getCurrentFreehandROI()` Get the current `FreehandROI` in this layer.
`LineROI`	`getCurrentLineROI()` Get the current `LineROI` in this layer.
`PointROI`	`getCurrentPointROI()` Get the current `PointROI` in this layer.
`PolygonROI`	`getCurrentPolygonROI()` Get the current `PolygonROI` in this layer.
`RectangleROI`	`getCurrentRectangleROI()` Get the current `RectangleROI` in this layer.
`javax.media.jai.ROIShape`	`getCurrentROIShape()` Get the currently selected `ROIShape`.
`ROILayerCursorChanger`	`getCursorChanger()`
`Color`	`getDefaultLayerColor()`
`BasicStroke`	`getDefaultROIStroke()`
`int`	`getElementCount()` Gets the total amount of elements in this layer.
`ArrayList<EllipseROI>`	`getEllipseROIs()` Get all `EllipseROI`s in this layer.
`ArrayList<FreehandROI>`	`getFreehandROIs()` Get all drawn `FreehandROI`s in this layer.
`GeneralPath`	`getFreehandShape()` Gets the path of the latest drawn shape.
`Color`	`getHighlightColor()`
`BasicStroke`	`getHighlightStroke()`
`UUID`	`getID()` Gets the unique ID of this drawing layer.
`Color`	`getLayerColor()` Get the color for ROIs on this layer.
`Color`	`getLineROIBoundaryColor()`
`Color`	`getLineROIBoundaryRectangleColor()`
`ArrayList<LineROI>`	`getLineROIs()` Get all `LineROI`s in this layer.
`String`	`getName()` Get the name of the layer.
`int`	`getNumAnglePoints()` A helper variable used by mouse event handlers to draw `AngleROI`s.
`int`	`getNumPolyPoints()` Gets the number of corners of the currently drawn `PolygonROI`.
`ArrayList<PointROI>`	`getPointROIs()` Get all `PointROI`s in this layer.
`ArrayList<PolygonROI>`	`getPolygonROIs()` Get all drawn `PolygonROI`s in this layer.
`GeneralPath`	`getPolygonShape()` Gets the shape of the latest `PolygonROI`.
`ArrayList<RectangleROI>`	`getRectangleROIs()` Get all `RectangleROI`s in this layer.
`Color`	`getRoiBoundaryRectangleColor()`
`javax.media.jai.ROIShape`	`getRoiShapeForHighlighting()`
`int`	`getRoiShiftX0()` Get the x-coordinate of the target point of a translation (shift) without transformation of a ROI.
`int`	`getRoiShiftY0()` Get the y-coordinate of the target point of a translation (shift) without transformation of a ROI.
`int`	`getRoiX0()` Get the x-coordinate of the target point of a translation (shift) without transformation of a ROI.
`int`	`getRoiY0()` Get the y-coordinate of the target point of a translation (shift) without transformation of a ROI.
`javax.media.jai.ROIShape`	`getTmpROIShape()` Gets the temporary ROI shape to be drawn additionally to all present ones.
`int`	`getZOrder()` The order of the layer in z-direction.
`boolean`	`hasROIs()` Determines whether or not the layer contains any ROI shapes.
`boolean`	`isEmpty()` Determines whether or not the layer is empty.
`boolean`	`isInsidePtEast()` Determines whether or not the mouse is inside of the east boundary point.
`boolean`	`isInsidePtNorth()` Determines whether or not the mouse is inside of the north boundary point.
`boolean`	`isInsidePtNorthEast()` Determines whether or not the mouse is inside of the north-east boundary point.
`boolean`	`isInsidePtNorthWest()` Determines whether or not the mouse is inside of the north-west boundary point.
`boolean`	`isInsidePtSouth()` Determines whether or not the mouse is inside of the south boundary point.
`boolean`	`isInsidePtSouthEast()` Determines whether or not the mouse is inside of the south-east boundary point.
`boolean`	`isInsidePtSouthWest()` Determines whether or not the mouse is inside of the south-west boundary point.
`boolean`	`isInsidePtWest()` Determines whether or not the mouse is inside of the west boundary point.
`boolean`	`isInsideRoi()` Determines whether or not the mouse is inside of a drawn shape.
`boolean`	`isLayerVisible()` A flag whether or not the layer is visible in the canvas.
`boolean`	`isROIDragging()` Get a flag determining whether or not a ROI is currently being dragged by mouse gesture.
`boolean`	`isSelected()` Get the selection state of this layer.
`void`	`removeAllDefaultListeners()` Removes all default listeners.
`void`	`removeDefaultCanvasMover()` Removes the default key layer listener.
`void`	`removeRoiShapeForHighlighting()`
`void`	`removeTmpROIShape()`
`void`	`setAllROIShapes(List<javax.media.jai.ROIShape> shapes)` Sets all ROI shapes in this layer.
`void`	`setAngleROIs(ArrayList<AngleROI> angleROIs)` Set all `AngleROI`s in this layer.
`void`	`setAngleShape(GeneralPath angleShape)` A helper variable used by mouse event handlers to draw `AngleROI`s.
`void`	`setBoundEditableRectangles(javax.media.jai.ROIShape[] rs)`
`void`	`setBoundEditableRectanglesUntransformed(javax.media.jai.ROIShape[] boundEditableRectanglesUntransformed)`
`void`	`setClickedROIShape(javax.media.jai.ROIShape clickedROIShape)` Set the currently clicked `ROIShape`.
`void`	`setCurrentAngleROI(AngleROI currentAngleROI)` Set the current `AngleROI` in this layer.
`void`	`setCurrentEllipseROI(EllipseROI currentEllipseROI)` Set the current `EllipseROI` in this layer.
`void`	`setCurrentFreehandROI(FreehandROI currentFreehandROI)` Set the current `FreehandROI`.
`void`	`setCurrentLineROI(LineROI currentLineROI)` Set the current `LineROI` in this layer.
`void`	`setCurrentPointROI(PointROI currentPointROI)` Set the current `PointROI` in this layer.
`void`	`setCurrentPolygonROI(PolygonROI currentPolygonROI)` Set the current `PolygonROI`.
`void`	`setCurrentRectangleROI(RectangleROI currentRectangleROI)` Set the current `RectangleROI` in this layer.
`void`	`setCurrentROIShape(javax.media.jai.ROIShape shape)` Set the currently selected (active) `ROIShape`.
`void`	`setCursor(Cursor cursor)` Sets a `Cursor` to this layer.
`void`	`setDefaultLayerColor(Color defaultLayerColor)`
`void`	`setDefaultROIStroke(BasicStroke defaultROIStroke)`
`void`	`setEllipseROIs(ArrayList<EllipseROI> ellipseROIs)` Set all `EllipseROI`s in this layer.
`void`	`setFreehandROIs(ArrayList<FreehandROI> freehandROIs)` Set all `FreehandROI`s in this layer.
`void`	`setFreehandShape(GeneralPath freehandShape)` Set the path of the latest shape.
`void`	`setHighlightColor(Color highlightColor)`
`void`	`setHighlightStroke(BasicStroke highlightStroke)`
`void`	`setID(UUID id)` Sets the unique ID of this drawing layer.
`void`	`setInsidePtEast(boolean isInsidePtEast)` Set a flag whether or not the mouse is in the east boundary point.
`void`	`setInsidePtNorth(boolean isInsidePtNorth)` Set a flag whether or not the mouse is in the north boundary point.
`void`	`setInsidePtNorthEast(boolean isInsidePtNorthEast)` Set a flag whether or not the mouse is in the north-east boundary point.
`void`	`setInsidePtNorthWest(boolean isInsidePtNorthWest)` Set a flag whether or not the mouse is in the north-west boundary point.
`void`	`setInsidePtSouth(boolean isInsidePtSouth)` Set a flag whether or not the mouse is in the south boundary point.
`void`	`setInsidePtSouthEast(boolean isInsidePtSouthEast)` Set a flag whether or not the mouse is in the south-east boundary point.
`void`	`setInsidePtSouthWest(boolean isInsidePtSouthWest)` Set a flag whether or not the mouse is in the south-west boundary point.
`void`	`setInsidePtWest(boolean isInsidePtWest)` Set a flag whether or not the mouse is in the west boundary point.
`void`	`setInsideRoi(boolean isInsideRoi)` Set a flag whether or not the mouse is inside of a drawn shape.
`void`	`setLayerColor(Color color)` Set the color for ROIs on this layer.
`void`	`setLayerVisible(boolean visible)` Set a flag determining whether or not the layer is visible in the canvas.
`void`	`setLineROIs(ArrayList<LineROI> lineROIs)` Set all `LineROI`s in this layer.
`void`	`setName(String name)` Determine the name of the layer which is shown in the selection panel.
`void`	`setNumAnglePoints(int numAnglePoints)` A helper variable used by mouse event handlers to draw `AngleROI`s.
`void`	`setNumPolyPoints(int numPolyPoints)` Set the number of `PolygonROI` corners of the currently drawn polygon ROI.
`void`	`setPointROIs(ArrayList<PointROI> pointROIs)` Set all `PointROI`s in this layer.
`void`	`setPolygonROIs(ArrayList<PolygonROI> polygonROIs)` Set all `PolygonROI`s in this layer.
`void`	`setPolygonShape(GeneralPath polygonShape)` Sets the shape of the latest `PolygonROI`.
`void`	`setRectangleROIs(ArrayList<RectangleROI> rectangleROIs)` Set all `RectangleROI`s in this layer.
`void`	`setROIDragging(boolean isROIDragging)` Set a flag whether or not a ROI is being dragged by mouse gesture.
`void`	`setRoiShiftX0(int roiShiftX0)` Set the x-coordinate of the target point of a translation (shift) without transformation of a ROI.
`void`	`setRoiShiftY0(int roiShiftY0)` Set the y-coordinate of the target point of a translation (shift) without transformation of a ROI.
`void`	`setRoiX0(int roiX0)` Set the x-coordinate of the origin of a translation (shift) without transformation of a ROI.
`void`	`setRoiY0(int roiY0)` Set the y-coordinate of the origin of a translation (shift) without transformation of a ROI.
`void`	`setSelected(boolean selected)` Set the selection state of this layer.
`void`	`setTmpROIShape(javax.media.jai.ROIShape tmp)` Sets a current ROI shape to be drawn additionally to all present ones.
`void`	`setZOrder(int order)` Determine the order of the layer in z-direction.
`void`	`update()` Advise the `IDrawingLayer` to repaint all shapes.

Methods inherited from interface at.mug.iqm.api.gui.IDrawingLayerSupport
deleteAllROIs, deleteROI, deleteROIs, deleteSelectedROI, drawAngleROI, drawAngleROIs, drawEllipseROI, drawEllipseROIs, drawFreehandROI, drawFreehandROIs, drawLineROI, drawLineROIs, drawPointROI, drawPointROIs, drawPolygonROI, drawPolygonROIs, drawRectangleROI, drawRectangleROIs, drawROI, drawROIs

- Field Detail
  - DEFAULT_IMAGE_LAYER
```
static final Integer DEFAULT_IMAGE_LAYER
```
    This constant defines the default position of the image layer.
  - ACTIVE_FRONT_LAYER
```
static final Integer ACTIVE_FRONT_LAYER
```
    This constant defines the layer where the topmost component goes.
  - DRAGGING_LAYER
```
static final Integer DRAGGING_LAYER
```
    The dragging layer in this layer, where the mouse dragged gestures are drawn.
  - DEFAULT_LAYER_COLOR_NAME
```
static final String DEFAULT_LAYER_COLOR_NAME
```
    The variable name of the default layer color.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LAYER_COLOR
```
static final Color DEFAULT_LAYER_COLOR
```
    The standard color for a new layer.
  - DEFAULT_LAYER_STROKE_NAME
```
static final String DEFAULT_LAYER_STROKE_NAME
```
    The variable name of the default layer stroke.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LAYER_STROKE
```
static final BasicStroke DEFAULT_LAYER_STROKE
```
    The standard stroke of the layer.
  - HIGHLIGHT_COLOR_NAME
```
static final String HIGHLIGHT_COLOR_NAME
```
    The variable name of the highlight layer color.
    
    See Also:
    
    Constant Field Values
  - HIGHLIGHT_COLOR
```
static final Color HIGHLIGHT_COLOR
```
    The color for highlighting a ROI shape on the layer.
  - HIGHLIGHT_STROKE_NAME
```
static final String HIGHLIGHT_STROKE_NAME
```
    The variable name of the stroke for highlighting a shape.
    
    See Also:
    
    Constant Field Values
  - HIGHLIGHT_STROKE
```
static final BasicStroke HIGHLIGHT_STROKE
```
    The standard stroke for highlighting a shape on the layer.
- Method Detail
  - setName
```
void setName(String name)
```
    Determine the name of the layer which is shown in the selection panel.
    
    Parameters:
    
    name - a unique name of the layer
  - getName
```
String getName()
```
    Get the name of the layer.
    
    Returns:
    
    the unique name of the layer
  - getZOrder
```
int getZOrder()
```
    The order of the layer in z-direction. Values >0 are permitted.
    
    Returns:
    
    an Integer indicating the layer's order in a stack of layers
  - setZOrder
```
void setZOrder(int order)
```
    Determine the order of the layer in z-direction. Values >0 are permitted.
    
    Parameters:
    
    order - an Integer indicating the layer's order in a stack of layers
  - isLayerVisible
```
boolean isLayerVisible()
```
    A flag whether or not the layer is visible in the canvas.
    
    Returns:
    
    true, if the layer's components are drawn on the canvas, false otherwise
  - setLayerVisible
```
void setLayerVisible(boolean visible)
```
    Set a flag determining whether or not the layer is visible in the canvas.
    
    Parameters:
    
    visible - set to true, if the layer's components should be drawn on the canvas, false otherwise
  - setLayerColor
```
void setLayerColor(Color color)
```
    Set the color for ROIs on this layer.
    
    Parameters:
    
    color -
  - getLayerColor
```
Color getLayerColor()
```
    Get the color for ROIs on this layer.
    
    Returns:
    
    the color
  - setSelected
```
void setSelected(boolean selected)
```
    Set the selection state of this layer.
    
    Parameters:
    
    selected -
  - isSelected
```
boolean isSelected()
```
    Get the selection state of this layer.
    
    Returns:
    
    true if the layer is selected, false otherwise
  - getElementCount
```
int getElementCount()
```
    Gets the total amount of elements in this layer.
    
    Returns:
    
    an integer value indicating the number of elements
  - isEmpty
```
boolean isEmpty()
```
    Determines whether or not the layer is empty.
    
    Returns:
    
    a flag
  - setAngleROIs
```
void setAngleROIs(ArrayList<AngleROI> angleROIs)
```
    Set all AngleROIs in this layer.
    
    Parameters:
    
    angleROIs -
  - getAngleROIs
```
ArrayList<AngleROI> getAngleROIs()
```
    Get all AngleROIs drawn in this layer.
    
    Returns:
    
    all angleROIs
  - setNumAnglePoints
```
void setNumAnglePoints(int numAnglePoints)
```
    A helper variable used by mouse event handlers to draw AngleROIs.
    
    Parameters:
    
    numAnglePoints -
  - getNumAnglePoints
```
int getNumAnglePoints()
```
    A helper variable used by mouse event handlers to draw AngleROIs.
    
    Returns:
    
    the number of currently drawn angle points
  - setAngleShape
```
void setAngleShape(GeneralPath angleShape)
```
    A helper variable used by mouse event handlers to draw AngleROIs.
    
    Parameters:
    
    angleShape - the shape of the angle, usually 2 legs, determined by 3 points
  - getAngleShape
```
GeneralPath getAngleShape()
```
    A helper variable used by mouse event handlers to draw AngleROIs.
    
    Returns:
    
    the shape of the angle, usually 2 legs, determined by 3 points
  - setCurrentAngleROI
```
void setCurrentAngleROI(AngleROI currentAngleROI)
```
    Set the current AngleROI in this layer. The current AngleROI will be highlighted first on editing ROIs.
    
    Parameters:
    
    currentAngleROI - an AngleROI
  - getCurrentAngleROI
```
AngleROI getCurrentAngleROI()
```
    Get the current AngleROI in this layer.
    
    Returns:
    
    the current AngleROI
  - setPolygonROIs
```
void setPolygonROIs(ArrayList<PolygonROI> polygonROIs)
```
    Set all PolygonROIs in this layer. This will overwrite any existing PolygonROIs.
    
    Parameters:
    
    polygonROIs -
  - getPolygonROIs
```
ArrayList<PolygonROI> getPolygonROIs()
```
    Get all drawn PolygonROIs in this layer.
    
    Returns:
    
    a list of PolygonROIs in this layer.
  - setCurrentPolygonROI
```
void setCurrentPolygonROI(PolygonROI currentPolygonROI)
```
    Set the current PolygonROI.
    
    Parameters:
    
    currentPolygonROI -
  - getCurrentPolygonROI
```
PolygonROI getCurrentPolygonROI()
```
    Get the current PolygonROI in this layer.
    
    Returns:
    
    the selected or latest PolygonROI, or null if there is no PolygonROI present
  - setPolygonShape
```
void setPolygonShape(GeneralPath polygonShape)
```
    Sets the shape of the latest PolygonROI.
    
    Parameters:
    
    polygonShape -
  - getPolygonShape
```
GeneralPath getPolygonShape()
```
    Gets the shape of the latest PolygonROI.
    
    Returns:
    
    the shape or null, if there is no PolygonROI
  - setNumPolyPoints
```
void setNumPolyPoints(int numPolyPoints)
```
    Set the number of PolygonROI corners of the currently drawn polygon ROI.
    
    Parameters:
    
    numPolyPoints -
  - getNumPolyPoints
```
int getNumPolyPoints()
```
    Gets the number of corners of the currently drawn PolygonROI.
    
    Returns:
    
    the number of polygon points
  - setFreehandROIs
```
void setFreehandROIs(ArrayList<FreehandROI> freehandROIs)
```
    Set all FreehandROIs in this layer. This will overwrite any existing FreehandROIs.
    
    Parameters:
    
    freehandROIs -
  - getFreehandROIs
```
ArrayList<FreehandROI> getFreehandROIs()
```
    Get all drawn FreehandROIs in this layer.
    
    Returns:
    
    a list of FreehandROIs in this layer.
  - setCurrentFreehandROI
```
void setCurrentFreehandROI(FreehandROI currentFreehandROI)
```
    Set the current FreehandROI.
    
    Parameters:
    
    currentFreehandROI -
  - getCurrentFreehandROI
```
FreehandROI getCurrentFreehandROI()
```
    Get the current FreehandROI in this layer.
    
    Returns:
    
    the selected or latest FreehandROI, or null if there is no FreehandROI present
  - setFreehandShape
```
void setFreehandShape(GeneralPath freehandShape)
```
    Set the path of the latest shape.
    
    Parameters:
    
    freehandShape -
  - getFreehandShape
```
GeneralPath getFreehandShape()
```
    Gets the path of the latest drawn shape.
    
    Returns:
    
    the path or null
  - setEllipseROIs
```
void setEllipseROIs(ArrayList<EllipseROI> ellipseROIs)
```
    Set all EllipseROIs in this layer. This will overwrite the entire list of ellipse rois in this layer.
    
    Parameters:
    
    ellipseROIs -
  - getEllipseROIs
```
ArrayList<EllipseROI> getEllipseROIs()
```
    Get all EllipseROIs in this layer.
    
    Returns:
    
    a list of ellipse rois in this layer
  - setCurrentEllipseROI
```
void setCurrentEllipseROI(EllipseROI currentEllipseROI)
```
    Set the current EllipseROI in this layer.
    
    Parameters:
    
    currentEllipseROI -
  - getCurrentEllipseROI
```
EllipseROI getCurrentEllipseROI()
```
    Get the current EllipseROI in this layer.
    
    Returns:
    
    the selected EllipseROI or the shape that has been drawn latest
  - setRectangleROIs
```
void setRectangleROIs(ArrayList<RectangleROI> rectangleROIs)
```
    Set all RectangleROIs in this layer. This will overwrite the entire list of rectangle rois in this layer.
    
    Parameters:
    
    rectangleROIs -
  - getRectangleROIs
```
ArrayList<RectangleROI> getRectangleROIs()
```
    Get all RectangleROIs in this layer.
    
    Returns:
    
    a list of rectangle rois in this layer
  - setCurrentRectangleROI
```
void setCurrentRectangleROI(RectangleROI currentRectangleROI)
```
    Set the current RectangleROI in this layer.
    
    Parameters:
    
    currentRectangleROI -
  - getCurrentRectangleROI
```
RectangleROI getCurrentRectangleROI()
```
    Get the current RectangleROI in this layer.
    
    Returns:
    
    the selected RectangleROI or the shape that has been drawn latest
  - setCurrentLineROI
```
void setCurrentLineROI(LineROI currentLineROI)
```
    Set the current LineROI in this layer.
    
    Parameters:
    
    currentLineROI -
  - getCurrentLineROI
```
LineROI getCurrentLineROI()
```
    Get the current LineROI in this layer.
    
    Returns:
    
    the selected LineROI or the shape that has been drawn latest
  - setLineROIs
```
void setLineROIs(ArrayList<LineROI> lineROIs)
```
    Set all LineROIs in this layer. This will overwrite the entire list of line rois in this layer.
    
    Parameters:
    
    lineROIs -
  - getLineROIs
```
ArrayList<LineROI> getLineROIs()
```
    Get all LineROIs in this layer.
    
    Returns:
    
    a list of line rois in this layer
  - getCurrentPointROI
```
PointROI getCurrentPointROI()
```
    Get the current PointROI in this layer.
    
    Returns:
    
    the selected PointROI or the shape that has been drawn latest
  - setCurrentPointROI
```
void setCurrentPointROI(PointROI currentPointROI)
```
    Set the current PointROI in this layer.
    
    Parameters:
    
    currentPointROI -
  - setPointROIs
```
void setPointROIs(ArrayList<PointROI> pointROIs)
```
    Set all PointROIs in this layer. This will overwrite the entire list of point rois in this layer.
    
    Parameters:
    
    pointROIs -
  - getPointROIs
```
ArrayList<PointROI> getPointROIs()
```
    Get all PointROIs in this layer.
    
    Returns:
    
    a list of point rois in this layer
  - setTmpROIShape
```
void setTmpROIShape(javax.media.jai.ROIShape tmp)
```
    Sets a current ROI shape to be drawn additionally to all present ones.
    
    Parameters:
    
    tmp -
  - getTmpROIShape
```
javax.media.jai.ROIShape getTmpROIShape()
```
    Gets the temporary ROI shape to be drawn additionally to all present ones.
    
    Returns:
    
    the ROIShape, or null, if none is specified
  - setAllROIShapes
```
void setAllROIShapes(List<javax.media.jai.ROIShape> shapes)
```
    Sets all ROI shapes in this layer. The shape list may contain different ROIShapes.
    
    Parameters:
    
    shapes - a list of ROI shapes.
  - getAllROIShapes
```
List<javax.media.jai.ROIShape> getAllROIShapes()
```
    Get the list of all ROIShapes in this layer.
    
    Returns:
    
    all ROIShapes of this layer
  - setCurrentROIShape
```
void setCurrentROIShape(javax.media.jai.ROIShape shape)
```
    Set the currently selected (active) ROIShape.
    
    Parameters:
    
    shape -
  - getCurrentROIShape
```
javax.media.jai.ROIShape getCurrentROIShape()
```
    Get the currently selected ROIShape.
    
    Returns:
    
    the active ROIShape, which may be of any kind
  - setClickedROIShape
```
void setClickedROIShape(javax.media.jai.ROIShape clickedROIShape)
```
    Set the currently clicked ROIShape.
    
    Parameters:
    
    clickedROIShape - the clicked ROIShape, which may be of any kind
  - getClickedROIShape
```
javax.media.jai.ROIShape getClickedROIShape()
```
    Get the previously clicked ROIShape.
    
    Returns:
    
    the active ROIShape, which may be of any kind
  - setInsidePtWest
```
void setInsidePtWest(boolean isInsidePtWest)
```
    Set a flag whether or not the mouse is in the west boundary point.
    
    Parameters:
    
    isInsidePtWest -
  - isInsidePtWest
```
boolean isInsidePtWest()
```
    Determines whether or not the mouse is inside of the west boundary point.
    
    Returns:
    
    true if inside, false otherwise
  - setInsidePtSouthWest
```
void setInsidePtSouthWest(boolean isInsidePtSouthWest)
```
    Set a flag whether or not the mouse is in the south-west boundary point.
    
    Parameters:
    
    isInsidePtSouthWest -
  - isInsidePtSouthWest
```
boolean isInsidePtSouthWest()
```
    Determines whether or not the mouse is inside of the south-west boundary point.
    
    Returns:
    
    true if inside, false otherwise
  - setInsidePtSouth
```
void setInsidePtSouth(boolean isInsidePtSouth)
```
    Set a flag whether or not the mouse is in the south boundary point.
    
    Parameters:
    
    isInsidePtSouth -
  - isInsidePtSouth
```
boolean isInsidePtSouth()
```
    Determines whether or not the mouse is inside of the south boundary point.
    
    Returns:
    
    true if inside, false otherwise
  - setInsidePtSouthEast
```
void setInsidePtSouthEast(boolean isInsidePtSouthEast)
```
    Set a flag whether or not the mouse is in the south-east boundary point.
    
    Parameters:
    
    isInsidePtSouthEast -
  - isInsidePtSouthEast
```
boolean isInsidePtSouthEast()
```
    Determines whether or not the mouse is inside of the south-east boundary point.
    
    Returns:
    
    true if inside, false otherwise
  - setInsidePtEast
```
void setInsidePtEast(boolean isInsidePtEast)
```
    Set a flag whether or not the mouse is in the east boundary point.
    
    Parameters:
    
    isInsidePtEast -
  - isInsidePtEast
```
boolean isInsidePtEast()
```
    Determines whether or not the mouse is inside of the east boundary point.
    
    Returns:
    
    true if inside, false otherwise
  - setInsidePtNorthEast
```
void setInsidePtNorthEast(boolean isInsidePtNorthEast)
```
    Set a flag whether or not the mouse is in the north-east boundary point.
    
    Parameters:
    
    isInsidePtNorthEast -
  - isInsidePtNorthEast
```
boolean isInsidePtNorthEast()
```
    Determines whether or not the mouse is inside of the north-east boundary point.
    
    Returns:
    
    true if inside, false otherwise
  - setInsidePtNorth
```
void setInsidePtNorth(boolean isInsidePtNorth)
```
    Set a flag whether or not the mouse is in the north boundary point.
    
    Parameters:
    
    isInsidePtNorth -
  - isInsidePtNorth
```
boolean isInsidePtNorth()
```
    Determines whether or not the mouse is inside of the north boundary point.
    
    Returns:
    
    true if inside, false otherwise
  - setInsidePtNorthWest
```
void setInsidePtNorthWest(boolean isInsidePtNorthWest)
```
    Set a flag whether or not the mouse is in the north-west boundary point.
    
    Parameters:
    
    isInsidePtNorthWest -
  - isInsidePtNorthWest
```
boolean isInsidePtNorthWest()
```
    Determines whether or not the mouse is inside of the north-west boundary point.
    
    Returns:
    
    true if inside, false otherwise
  - setInsideRoi
```
void setInsideRoi(boolean isInsideRoi)
```
    Set a flag whether or not the mouse is inside of a drawn shape.
    
    Parameters:
    
    isInsideRoi -
  - isInsideRoi
```
boolean isInsideRoi()
```
    Determines whether or not the mouse is inside of a drawn shape.
    
    Returns:
    
    true if inside, false otherwise
  - update
```
void update()
```
    Advise the IDrawingLayer to repaint all shapes.
  - fireNewProperties
```
void fireNewProperties(javax.media.jai.ROIShape roi)
```
    This method updates the additional information in the ImageInfoPanel according to the given ROIShape.
    
    Parameters:
    
    roi -
  - setROIDragging
```
void setROIDragging(boolean isROIDragging)
```
    Set a flag whether or not a ROI is being dragged by mouse gesture.
    
    Parameters:
    
    isROIDragging -
  - isROIDragging
```
boolean isROIDragging()
```
    Get a flag determining whether or not a ROI is currently being dragged by mouse gesture.
    
    Returns:
    
    true if the roi is currently being dragged, false otherwise
  - setRoiShiftY0
```
void setRoiShiftY0(int roiShiftY0)
```
    Set the y-coordinate of the target point of a translation (shift) without transformation of a ROI.
    
    Parameters:
    
    roiShiftY0 - the coordinate in image pixels
  - getRoiShiftY0
```
int getRoiShiftY0()
```
    Get the y-coordinate of the target point of a translation (shift) without transformation of a ROI.
    
    Returns:
    
    the coordinate in image pixels
  - setRoiShiftX0
```
void setRoiShiftX0(int roiShiftX0)
```
    Set the x-coordinate of the target point of a translation (shift) without transformation of a ROI.
    
    Parameters:
    
    roiShiftX0 - the coordinate in image pixels
  - getRoiShiftX0
```
int getRoiShiftX0()
```
    Get the x-coordinate of the target point of a translation (shift) without transformation of a ROI.
    
    Returns:
    
    the coordinate in image pixels
  - setRoiY0
```
void setRoiY0(int roiY0)
```
    Set the y-coordinate of the origin of a translation (shift) without transformation of a ROI.
    
    Parameters:
    
    roiY0 - the coordinate in image pixels
  - getRoiY0
```
int getRoiY0()
```
    Get the y-coordinate of the target point of a translation (shift) without transformation of a ROI.
    
    Returns:
    
    the coordinate in image pixels
  - setRoiX0
```
void setRoiX0(int roiX0)
```
    Set the x-coordinate of the origin of a translation (shift) without transformation of a ROI.
    
    Parameters:
    
    roiX0 - the coordinate in image pixels
  - getRoiX0
```
int getRoiX0()
```
    Get the x-coordinate of the target point of a translation (shift) without transformation of a ROI.
    
    Returns:
    
    the coordinate in image pixels
  - addAllDefaultListeners
```
void addAllDefaultListeners()
```
    Adds all default listeners.
  - removeAllDefaultListeners
```
void removeAllDefaultListeners()
```
    Removes all default listeners.
  - setCursor
```
void setCursor(Cursor cursor)
```
    Sets a Cursor to this layer.
    
    Parameters:
    
    cursor -
  - removeDefaultCanvasMover
```
void removeDefaultCanvasMover()
```
    Removes the default key layer listener.
  - addDefaultCanvasMover
```
void addDefaultCanvasMover()
```
    (Re-)Adds the default key listener.
  - setID
```
void setID(UUID id)
```
    Sets the unique ID of this drawing layer.
    
    Parameters:
    
    id -
  - getID
```
UUID getID()
```
    Gets the unique ID of this drawing layer.
    
    Returns:
    
    an UUID object
  - setHighlightStroke
```
void setHighlightStroke(BasicStroke highlightStroke)
```
  - getHighlightStroke
```
BasicStroke getHighlightStroke()
```
  - setHighlightColor
```
void setHighlightColor(Color highlightColor)
```
  - getHighlightColor
```
Color getHighlightColor()
```
  - removeRoiShapeForHighlighting
```
void removeRoiShapeForHighlighting()
```
  - getLineROIBoundaryRectangleColor
```
Color getLineROIBoundaryRectangleColor()
```
  - getRoiShapeForHighlighting
```
javax.media.jai.ROIShape getRoiShapeForHighlighting()
```
  - getRoiBoundaryRectangleColor
```
Color getRoiBoundaryRectangleColor()
```
  - getLineROIBoundaryColor
```
Color getLineROIBoundaryColor()
```
  - setDefaultROIStroke
```
void setDefaultROIStroke(BasicStroke defaultROIStroke)
```
  - getDefaultROIStroke
```
BasicStroke getDefaultROIStroke()
```
  - setDefaultLayerColor
```
void setDefaultLayerColor(Color defaultLayerColor)
```
  - getDefaultLayerColor
```
Color getDefaultLayerColor()
```
  - setBoundEditableRectanglesUntransformed
```
void setBoundEditableRectanglesUntransformed(javax.media.jai.ROIShape[] boundEditableRectanglesUntransformed)
```
  - setBoundEditableRectangles
```
void setBoundEditableRectangles(javax.media.jai.ROIShape[] rs)
```
  - removeTmpROIShape
```
void removeTmpROIShape()
```
  - getCursorChanger
```
ROILayerCursorChanger getCursorChanger()
```
  - hasROIs
```
boolean hasROIs()
```
    Determines whether or not the layer contains any ROI shapes.
    
    Returns:
    
    true, if minimum one shape is present, false otherwise

Interface IDrawingLayer

Field Summary

Method Summary

Methods inherited from interface at.mug.iqm.api.gui.IDrawingLayerSupport

Field Detail

DEFAULT_IMAGE_LAYER

ACTIVE_FRONT_LAYER

DRAGGING_LAYER

DEFAULT_LAYER_COLOR_NAME

DEFAULT_LAYER_COLOR

DEFAULT_LAYER_STROKE_NAME

DEFAULT_LAYER_STROKE

HIGHLIGHT_COLOR_NAME

HIGHLIGHT_COLOR

HIGHLIGHT_STROKE_NAME

HIGHLIGHT_STROKE

Method Detail

setName

getName

getZOrder

setZOrder

isLayerVisible

setLayerVisible

setLayerColor

getLayerColor

setSelected

isSelected

getElementCount

isEmpty

setAngleROIs

getAngleROIs

setNumAnglePoints

getNumAnglePoints

setAngleShape

getAngleShape

setCurrentAngleROI

getCurrentAngleROI

setPolygonROIs

getPolygonROIs

setCurrentPolygonROI

getCurrentPolygonROI

setPolygonShape

getPolygonShape

setNumPolyPoints

getNumPolyPoints

setFreehandROIs

getFreehandROIs

setCurrentFreehandROI

getCurrentFreehandROI

setFreehandShape

getFreehandShape

setEllipseROIs

getEllipseROIs

setCurrentEllipseROI

getCurrentEllipseROI

setRectangleROIs

getRectangleROIs

setCurrentRectangleROI

getCurrentRectangleROI

setCurrentLineROI

getCurrentLineROI

setLineROIs

getLineROIs

getCurrentPointROI

setCurrentPointROI

setPointROIs

getPointROIs

setTmpROIShape

getTmpROIShape

setAllROIShapes

getAllROIShapes

setCurrentROIShape

getCurrentROIShape

setClickedROIShape

getClickedROIShape

setInsidePtWest

isInsidePtWest

setInsidePtSouthWest

isInsidePtSouthWest

setInsidePtSouth