/*
 *  $Source: /cvsroot/open/projects/WebARTS/ca/bc/webarts/widgets/ColouredLabel.java,v $
 *  $Name:  $
 *  Current File Status:   $Revision: 1231 $
 *  $Date: 2018-03-02 22:27:48 -0800 (Fri, 02 Mar 2018) $
 *  $Locker:  $
 *  Copyright (C) 2001 WebARTS Design, North Vancouver Canada
*/
/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
package ca.bc.webarts.widgets;

import javax.swing.JLabel;
import java.awt.Color;
import java.awt.Font;

// These are needed ONLY for the Demo in the main method
import java.awt.Color;
import java.awt.GraphicsDevice;
import java.awt.GraphicsEnvironment;
import java.awt.BorderLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ComponentAdapter;
import java.awt.event.ComponentEvent;
import java.awt.event.KeyEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JButton;
import javax.swing.SwingUtilities;

/**
 *  A class to extend JLabel with some added easily settable colour and Font
 *  settings.<P>
 *
 *  It allows easily setting the text colour and the background colour of the
 *  label. <P>
 *
 *  Now you don't have to override paint.
 *
 *@author     Tom Gutwin
 *@created    April 2, 2002
 */
public class ColouredLabel extends JLabel
{
  private static final String DEFAULT_FONT_FACE = "Arial, Helvetica";
  /**
   *  Description of the Field
   */
  protected Color textColour_ = Color.white;
  /**
   *  Description of the Field
   */
  protected Color backColour_ = Color.black;
  /**
   *  Description of the Field
   */
  protected String labelText_ = "";
  /**
   *  Description of the Field
   */
  protected String fontName_ = "default";
  /**
   *  Description of the Field
   */
  protected String[] fontSizes_ =
  {"+8", "+7", "+6", "+5", "+4", "+3", "+2", "+1" , "+0", "-1", "-2", "-3", "-4", "-5", "-6", "-7", "-8"};
  /**
   *  Description of the Field
   */
  protected String fontSize_ = "-1";
  /**
   *  Description of the Field
   */
  protected int fontMidpoint_ = 11;
  /**
   *  Description of the Field
   */
  protected String boldOn_ = "";
  /**
   *  Description of the Field
   */
  protected String boldOff_ = "";
  /**
   *  Description of the Field
   */
  protected String italicOn_ = "";
  /**
   *  Description of the Field
   */
  protected String italicOff_ = "";
  /**
   *  Flags if this text gets wrapped.
   */
  protected boolean wrapText_ = true;
  /**
   *  how many characters in the text before a wrap.
   */
  protected short wrapCharWidth_ = 60;

  ca.bc.webarts.tools.Log log_ = ca.bc.webarts.tools.Log.createLog( ca.bc.webarts.tools.Log.DEBUG );

  /**
   *  Basic constructor to set up the Label with the specified colour.
   *
   *@param  labelText  the text in the label
   */
  public ColouredLabel( String labelText )
  {
    log_ = ca.bc.webarts.tools.Log.createLog( ca.bc.webarts.tools.Log.DEBUG );
    log_.startMethod();
    labelText_ = labelText;
    setText( labelText );
    log_.endMethod();
  }

  /**
   *  Constructor to set up the Label with the specified colour.
   *
   *@param  textColour  is the Color to use in the text in the label
   *@param  labelText   the text in the label
   */
  public ColouredLabel( Color textColour, String labelText )
  {
    log_ = ca.bc.webarts.tools.Log.createLog( ca.bc.webarts.tools.Log.DEBUG );
    log_.startMethod();
    labelText_ = labelText;
    textColour_ = textColour;
    setText( labelText );
    log_.endMethod();
  }

  /**
   *  Constructor to set up the Label with the specified colours.
   *
   *@param  backColour  is the Color to use in the back of the label
   *@param  textColour  is the Color to use in the text in the label
   *@param  labelText   the text in the label
   */
  public ColouredLabel( Color backColour, Color textColour, String labelText )
  {
    log_ = ca.bc.webarts.tools.Log.createLog( ca.bc.webarts.tools.Log.DEBUG );
    log_.startMethod();
    labelText_ = labelText;
    textColour_ = textColour;
    backColour_ = backColour;
    setText( labelText );
    log_.endMethod();
  }

