Package ij.gui

Class TextRoi

All Implemented Interfaces:
Serializable, Cloneable

public class TextRoi extends Roi
This class is a rectangular ROI containing text.
See Also:
  • Field Details

  • Constructor Details

    • 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:
    • 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 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, String text, Font font, Color color)
      Deprecated.
    • TextRoi

      public TextRoi(int x, int y, ImagePlus imp)
  • Method Details

    • 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:
    • 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 global 'antialiasedText' variable, which is used by the "Fonts" widget.
    • 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)