info.monitorenter.gui.chart.traces.painters.TracePainterVerticalBar Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jchart2d Show documentation
JChart2D is an easy to use component for displaying two- dimensional traces in a coordinate system written in Java.
The newest version!
/*
 *  TracePainterBar.java, a trace painter that renders a bar 
 *  for each point.
 *  Copyright (c) 2004 - 2011  Achim Westermann, [email protected]
 *
 *  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 St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 *  If you modify or optimize the code in a useful way please let me know.
 *  [email protected]
 */
package info.monitorenter.gui.chart.traces.painters;

import info.monitorenter.gui.chart.Chart2D;
import info.monitorenter.gui.chart.ITracePoint2D;
import info.monitorenter.gui.chart.pointpainters.PointPainterVerticalBar;

import java.awt.Graphics;

/**
 * Renders traces by painting a bar with choosable width for each
 * {@link info.monitorenter.gui.chart.TracePoint2D} to show.
 * 
 * Bars are placed around the x value to render: the middle of the bar in x
 * dimension is the exact x value.
 * 

 * 
 * @author Achim Westermann 
 * 
 * @version $Revision: 1.19 $
 * 
 */
public class TracePainterVerticalBar extends ATracePainter {

  /** Generated serialVersionUID. */
  private static final long serialVersionUID = 6151930248938945671L;

  /** The implementation for rendering the point as a vertical bar. */
  private final PointPainterVerticalBar m_pointPainter;

  /**
   * Creates an instance with a default bar width size of 4.
   * 

   * 
   * @param chart
   *          needed for bound information.
   */
  public TracePainterVerticalBar(final Chart2D chart) {
    this(4, chart);
  }

  /**
   * Creates an instance with the bar width.
   * 
   * @param barWidth
   *          the bar width in pixel to use.
   * 
   * @param chart
   *          needed for bound information.
   */
  public TracePainterVerticalBar(final int barWidth, final Chart2D chart) {
    this.m_pointPainter = new PointPainterVerticalBar(barWidth, chart);
  }

  /**
   * @see info.monitorenter.gui.chart.ITracePainter#endPaintIteration(java.awt.Graphics)
   */
  @Override
  public void endPaintIteration(final Graphics g2d) {
    if (g2d != null) {
      this.m_pointPainter.paintPoint(this.getPreviousX(), this.getPreviousY(), 0, 0, g2d, this
          .getPreviousPoint());
    }
  }

  /**
   * @see java.lang.Object#equals(java.lang.Object)
   */
  @Override
  public boolean equals(final Object obj) {
    if (this == obj) {
      return true;
    }
    if (!super.equals(obj)) {
      return false;
    }
    if (this.getClass() != obj.getClass()) {
      return false;
    }
    final TracePainterVerticalBar other = (TracePainterVerticalBar) obj;
    if (this.m_pointPainter == null) {
      if (other.m_pointPainter != null) {
        return false;
      }
    } else if (!this.m_pointPainter.equals(other.m_pointPainter)) {
      return false;
    }
    return true;
  }

  /**
   * Returns the diameter of the discs to paint in pixel.
   * 

   * 
   * @return the diameter of the discs to paint in pixel.
   */
  public int getBarWidth() {
    return this.m_pointPainter.getBarWidth();
  }

  /**
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode() {
    final int prime = 31;
    int result = super.hashCode();
    result = prime * result + ((this.m_pointPainter == null) ? 0 : this.m_pointPainter.hashCode());
    return result;
  }

  /**
   * @see info.monitorenter.gui.chart.traces.painters.ATracePainter#paintPoint(int,
   *      int, int, int, java.awt.Graphics,
   *      info.monitorenter.gui.chart.ITracePoint2D)
   */
  @Override
  public void paintPoint(final int absoluteX, final int absoluteY, final int nextX,
      final int nextY, final Graphics g, final ITracePoint2D original) {
    super.paintPoint(absoluteX, absoluteY, nextX, nextY, g, original);
    this.m_pointPainter.paintPoint(absoluteX, absoluteY, nextX, nextY, g, original);
  }

  /**
   * Sets the width of the bars to paint in pixel.
   * 
   * 
   * @param barWidth
   *          the width of the bars to paint in pixel.
   */
  public void setBarWidth(final int barWidth) {
    this.m_pointPainter.setBarWidth(barWidth);
  }
}