  /**
   *  Constructor to set up the Label with the specified colours.
   *
   *@param  backColour  is the Color to use in the back of the label
   *@param  textColour  is the Color to use in the text in the label
   *@param  labelText   the text in the label
   */
  public ColouredLabel( Color backColour, Color textColour, String labelText, boolean wrapText )
  {
    log_ = ca.bc.webarts.tools.Log.createLog( ca.bc.webarts.tools.Log.DEBUG );
    log_.startMethod();
    labelText_ = labelText;
    textColour_ = textColour;
    backColour_ = backColour;
    wrapText_ = wrapText;
    setText( labelText );
    log_.endMethod();
  }

  /**
   *  Constructor to set up the Label with the specified colours.
   *
   *@param  backColour  is the Color to use in the back of the label
   *@param  textColour  is the Color to use in the text in the label
   *@param  newFont     is the Font to use in the text in the label
   *@param  labelText   the text in the label
   */
  public ColouredLabel( Color backColour, Color textColour, Font newFont, String labelText )
  {
    log_ = ca.bc.webarts.tools.Log.createLog( ca.bc.webarts.tools.Log.DEBUG );
    log_.startMethod();
    labelText_ = labelText;
    textColour_ = textColour;
    backColour_ = backColour;
    setFont( newFont );
    setText( labelText );
    log_.endMethod();
  }

  /**
   *  Constructor to set up the Label with the specified colours.
   *
   *@param  backColour  is the Color to use in the back of the label
   *@param  textColour  is the Color to use in the text in the label
   *@param  newFont     is the Font to use in the text in the label
   *@param  labelText   the text in the label
   */
  public ColouredLabel( Color backColour, Color textColour, Font newFont, String labelText, boolean wrapText )
  {
    log_ = ca.bc.webarts.tools.Log.createLog( ca.bc.webarts.tools.Log.DEBUG );
    log_.startMethod();
    labelText_ = labelText;
    textColour_ = textColour;
    backColour_ = backColour;
    wrapText_ = wrapText;
    setFont( newFont );
    setText( labelText );
    log_.endMethod();
  }

  /**
   *  Set the number of chars before it fits in a wrap by inserting a <code><br /></code>.
   *
   *@param  numChars  the number of chars before it fits in a wrap
   */
  public void setWrapCharWidth( short numChars )
  {
    log_.startMethod();
    wrapCharWidth_ = numChars;
    log_.endMethod();
  }

  /**
   *  Forces the display of the label text to the specified wrapping.
   *
   *@param  wrapText  flags if the text in the label will wrap or not
   */
  public void setWrapText( boolean wrapText )
  {
    log_.startMethod();
    wrapText_ = wrapText;
    log_.endMethod();
  }

  private String addWrap( String text, short wrapChars )
  {
    log_.startMethod();
    for ( short i =0; i < text.length(); i += wrapChars )
    {
      text = text.substring(0, i ) + "<br />" + text.substring( i );
    }

    log_.endMethod();
    return text;
  }

  /**
   *  Overrides the JLabel setText to add the extra stuff to get the extra
   *  colours and font stuff.
   *
   *@param  newText  the text to go in the label.
   */
  public void setText( String newText )
  {
    log_.startMethod();
    if ( wrapText_ )
    {
      if ( newText.length() > wrapCharWidth_ )
      {
        newText = addWrap( newText, wrapCharWidth_ );
        newText = Util.tokenReplace( newText, " ", "&nbsp;" );
      }
    }
    super.setText( "<html><body bgcolor=\"" + getBackColourHtmlString() + "\" text=\"" + getTextColourHtmlString() + "\"><Font face=\"" + fontName_ + ", " + DEFAULT_FONT_FACE + "\" size=\"" + fontSize_ + "\">" + boldOn_ + italicOn_ + newText + italicOff_ + boldOff_ + "</font></body></html>" );
    /*
         *  super.setText("<Font face=\"" +
         *  fontName_ + ", " + DEFAULT_FONT_FACE + "\" size=\"" +
         *  fontSize_ + "color=\""+getTextColourHtmlString()+"\">" +
         *  boldOn_ + italicOn_ + newText + italicOff_ + boldOff_ +
         *  "</font>");
    */
    labelText_ = newText;
    log_.endMethod();
  }

