weka.gui.visualize.PrintablePanel Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of weka-stable Show documentation

The Waikato Environment for Knowledge Analysis (WEKA), a machine learning workbench. This is the stable version. Apart from bugfixes, this version does not receive any other updates.

There is a newer version: 3.8.6

Show newest version

/*
 *   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 3 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, see .
 */

/*
 *    PrintablePanel.java
 *    Copyright (C) 2005-2012 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.gui.visualize;

import java.util.Hashtable;

import javax.swing.JPanel;

/**
 * This Panel enables the user to print the panel to various file formats. The
 * Print dialog is accessible via Ctrl-Shft-Left Mouse Click.
 * 
 * The individual JComponentWriter-descendants can be accessed by the
 * getWriter(String) method, if the parameters need to be changed.
 * 
 * @see #getWriters()
 * @see #getWriter(String)
 * @author FracPete (fracpete at waikato dot ac dot nz)
 * @version $Revision: 10222 $
 */
public class PrintablePanel extends JPanel implements PrintableHandler {

  /** for serialization */
  private static final long serialVersionUID = 6281532227633417538L;

  /** the class responsible for printing */
  protected PrintableComponent m_Printer = null;

  /**
   * initializes the panel
   */
  public PrintablePanel() {
    super();
    m_Printer = new PrintableComponent(this);
  }

  /**
   * returns a Hashtable with the current available JComponentWriters in the
   * save dialog. the key of the Hashtable is the description of the writer.
   * 
   * @return all currently available JComponentWriters
   * @see JComponentWriter#getDescription()
   */
  @Override
  public Hashtable getWriters() {
    return m_Printer.getWriters();
  }

  /**
   * returns the JComponentWriter associated with the given name, is
   * null if not found
   * 
   * @return the writer associated with the given name
   * @see JComponentWriter#getDescription()
   */
  @Override
  public JComponentWriter getWriter(String name) {
    return m_Printer.getWriter(name);
  }

  /**
   * sets the title for the save dialog
   */
  @Override
  public void setSaveDialogTitle(String title) {
    m_Printer.setSaveDialogTitle(title);
  }

  /**
   * returns the title for the save dialog
   */
  @Override
  public String getSaveDialogTitle() {
    return m_Printer.getSaveDialogTitle();
  }

  /**
   * sets the scale factor
   * 
   * @param x the scale factor for the x-axis
   * @param y the scale factor for the y-axis
   */
  @Override
  public void setScale(double x, double y) {
    m_Printer.setScale(x, y);
  }

  /**
   * returns the scale factor for the x-axis
   */
  @Override
  public double getXScale() {
    return m_Printer.getXScale();
  }

  /**
   * returns the scale factor for the y-axis
   */
  @Override
  public double getYScale() {
    return m_Printer.getYScale();
  }

  /**
   * displays a save dialog for saving the panel to a file.
   */
  @Override
  public void saveComponent() {
    m_Printer.saveComponent();
  }
}