content: /* ===========================================================
   * JFreeChart : a free chart library for the Java(tm) platform
   * ===========================================================
   *
   * (C) Copyright 2000-2013, by Object Refinery Limited and Contributors.
   *
   * Project Info:  http://www.jfree.org/jfreechart/index.html
   *
   * This library is free software; you can redistribute it and/or modify it
   * under the terms of the GNU Lesser General Public License as published by
   * the Free Software Foundation; either version 2.1 of the License, or
   * (at your option) any later version.
   *
   * This library 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 Lesser General Public
   * License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
   * USA.
   *
   * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
   * in the United States and other countries.]
   *
   * ---------------------------
   * RegionSelectionHandler.java
   * ---------------------------
   * (C) Copyright 2009-2013, by Object Refinery Limited and Contributors.
   *
   * Original Author:  David Gilbert (for Object Refinery Limited);
   * Contributor(s):   Michael Zinsmaier;
   *
   * Changes:
   * --------
   * 19-Jun-2009 : Version 1 (DG);
   *
   */
  
  package org.jfree.chart.panel.selectionhandler;
  
  import java.awt.BasicStroke;
  import java.awt.Color;
  import java.awt.Paint;
  import java.awt.Stroke;
  import java.awt.event.MouseEvent;
  import java.io.IOException;
  import java.io.ObjectInputStream;
  import java.io.ObjectOutputStream;
  
  import org.jfree.chart.panel.AbstractMouseHandler;
  import org.jfree.chart.util.SerialUtilities;
  
  /**
   * A mouse handler that allows data items to be selected based on a selection 
   * region that is created by the handler.
   */
  public abstract class RegionSelectionHandler extends AbstractMouseHandler {
  
      /** a generated serial id. */
      private static final long serialVersionUID = -4671799719995583469L;
  
      /**
       * The outline stroke.
       */
      protected transient Stroke outlineStroke;
  
      /**
       * The outline paint.
       */
      protected transient Paint outlinePaint;
  
      /**
       * The fill paint.
       */
      protected transient Paint fillPaint;
  
      private static final Stroke DEFAULT_OUTLINE_STROKE = new BasicStroke(1.0f, 
              BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND, 2.0f, 
              new float[] {3f, 3f}, 0f);
      
      /**
       * Creates a new default instance.
       */
      public RegionSelectionHandler() {
          this(DEFAULT_OUTLINE_STROKE, Color.ORANGE, 
                  new Color(255, 0, 255, 50));
      }
  
      /**
       * Creates a new selection handler with the specified attributes.
       * 
       * @param outlineStroke  the outline stroke (<code>null</code> permitted).
       * @param outlinePaint  the outline paint (<code>null</code> permitted).
       * @param fillPaint  the fill paint (<code>null</code> permitted).
       */
      public RegionSelectionHandler(Stroke outlineStroke, Paint outlinePaint,
              Paint fillPaint) {
          super();
          this.outlineStroke = outlineStroke;
          this.outlinePaint = outlinePaint;
          this.fillPaint = fillPaint;
      }
  
      /**
       * Creates a new instance with a modifier restriction.
       * 
       * @param modifier e.g. shift has to be pressed InputEvents.SHIFT_MASK
       */
      public RegionSelectionHandler(int modifier) {
          super(modifier);
      }
      
      /**
       * Returns the fill paint.
       *
       * @return The fill paint (possibly <code>null</code>).
       *
       * @see #setFillPaint(java.awt.Paint)
       */
      public Paint getFillPaint() {
          return fillPaint;
      }
  
      /**
       * Sets the fill paint.
       *
       * @param fillPaint  the fill paint (<code>null</code> permitted).
       *
       * @see #getFillPaint()
       */
      public void setFillPaint(Paint fillPaint) {
          this.fillPaint = fillPaint;
      }
  
      /**
       * Returns the outline paint.
       * 
       * @return The outline paint (possibly <code>null</code>). 
       */
      public Paint getOutlinePaint() {
          return outlinePaint;
      }
  
      /**
       * Sets the outline paint.
       * 
       * @param outlinePaint  the paint (<code>null</code> permitted).
       */
      public void setOutlinePaint(Paint outlinePaint) {
          this.outlinePaint = outlinePaint;
      }
  
      /**
       * Returns the outline stroke.
       * 
       * @return The outline stroke (possibly <code>null</code>).
       */
      public Stroke getOutlineStroke() {
          return outlineStroke;
      }
  
      /**
       * Sets the outline stroke.
       * 
       * @param outlineStroke  the outline stroke (<code>null</code> permitted).
       */
      public void setOutlineStroke(Stroke outlineStroke) {
          this.outlineStroke = outlineStroke;
      }
  
      /**
       * Handles a mouse pressed event.
       * 
       * @param e  the event.
       */
      @Override
      public abstract void mousePressed(MouseEvent e);
  
      /**
       * Handles a mouse dragged event.
       *
       * @param e  the event.
       */
      @Override
      public abstract void mouseDragged(MouseEvent e);
      
      /**
       * Handles a mouse released event.
       * 
       * @param e  the event.
       */
      @Override
      public abstract void mouseReleased(MouseEvent e);
      
      public boolean isLiveHandler() {
          // FIXME: is this always true?
          return true;
      }
      
      /**
       * Provides serialization support.
       * 
       * @param stream  the output stream.
       * 
       * @throws IOException  if there is an I/O error.
       */
      private void writeObject(ObjectOutputStream stream) throws IOException {
          stream.defaultWriteObject();
          SerialUtilities.writePaint(this.outlinePaint, stream);
          SerialUtilities.writePaint(this.fillPaint, stream);
          SerialUtilities.writeStroke(this.outlineStroke, stream);
      }
  
      /**
       * Provides serialization support.
       * 
       * @param stream  the input stream.
       * 
       * @throws IOException  if there is an I/O error.
       * @throws ClassNotFoundException  if there is a classpath problem.
       */
      private void readObject(ObjectInputStream stream) throws IOException,
              ClassNotFoundException {
          stream.defaultReadObject();
          this.outlinePaint = SerialUtilities.readPaint(stream);
          this.fillPaint = SerialUtilities.readPaint(stream);
          this.outlineStroke = SerialUtilities.readStroke(stream);
      }
  }
  