SyntaxStyle.java

/*
 * SyntaxStyle.java - A simple text style class
 * Copyright (C) 1999 Slava Pestov
 *
 * You may use and modify this package for any purpose. Redistribution is
 * permitted, in both source and binary form, provided that this notice
 * remains intact in all source distributions of this package.
 */

package processing.app.syntax;

import java.awt.*;
import java.awt.font.TextAttribute;
import java.util.Hashtable;
import java.util.Map;

import javax.swing.JComponent;


/**
 * A simple text style class. It can specify the color, italic flag,
 * and bold flag of a run of text.
 * @author Slava Pestov
 * @version $Id: SyntaxStyle.java 4824 2008-10-11 23:41:40Z fry $
 */
public class SyntaxStyle
{
  /**
   * Creates a new SyntaxStyle.
   * @param color The text color
   * @param italic True if the text should be italics
   * @param bold True if the text should be bold
   */
  public SyntaxStyle(Color color, boolean italic, boolean bold, boolean underlined)
  {
    this.color = color;
    this.italic = italic;
    this.bold = bold;
    this.underlined = underlined;
  }

  /**
   * Returns the color specified in this style.
   */
  public Color getColor()
  {
    return color;
  }

  /**
   * Returns true if no font styles are enabled.
   */
  public boolean isPlain()
  {
    return !(bold || italic || underlined);
  }

  /**
   * Returns true if italics is enabled for this style.
   */
  public boolean isItalic()
  {
    return italic;
  }

  /**
   * Returns true if boldface is enabled for this style.
   */
  public boolean isBold()
  {
    return bold;
  }

  /**
   * @return true if underline is enabled for this style.
   */
  public boolean isUnderlined() {
    return underlined;
  }
  
  /**
   * Returns the specified font, but with the style's bold, underline and
   * italic flags applied.
   */
  public Font getStyledFont(Font font)
  {
    if(font == null)
      throw new NullPointerException("font param must not"
                                     + " be null");
    if(font.equals(lastFont))
      return lastStyledFont;
    lastFont = font;
    
    lastStyledFont = new Font(font.getFamily(),
                              (bold ? Font.BOLD : 0)
                              | (italic ? Font.ITALIC : 0),
                              font.getSize());
    if (underlined) {
      Map<TextAttribute, Object> attr = new Hashtable<TextAttribute, Object>();
      attr.put(TextAttribute.UNDERLINE, TextAttribute.UNDERLINE_ON);
      lastStyledFont = lastStyledFont.deriveFont(attr);
    }
    return lastStyledFont;
  }

  /**
   * Returns the font metrics for the styled font.
   */
  public FontMetrics getFontMetrics(Font font, JComponent comp)
  {
    if(font == null)
      throw new NullPointerException("font param must not"
                                     + " be null");
    if(font.equals(lastFont) && fontMetrics != null)
      return fontMetrics;
    lastFont = font;
    lastStyledFont = new Font(font.getFamily(),
                              (bold ? Font.BOLD : 0)
                              | (italic ? Font.ITALIC : 0),
                              font.getSize());
    if (underlined) {
      Map<TextAttribute, Object> attr = new Hashtable<TextAttribute, Object>();
      attr.put(TextAttribute.UNDERLINE, TextAttribute.UNDERLINE_ON);
      lastStyledFont = lastStyledFont.deriveFont(attr);
    }
    //fontMetrics = Toolkit.getDefaultToolkit().getFontMetrics(lastStyledFont);
    fontMetrics = comp.getFontMetrics(lastStyledFont);
    return fontMetrics;
  }

  /**
   * Sets the foreground color and font of the specified graphics
   * context to that specified in this style.
   * @param gfx The graphics context
   * @param font The font to add the styles to
   */
  public void setGraphicsFlags(Graphics gfx, Font font)
  {
    Font _font = getStyledFont(font);
    gfx.setFont(_font);
    gfx.setColor(color);
  }

  /**
   * Returns a string representation of this object.
   */
  public String toString()
  {
    return getClass().getName() + "[color=" + color +
      (italic ? ",italic" : "") +
      (bold ? ",bold" : "") + 
      (underlined ? ",underlined" : "") +
      "]";
  }

  // private members
  private Color color;
  private boolean italic;
  private boolean bold;
  private boolean underlined;
  private Font lastFont;
  private Font lastStyledFont;
  private FontMetrics fontMetrics;
}