  /**
   *  Allows setting of the Font to use in this label. It parses the Face,
   *  Italic and Bold attributes.
   *
   *@param  newFont  the new font to use for this ColouredLabel.
   */
  public void setFont( Font newFont )
  {
    log_.startMethod();
    super.setFont( newFont );
    fontName_ = newFont.getName();
    if ( newFont.isBold() )
    {
      boldOn_ = "<b>";
      boldOff_ = "</b>";
    }
    else
    {
      boldOn_ = "";
      boldOff_ = "";
    }
    if ( newFont.isItalic() )
    {
      italicOn_ = "<i>";
      italicOff_ = "</i>";
    }
    else
    {
      italicOn_ = "";
      italicOff_ = "";
    }
    if ( fontSizes_ != null )
    {
      // need to check... super calls this before init

      int fontSizeLookup = fontMidpoint_ - newFont.getSize() + fontSizes_.length / 2;
      fontSize_ = fontSizes_[fontSizeLookup];
      coloursChanged();
    }
    log_.endMethod();
  }

  /**
   *  A convienience method to directly set the Font using the face name
   *  instead of sending a Font object.
   *
   *@param  fontName  The new fontName value
   */
  public void setFontName( String fontName )
  {
    log_.startMethod();
    fontName_ = fontName;
    coloursChanged();
    log_.endMethod();
  }

  /**
   *  Sets the current Text Colour being used in this label.
   *
   *@param  textColour  the current Text Colour to use in this label.
   */
  public void setTextColour( Color textColour )
  {
    log_.startMethod();
    textColour_ = textColour;
    coloursChanged();
    log_.endMethod();
  }

  /**
   *  Sets the current background Text Colour being used in this label.
   *
   *@param  backColour  the current background Colour to use in this label.
   */
  public void setBackColour( Color backColour )
  {
    log_.startMethod();
    backColour_ = backColour;
    coloursChanged();
    log_.endMethod();
  }

  /**
   *  Get method for the current Text Colour being used in this label.
   *
   *@return    the current Text Colour being used in this label.
   */
  public Color getTextColour()
  {
    return textColour_;
  }

  /**
   *  Get method for the current Background Colour being used in this label.
   *
   *@return    the current Background Colour being used in this label.
   */
  public Color getBackColour()
  {
    return backColour_;
  }

  /**
   *  Get the HTML string representing the Current Text Colour.
   *
   *@return    The textColourHtmlString value
   */
  private String getTextColourHtmlString()
  {
    log_.startMethod();
    log_.endMethod();
    return getTextColourHtmlString( textColour_ );
  }

  /**
   *  Get the HTML string representing the Current Background Colour.
   *
   *@return    The backColourHtmlString value
   */
  private String getBackColourHtmlString()
  {
     return getTextColourHtmlString( backColour_ );
  }

  /**
   *  Get the HTML string representing the specified Color.
   *
   *@param  c  is the Color to retrieve the html string for.
   *@return    The textColourHtmlString value
   */
  public String getTextColourHtmlString( Color c )
  {
    log_.startMethod();
    String r = "FF";
    String g = "FF";
    String b = "FF";

    if ( c != null )
    {
      r = Integer.toHexString( c.getRed() );
      g = Integer.toHexString( c.getGreen() );
      b = Integer.toHexString( c.getBlue() );
    }
    String retVal = "#" + r + g + b;
    log_.endMethod();
    return retVal;
  }

  /**
   *  Refreshes the text string with some new colour values.
   */
  private void coloursChanged()
  {
    log_.startMethod();
    setText( labelText_ );
    log_.endMethod();
  }

  public static void main( String[] args )
  {
    JFrame f = new JFrame( "ColouredLabel Demo Frame" );
    JPanel p = new JPanel();
    p.setLayout( new BorderLayout() );
    f.getContentPane().setLayout( new BorderLayout() );
    // f.setTitle("PopUpButton TEST Window.");

    ColouredLabel l =    // Color backColour,
    // Color textColour,
    // String labelText,
    // boolean wrapText
    new ColouredLabel( Color.DARK_GRAY, Color.RED, "Demo Coloured Label", true );
    p.add( l, BorderLayout.CENTER );
    final JButton myTestButton = new JButton( "Close" );
    f.addWindowListener ( new WindowAdapter()
    {
      public void windowClosing( WindowEvent e )
      {
        System.exit(0 );
      }
    } );
    myTestButton.setText( "Press Me to close" );
    p.add( myTestButton, BorderLayout.SOUTH );
    f.getContentPane().add( p );
    f.pack();
    // KiwiUtils.centerWindow(appFrame_);
    f.toFront();
    f.setVisible( true );
    f.repaint();

  }
}

/*
 *  Here is the revision log
 *  ------------------------
 *  $Log: ColouredLabel.java,v $
 *  Revision 1.4  2002/04/02 22:10:23  anonymous
 *  Added CVS Headerv And Log.
 *
*/