TextRoi (ImageJ API)

java.lang.Object
- ij.gui.Roi
- - ij.gui.TextRoi

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Point>
```
public class TextRoi
extends Roi
```
This class is a rectangular ROI containing text.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static int CENTER

static int LEFT

static int RIGHT
- Fields inherited from class ij.gui.Roi
  ANGLE, asp_bk, aspect, cachedMask, center, clipboard, clipHeight, clipWidth, clipX, clipY, COMPOSITE, constrain, CONSTRUCTING, 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

Fields
Modifier and Type	Field	Description
`static int`	`CENTER`
`static int`	`LEFT`
`static int`	`RIGHT`

Constructor Summary

Constructors
Constructor	Description
`TextRoi(double x, double y, double width, double height, String text, Font font)`	Creates a TextRoi using the specified sub-pixel location, size and Font.
`TextRoi(double x, double y, String text)`	Creates a TextRoi using sub-pixel coordinates.
`TextRoi(double x, double y, String text, Font font)`	Creates a TextRoi using the specified sub-pixel location and Font.
`TextRoi(int x, int y, ImagePlus imp)`
`TextRoi(int x, int y, String text)`	Creates a TextRoi.
`TextRoi(int x, int y, String text, Font font)`	Creates a TextRoi using the specified location and Font.
`TextRoi(int x, int y, String text, Font font, Color color)`	Deprecated.
`TextRoi(String text, double x, double y, Font font)`	Use this constructor as a drop-in replacement for ImageProcessor.drawString().

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addChar(char c)`	This method is used by the text tool to add typed characters to displayed text selections.
`void`	`clear(ImageProcessor ip)`
`Object`	`clone()`	Returns a copy of this TextRoi.
`void`	`draw(Graphics g)`	Draws the text on the screen, clipped to the ROI.
`void`	`drawOverlay(Graphics g)`
`void`	`drawPixels(ImageProcessor ip)`	Renders the text on the image.
`double`	`getAngle()`	Overridden by PolygonRoi (angle between first two points), TextRoi (text angle) and Line (line angle).
`boolean`	`getAntialiased()`	Returns the state of the 'antialiased' instance variable.
`Font`	`getCurrentFont()`	Returns the current (instance) font.
`boolean`	`getDrawStringMode()`
`static String`	`getFont()`	Returns the name of the global (default) font.
`static int`	`getGlobalJustification()`	Returns the global (default) justification (LEFT, CENTER or RIGHT).
`int`	`getJustification()`	Returns the value of the 'justification' instance variable (LEFT, CENTER or RIGHT).
`String`	`getMacroCode(String cmd, ImagePlus imp)`	Used by the Recorder for recording the text tool.
`static int`	`getSize()`	Returns the global (default) font size.
`static int`	`getStyle()`	Returns the global (default) font style.
`String`	`getText()`
`protected void`	`handleMouseUp(int screenX, int screenY)`
`static boolean`	`isAntialiased()`	Returns the state of the global 'antialiasedText' variable, which is used by the "Fonts" widget.
`boolean`	`isDrawingTool()`	Returns 'true' if this is an ROI primarily used from drawing (e.g., TextRoi or Arrow).
`void`	`setAngle(double angle)`
`void`	`setAntialiased(boolean antialiased)`	Sets the 'antialiased' instance variable.
`static void`	`setAntialiasedText(boolean antialiased)`	Sets the state of the global 'antialiasedText' variable.
`void`	`setCurrentFont(Font font)`	Set the current (instance) font.
`static void`	`setDefaultAngle(double angle)`	Sets the default angle.
`static void`	`setDefaultFillColor(Color fillColor)`	Sets the default fill (background) color.
`void`	`setDrawStringMode(boolean drawStringMode)`
`static void`	`setFont(String fontName, int fontSize, int fontStyle)`	Sets the global font face, size and style that will be used by TextROIs interactively created using the text tool.
`static void`	`setFont(String fontName, int fontSize, int fontStyle, boolean antialiased)`	Sets the font face, size, style and antialiasing mode that will be used by TextROIs interactively created using the text tool.
`static void`	`setGlobalJustification(int justification)`	Sets the 'justification' instance variable (must be LEFT, CENTER or RIGHT)
`void`	`setJustification(int justification)`	Sets the 'justification' instance variable (must be LEFT, CENTER or RIGHT)

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

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

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

- Field Detail
  - LEFT
```
public static final int LEFT
```
    See Also:
    
    Constant Field Values
  - CENTER
```
public static final int CENTER
```
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TextRoi
```
public TextRoi(int x,
               int y,
               String text)
```
    Creates a TextRoi.
  - TextRoi
```
public TextRoi(String text,
               double x,
               double y,
               Font font)
```
    Use this constructor as a drop-in replacement for ImageProcessor.drawString().
  - TextRoi
```
public TextRoi(double x,
               double y,
               String text)
```
    Creates a TextRoi using sub-pixel coordinates.
  - TextRoi
```
public TextRoi(int x,
               int y,
               String text,
               Font font)
```
    Creates a TextRoi using the specified location and Font.
    
    See Also:
    
    Roi.setStrokeColor(java.awt.Color), Roi.setNonScalable(boolean), ImagePlus.setOverlay(ij.gui.Overlay)
  - TextRoi
```
public TextRoi(double x,
               double y,
               String text,
               Font font)
