Arrow (ImageJ API)

java.lang.Object
- ij.gui.Roi
- - ij.gui.Line
  - - ij.gui.Arrow

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Point>
```
public class Arrow
extends Line
```
This is an Roi subclass for creating and displaying arrows.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class ij.gui.Line
  Line.PointIterator

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`BAR`
`static String`	`DOUBLE_HEADED_KEY`
`static int`	`FILLED`
`static int`	`HEADLESS`
`static int`	`NOTCHED`
`static int`	`OPEN`
`static String`	`OUTLINE_KEY`
`static String`	`SIZE_KEY`
`static String`	`STYLE_KEY`
`static String[]`	`styles`
`static String`	`WIDTH_KEY`

Fields inherited from class ij.gui.Line
startxd, startyd, x1, x1d, x1R, x2, x2d, x2R, y1, y1d, y1R, y2, y2d, y2R

Fields inherited from class ij.gui.Roi
ANGLE, asp_bk, aspect, cachedMask, center, clipboard, clipHeight, clipWidth, clipX, clipY, COMPOSITE, constrain, CONSTRUCTING, defaultFillColor, fillColor, flattenScale, FREELINE, FREEROI, HANDLE_SIZE, handleColor, ic, ignoreClipRect, imp, instanceColor, LINE, lineWidth, mag, MOVING, MOVING_HANDLE, nonScalable, NORMAL, NOT_PASTING, oldHeight, oldWidth, oldX, oldY, onePixelWide, OVAL, overlay, pasteMode, POINT, POLYGON, POLYLINE, previousRoi, RECTANGLE, RESIZING, ROIColor, stroke, strokeColor, TRACED_ROI, type, updateFullWindow, wideLine, xMax, yMax

Constructor Summary

Constructors
Constructor Description

Arrow(double ox1, double oy1, double ox2, double oy2)

Arrow(int sx, int sy, ImagePlus imp)

Constructors
Constructor	Description
`Arrow(double ox1, double oy1, double ox2, double oy2)`
`Arrow(int sx, int sy, ImagePlus imp)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected int`	`clipRectMargin()`
`boolean`	`contains(int x, int y)`
`void`	`draw(Graphics g)`	Draws this arrow on the image.
`void`	`drawPixels(ImageProcessor ip)`	Draws the selection outline on the specified ImageProcessor.
`Rectangle`	`getBounds()`	Return the bounding rectangle of this arrow.
`static boolean`	`getDefaultDoubleHeaded()`
`static double`	`getDefaultHeadSize()`
`static boolean`	`getDefaultOutline()`
`static int`	`getDefaultStyle()`
`static double`	`getDefaultWidth()`
`boolean`	`getDoubleHeaded()`
`double`	`getHeadSize()`
`ImageProcessor`	`getMask()`	Always returns null for rectangular Roi's
`boolean`	`getOutline()`
`int`	`getStyle()`
`protected void`	`handleMouseDown(int sx, int sy)`
`boolean`	`isDrawingTool()`	Returns 'true' if this is an ROI primarily used from drawing (e.g., TextRoi or Arrow).
`static void`	`setDefaultDoubleHeaded(boolean b)`
`static void`	`setDefaultHeadSize(double size)`
`static void`	`setDefaultOutline(boolean b)`
`static void`	`setDefaultStyle(int style)`
`static void`	`setDefaultWidth(double width)`
`void`	`setDoubleHeaded(boolean b)`
`void`	`setHeadSize(double headSize)`
`void`	`setOutline(boolean b)`
`void`	`setStyle(int style)`
`void`	`setStyle(String style)`

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from class ij.gui.Line
drawLine, getAngle, getDrawOffset, getFloatPoints, getFloatPolygon, getLength, getPixels, getPoints, getPolygon, getRawLength, getRotationCenter, getWidth, grow, handleMouseUp, isHandle, iterator, mouseDownInHandle, mouseMoved, moveHandle, nudgeCorner, setDrawOffset, setLocation, setStrokeWidth, setWidth, size, subPixelResolution

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class ij.gui.Roi
abortPaste, addRoiListener, clone, copyAttributes, drawOverlay, drawPixels, enableSubPixelResolution, endPaste, equals, getAngle, getBoundingRect, getColor, getContainedFloatPoints, getContainedPoints, getContourCentroid, getConvexHull, getCornerDiameter, getCPosition, getCurrentPasteMode, getDebugInfo, getDefaultFillColor, getFeretsDiameter, getFeretValues, getFillColor, getFloatAngle, getFloatBounds, getFloatHeight, getFloatWidth, getHashCode, getImage, getImageID, getInterpolatedPolygon, getInterpolatedPolygon, getInterpolatedPolygon, getMagnification, getName, getPasteMode, getPosition, getProperties, getProperty, getPropertyCount, getPrototypeOverlay, getRoundRectArcSize, getScaledStroke, getState, getStatistics, getStroke, getStrokeColor, getStrokeWidth, getTPosition, getType, getTypeAsString, getXBase, getYBase, getZPosition, handleMouseDrag, hasHyperStackPosition, isActiveOverlayRoi, isArea, isCursor, isLine, isVisible, lineCircleIntersection, mouseDragged, mouseReleased, notifyListeners, nudge, removeRoiListener, screenX, screenXD, screenY, screenYD, setColor, setCornerDiameter, setDefaultFillColor, setFillColor, setFlattenScale, setIgnoreClipRect, setImage, setInstanceColor, setIsCursor, setLineWidth, setLocation, setName, setNonScalable, setPasteMode, setPosition, setPosition, setPosition, setProperties, setProperty, setPrototypeOverlay, setRotationCenter, setRoundRectArcSize, setStroke, setStrokeColor, setStrokeWidth, showStatus, startPaste, temporarilyHide, toFloat, toInt, toInt, toIntR, toString, update, updateClipRect, updateWideLine

