Class TeXIcon

java.lang.Object
org.scilab.forge.jlatexmath.TeXIcon
All Implemented Interfaces:
Icon
public class TeXIcon extends Object implements Icon
An Icon implementation that will paint the TeXFormula that created it.

This class cannot be instantiated directly. It can be constructed from a TeXFormula using the TeXFormula.createTeXIcon(int,float) method.

Author:
Kurt Vermeulen

  • Field Details

    • defaultSize

      public static float defaultSize

    • magFactor

      public static float magFactor

    • isColored

      public boolean isColored

  • Constructor Details

    • TeXIcon

      protected TeXIcon(Box b, float size)
      Creates a new icon that will paint the given formula box in the given point size.
      Parameters:
      b - the formula box to be painted
      size - the point size

    • TeXIcon

      protected TeXIcon(Box b, float size, boolean trueValues)

  • Method Details

    • setForeground

      public void setForeground(Color fg)

    • getInsets

      public Insets getInsets()
      Get the insets of the TeXIcon.
      Returns:
      the insets

    • setInsets

      public void setInsets(Insets insets, boolean trueValues)
      Set the insets of the TeXIcon.
      Parameters:
      insets - the insets
      trueValues - true to force the true values

    • setInsets

      public void setInsets(Insets insets)
      Set the insets of the TeXIcon.
      Parameters:
      insets - the insets

    • setIconWidth

      public void setIconWidth(int width, int alignment)
      Change the width of the TeXIcon. The new width must be greater than the current width, otherwise the icon will remain unchanged. The formula will be aligned to the left (TeXConstants.ALIGN_LEFT), to the right (TeXConstants.ALIGN_RIGHT) or will be centered in the middle (TeXConstants.ALIGN_CENTER).
      Parameters:
      width - the new width of the TeXIcon
      alignment - a horizontal alignment constant: LEFT, RIGHT or CENTER

    • setIconHeight

      public void setIconHeight(int height, int alignment)
      Change the height of the TeXIcon. The new height must be greater than the current height, otherwise the icon will remain unchanged. The formula will be aligned on top (TeXConstants.TOP), at the bottom (TeXConstants.BOTTOM) or will be centered in the middle (TeXConstants.CENTER).
      Parameters:
      height - the new height of the TeXIcon
      alignment - a vertical alignment constant: TOP, BOTTOM or CENTER

    • getIconHeight

      public int getIconHeight()
      Get the total height of the TeXIcon. This also includes the insets.
      Specified by:
      getIconHeight in interface Icon

    • getIconDepth

      public int getIconDepth()
      Get the total height of the TeXIcon. This also includes the insets.

    • getIconWidth

      public int getIconWidth()
      Get the total width of the TeXIcon. This also includes the insets.
      Specified by:
      getIconWidth in interface Icon

    • getTrueIconHeight

      public float getTrueIconHeight()

    • getTrueIconDepth

      public float getTrueIconDepth()
      Get the total height of the TeXIcon. This also includes the insets.

    • getTrueIconWidth

      public float getTrueIconWidth()
      Get the total width of the TeXIcon. This also includes the insets.

    • getBaseLine

      public float getBaseLine()

    • getBox

      public Box getBox()

    • paintIcon

      public void paintIcon(Component c, Graphics g, int x, int y)
      Paint the TeXFormula that created this icon.
      Specified by:
      paintIcon in interface Icon