```
    Creates a TextRoi using the specified sub-pixel location and Font.
  - TextRoi
```
public TextRoi(double x,
               double y,
               double width,
               double height,
               String text,
               Font font)
```
    Creates a TextRoi using the specified sub-pixel location, size and Font.
  - TextRoi
```
public TextRoi(int x,
               int y,
               String text,
               Font font,
               Color color)
```
    Deprecated.
  - TextRoi
```
public TextRoi(int x,
               int y,
               ImagePlus imp)
```
- Method Detail
  - addChar
```
public void addChar(char c)
```
    This method is used by the text tool to add typed characters to displayed text selections.
  - drawPixels
```
public void drawPixels(ImageProcessor ip)
```
    Renders the text on the image.
    
    Overrides:
    
    drawPixels in class Roi
    
    See Also:
    
    ImageProcessor.setColor(java.awt.Color), ImageProcessor.setLineWidth(int)
  - draw
```
public void draw(Graphics g)
```
    Draws the text on the screen, clipped to the ROI.
    
    Overrides:
    
    draw in class Roi
  - drawOverlay
```
public void drawOverlay(Graphics g)
```
    Overrides:
    
    drawOverlay in class Roi
  - getFont
```
public static String getFont()
```
    Returns the name of the global (default) font.
  - getSize
```
public static int getSize()
```
    Returns the global (default) font size.
  - getStyle
```
public static int getStyle()
```
    Returns the global (default) font style.
  - setCurrentFont
```
public void setCurrentFont(Font font)
```
    Set the current (instance) font.
  - getCurrentFont
```
public Font getCurrentFont()
```
    Returns the current (instance) font.
  - isAntialiased
```
public static boolean isAntialiased()
```
    Returns the state of the global 'antialiasedText' variable, which is used by the "Fonts" widget.
  - setAntialiasedText
```
public static void setAntialiasedText(boolean antialiased)
```
    Sets the state of the global 'antialiasedText' variable.
  - setAntialiased
```
public void setAntialiased(boolean antialiased)
```
    Sets the 'antialiased' instance variable.
  - getAntialiased
```
public boolean getAntialiased()
```
    Returns the state of the 'antialiased' instance variable.
  - setGlobalJustification
```
public static void setGlobalJustification(int justification)
```
    Sets the 'justification' instance variable (must be LEFT, CENTER or RIGHT)
  - getGlobalJustification
```
public static int getGlobalJustification()
```
    Returns the global (default) justification (LEFT, CENTER or RIGHT).
  - setJustification
```
public void setJustification(int justification)
```
    Sets the 'justification' instance variable (must be LEFT, CENTER or RIGHT)
  - getJustification
```
public int getJustification()
```
    Returns the value of the 'justification' instance variable (LEFT, CENTER or RIGHT).
  - setFont
```
public static void setFont(String fontName,
                           int fontSize,
                           int fontStyle)
```
    Sets the global font face, size and style that will be used by TextROIs interactively created using the text tool.
  - setFont
```
public static void setFont(String fontName,
                           int fontSize,
                           int fontStyle,
                           boolean antialiased)
```
    Sets the font face, size, style and antialiasing mode that will be used by TextROIs interactively created using the text tool.
  - setDefaultFillColor
```
public static void setDefaultFillColor(Color fillColor)
```
    Sets the default fill (background) color.
  - setDefaultAngle
```
public static void setDefaultAngle(double angle)
```
    Sets the default angle.
  - handleMouseUp
```
protected void handleMouseUp(int screenX,
                             int screenY)
```
    Overrides:
    
    handleMouseUp in class Roi
  - getMacroCode
```
public String getMacroCode(String cmd,
                           ImagePlus imp)
```
    Used by the Recorder for recording the text tool.
  - getText
```
public String getText()
```
  - 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
  - clear
```
public void clear(ImageProcessor ip)
```
  - clone
```
public Object clone()
```
    Returns a copy of this TextRoi.
    
    Overrides:
    
    clone in class Roi
  - getAngle
```
public double getAngle()
```
    Description copied from class: Roi
    
    Overridden by PolygonRoi (angle between first two points), TextRoi (text angle) and Line (line angle).
    
    Overrides:
    
    getAngle in class Roi
  - setAngle
```
public void setAngle(double angle)
```
  - getDrawStringMode
```
public boolean getDrawStringMode()
```
  - setDrawStringMode
```
public void setDrawStringMode(boolean drawStringMode)
```

Class TextRoi

Field Summary

Fields inherited from class ij.gui.Roi

Constructor Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from class java.lang.Object

Methods inherited from class ij.gui.Roi

Field Detail

LEFT

CENTER

RIGHT

Constructor Detail

TextRoi

TextRoi

TextRoi

TextRoi

TextRoi

TextRoi

TextRoi

TextRoi

Method Detail

addChar

drawPixels

draw

drawOverlay

getFont

getSize

getStyle

setCurrentFont

getCurrentFont

isAntialiased

setAntialiasedText

setAntialiased

getAntialiased

setGlobalJustification

getGlobalJustification

setJustification

getJustification

setFont

setFont

setDefaultFillColor

setDefaultAngle

handleMouseUp

getMacroCode

getText

isDrawingTool

clear

clone

getAngle

setAngle

getDrawStringMode

setDrawStringMode