ij.gui
Class TextRoi

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TextRoi
extends Roi

This class is a rectangular ROI containing text.

See Also:

Serialized Form

Field Summary

Fields inherited from class ij.gui.Roi

ANGLE, asp_bk, aspect, cachedMask, center, clipboard, clipHeight, clipWidth, clipX, clipY, COMPOSITE, constrain, CONSTRUCTING, defaultFillColor, fillColor, FREELINE, FREEROI, HANDLE_SIZE, handleColor, ic, 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

TextRoi(int x, int y, ImagePlus imp)

TextRoi(int x, int y, java.lang.String text)
Creates a new TextRoi.

TextRoi(int x, int y, java.lang.String text, java.awt.Font font)
Creates a new TextRoi with the specified location and Font.

TextRoi(int x, int y, java.lang.String text, java.awt.Font font, java.awt.Color color)
Deprecated.

Method Summary

void	addChar(char c) Adds the specified character to the end of the text string.
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	drawPixels(ImageProcessor ip) Renders the text on the image.
java.awt.Font	getCurrentFont() Returns the current (instance) font.
static java.lang.String	getFont() Returns the name of the global font.
java.lang.String	getMacroCode(ImageProcessor ip)
static int	getSize() Returns the global font size.
static int	getStyle() Returns the global font style.
java.lang.String	getText()
protected void	handleMouseUp(int screenX, int screenY)
static boolean	isAntialiased()
boolean	isDrawingTool() Returns 'true' if this is an ROI primarily used from drawing (e.g., Rounded Rectangle, TextRoi or Arrow).
static void	recordSetFont()
void	setCurrentFont(java.awt.Font font) Set the current (instance) font.
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.

Methods inherited from class ij.gui.Roi

abortPaste, clipRectMargin, contains, copyAttributes, drawOverlay, drawPixels, endPaste, equals, getAngle, getBoundingRect, getBounds, getColor, getConvexHull, getCurrentPasteMode, getDefaultFillColor, getFeretsDiameter, getFeretValues, getFillColor, getFloatPolygon, getImageID, getLength, getMask, getName, getPasteMode, getPolygon, getRoundRectArcSize, getScaledStroke, getState, getStroke, getStrokeColor, getStrokeWidth, getType, getTypeAsString, grow, handleMouseDown, handleMouseDrag, isArea, isHandle, isLine, isVisible, mouseDownInHandle, moveHandle, nudge, nudgeCorner, setColor, setDefaultFillColor, setFillColor, setImage, setInstanceColor, setLineWidth, setLocation, setName, setNonScalable, setPasteMode, setRoundRectArcSize, setStroke, setStrokeColor, setStrokeWidth, showStatus, startPaste, toString, update, updateClipRect, updateWideLine

Methods inherited from class java.lang.Object

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

Constructor Detail

TextRoi

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

Creates a new TextRoi.

TextRoi

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

Creates a new TextRoi with the specified location and Font.

See Also:

Roi.setStrokeColor(java.awt.Color), Roi.setNonScalable(boolean), ImagePlus.setOverlay(ij.gui.Overlay)

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)

Adds the specified character to the end of the text string.

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

getFont

public static java.lang.String getFont()

Returns the name of the global font.

getSize

public static int getSize()

Returns the global font size.

getStyle

public static int getStyle()

Returns the global 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()

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.

handleMouseUp

protected void handleMouseUp(int screenX,
                             int screenY)

Overrides:

handleMouseUp in class Roi

getMacroCode

public java.lang.String getMacroCode(ImageProcessor ip)

getText

public java.lang.String getText()

recordSetFont

public static void recordSetFont()

isDrawingTool

public boolean isDrawingTool()

Description copied from class: Roi

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

Overrides:

isDrawingTool in class Roi

clone

public java.lang.Object clone()

Returns a copy of this TextRoi.

Overrides:

clone in class Roi