Field Detail

STYLE_KEY
```
public static final String STYLE_KEY
```
See Also:

Constant Field Values

WIDTH_KEY
```
public static final String WIDTH_KEY
```
See Also:

Constant Field Values

SIZE_KEY
```
public static final String SIZE_KEY
```
See Also:

Constant Field Values

DOUBLE_HEADED_KEY

public static final String DOUBLE_HEADED_KEY

See Also:: Constant Field Values

OUTLINE_KEY
```
public static final String OUTLINE_KEY
```
See Also:

Constant Field Values

FILLED
```
public static final int FILLED
```
See Also:

Constant Field Values

NOTCHED
```
public static final int NOTCHED
```
See Also:

Constant Field Values

OPEN
```
public static final int OPEN
```
See Also:

Constant Field Values

HEADLESS
```
public static final int HEADLESS
```
See Also:

Constant Field Values

BAR
```
public static final int BAR
```
See Also:

Constant Field Values

styles
```
public static final String[] styles
```

Constructor Detail

Arrow

public Arrow(double ox1,
             double oy1,
             double ox2,
             double oy2)

Arrow

public Arrow(int sx,
             int sy,
             ImagePlus imp)

Method Detail

draw
```
public void draw(Graphics g)
```
Draws this arrow on the image.

Overrides:

draw in class Line

getMask
```
public ImageProcessor getMask()
```
Description copied from class: Roi

Always returns null for rectangular Roi's

Overrides:

getMask in class Roi

drawPixels
```
public void drawPixels(ImageProcessor ip)
```
Description copied from class: Roi

Draws the selection outline on the specified ImageProcessor.

Overrides:

drawPixels in class Line

See Also:

ImageProcessor.setColor(java.awt.Color), ImageProcessor.setLineWidth(int)

contains

public boolean contains(int x,
                        int y)

Overrides:: contains in class Line

getBounds
```
public Rectangle getBounds()
```
Return the bounding rectangle of this arrow.

Overrides:

getBounds in class Line

handleMouseDown

protected void handleMouseDown(int sx,
                               int sy)

Overrides:: handleMouseDown in class Line

clipRectMargin
```
protected int clipRectMargin()
```
Overrides:

clipRectMargin in class Line

isDrawingTool
```
public boolean isDrawingTool()
```
Description copied from class: Roi

Returns 'true' if this is an ROI primarily used from drawing (e.g., TextRoi or Arrow).

Overrides:

isDrawingTool in class Roi

setDefaultWidth

public static void setDefaultWidth(double width)

getDefaultWidth

public static double getDefaultWidth()

setStyle
```
public void setStyle(int style)
```

setStyle

public void setStyle(String style)

getStyle
```
public int getStyle()
```

setDefaultStyle

public static void setDefaultStyle(int style)

getDefaultStyle
```
public static int getDefaultStyle()
```

setHeadSize

public void setHeadSize(double headSize)

getHeadSize
```
public double getHeadSize()
```

setDefaultHeadSize

public static void setDefaultHeadSize(double size)

getDefaultHeadSize

public static double getDefaultHeadSize()

setDoubleHeaded

public void setDoubleHeaded(boolean b)

getDoubleHeaded
```
public boolean getDoubleHeaded()
```

setDefaultDoubleHeaded

public static void setDefaultDoubleHeaded(boolean b)

getDefaultDoubleHeaded

public static boolean getDefaultDoubleHeaded()

setOutline
```
public void setOutline(boolean b)
```

getOutline
```
public boolean getOutline()
```

setDefaultOutline

public static void setDefaultOutline(boolean b)

getDefaultOutline

public static boolean getDefaultOutline()

Class Arrow

Nested Class Summary

Nested classes/interfaces inherited from class ij.gui.Line

Field Summary

Fields inherited from class ij.gui.Line

Fields inherited from class ij.gui.Roi

Constructor Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from class ij.gui.Line

Methods inherited from class java.lang.Object

Methods inherited from class ij.gui.Roi

Field Detail

STYLE_KEY

WIDTH_KEY

SIZE_KEY

DOUBLE_HEADED_KEY

OUTLINE_KEY

FILLED

NOTCHED

OPEN

HEADLESS

BAR

styles

Constructor Detail

Arrow

Arrow

Method Detail

draw

getMask

drawPixels

contains

getBounds

handleMouseDown

clipRectMargin

isDrawingTool

setDefaultWidth

getDefaultWidth

setStyle

setStyle

getStyle

setDefaultStyle

getDefaultStyle

setHeadSize

getHeadSize

setDefaultHeadSize

getDefaultHeadSize

setDoubleHeaded

getDoubleHeaded

setDefaultDoubleHeaded

getDefaultDoubleHeaded

setOutline

getOutline

setDefaultOutline

getDefaultOutline