ij.gui

Class TextRoi

java.lang.Object

ij.gui.Roi

ij.gui.TextRoi

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.awt.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 and Description
static int	CENTER
static int	LEFT
static int	RIGHT

Fields inherited from class ij.gui.Roi

ANGLE, COMPOSITE, CONSTRUCTING, FREELINE, FREEROI, HANDLE_SIZE, LINE, MOVING, MOVING_HANDLE, NORMAL, NOT_PASTING, onePixelWide, OVAL, POINT, POLYGON, POLYLINE, previousRoi, RECTANGLE, RESIZING, TRACED_ROI

Constructor Summary

Constructors

Constructor and Description
TextRoi(double x, double y, double width, double height, java.lang.String text, java.awt.Font font) Creates a TextRoi using the specified location, size and Font.
TextRoi(double x, double y, java.lang.String text) Creates a TextRoi using sub-pixel coordinates.
TextRoi(double x, double y, java.lang.String text, java.awt.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, java.lang.String text) Creates a TextRoi.
TextRoi(int x, int y, java.lang.String text, java.awt.Font font) Creates a TextRoi using the specified location and Font.
TextRoi(int x, int y, java.lang.String text, java.awt.Font font, java.awt.Color color) Deprecated.
TextRoi(java.lang.String text, double x, double y, java.awt.Font font) Use this constructor as a drop-in replacement for ImageProcessor.drawString().

Method Summary

Modifier and Type	Method and 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)
java.lang.Object	clone() Returns a copy of this TextRoi.
void	draw(java.awt.Graphics g) Draws the text on the screen, clipped to the ROI.
void	drawOverlay(java.awt.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.
java.awt.Font	getCurrentFont() Returns the current (instance) font.
boolean	getDrawStringMode()
static java.lang.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).
java.lang.String	getMacroCode(java.lang.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.
java.lang.String	getText()
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(java.awt.Font font) Set the current (instance) font.
static void	setDefaultAngle(double angle) Sets the default angle.
static void	setDefaultFillColor(java.awt.Color fillColor) Sets the default fill (background) color.
void	setDrawStringMode(boolean drawStringMode)
static void	setFont(java.lang.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(java.lang.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 class ij.gui.Roi

abortPaste, addRoiListener, 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, getLength, getMask, getName, getPasteMode, getPolygon, getPosition, getProperties, getProperty, getPropertyCount, getPrototypeOverlay, getRotationCenter, getRoundRectArcSize, getState, getStatistics, getStroke, getStrokeColor, getStrokeWidth, getTPosition, getType, getTypeAsString, getXBase, getYBase, getZPosition, hasHyperStackPosition, isActiveOverlayRoi, isArea, isCursor, isHandle, isLine, isVisible, iterator, lineCircleIntersection, mouseDragged, mouseMoved, mouseReleased, notifyListeners, nudge, nudgeCorner, removeRoiListener, 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, startPaste, subPixelResolution, temporarilyHide, toFloat, toInt, toInt, toIntR, toString, update, updateWideLine

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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,
               java.lang.String text)

Creates a TextRoi.

TextRoi

public TextRoi(java.lang.String text,
               double x,
               double y,
               java.awt.Font font)

Use this constructor as a drop-in replacement for ImageProcessor.drawString().

TextRoi

public TextRoi(double x,
               double y,
               java.lang.String text)

Creates a TextRoi using sub-pixel coordinates.

TextRoi

public TextRoi(int x,
               int y,
               java.lang.String text,
               java.awt.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,
               java.lang.String text,
               java.awt.Font font)

Creates a TextRoi using the specified sub-pixel location and Font.

TextRoi

public TextRoi(double x,
               double y,
               double width,
               double height,
               java.lang.String text,
               java.awt.Font font)

Creates a TextRoi using the specified location, size and Font. public TextRoi(int x, int y, int width, int height, String text, Font font) { super(x, y, width, height); init(text, font); } /** Creates a TextRoi using the specified sub-pixel location, size and Font.

TextRoi

public TextRoi(int x,
               int y,
               java.lang.String text,
               java.awt.Font font,
               java.awt.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(java.awt.Graphics g)

Draws the text on the screen, clipped to the ROI.

Overrides:

draw in class Roi

drawOverlay

public void drawOverlay(java.awt.Graphics g)

Overrides:

drawOverlay in class Roi

getFont

public static java.lang.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(java.awt.Font font)

Set the current (instance) font.

getCurrentFont

public java.awt.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(java.lang.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(java.lang.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(java.awt.Color fillColor)

Sets the default fill (background) color.

setDefaultAngle

public static void setDefaultAngle(double angle)

Sets the default angle.

getMacroCode

public java.lang.String getMacroCode(java.lang.String cmd,
                                     ImagePlus imp)

Used by the Recorder for recording the text tool.

getText

public java.lang.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 java.lang.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)