/*
 Interface encapsulating platform dependent code of the PlotterBase from the
 platform independent parts.

 @Copyright (c) 1998-2014 The Regents of the University of California.
 All rights reserved.

 Permission is hereby granted, without written agreement and without
 license or royalty fees, to use, copy, modify, and distribute this
 software and its documentation for any purpose, provided that the
 above copyright notice and the following two paragraphs appear in all
 copies of this software.

 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.

 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 ENHANCEMENTS, OR MODIFICATIONS.

 PT_COPYRIGHT_VERSION 2
 COPYRIGHTENDKEY
 */
package ptolemy.actor.lib.gui;

import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.plot.PlotBoxInterface;

//////////////////////////////////////////////////////////////////////////
//// PlotterBaseInterface
/**
 * Interface encapsulating platform dependent code of the PlotterBase from the
 * platform independent parts.
 * @author Anar Huseynov
 * @version $Id: PlotterBaseInterface.java 70402 2014-10-23 00:52:20Z cxh $
 * @since Ptolemy II 10.0
 * @Pt.ProposedRating Red (ahuseyno)
 * @Pt.AcceptedRating Red (ahuseyno)
 */
public interface PlotterBaseInterface {

    /**
     * Free up memory when closing.
     */
    public void cleanUp();

    /**
     * Bring the plotter frame to the front.
     */
    public void bringToFront();

    /**
     * Get the plotter's frame.
     * @return the plotter's frame.
     * @see #setFrame(Object)
     */
    public Object getFrame();

    /**
     * Get the platform dependent container that contains the plotter.
     * @return the platform dependent container.
     * @see #setPlatformContainer(Object)
     */
    public Object getPlatformContainer();

    /**
     * Get the plotter tableau.
     * @return the plotter tableau.
     */
    public Object getTableau();

    /**
     * Initialize the implementation.
     * @param plotterBase the instance that created the implementation.
     */
    public void init(PlotterBase plotterBase);

    /**
     * Initialize the effigy of the plotter.
     * @exception IllegalActionException If there is a problem initializing the effigy
     */
    public void initializeEffigy() throws IllegalActionException;

    /**
     * Initialize window and size attributes.
     * @exception IllegalActionException if there is a problem creating the attributes.
     * @exception NameDuplicationException if there is a problem creating the attributes.
     */
    public void initWindowAndSizeProperties() throws IllegalActionException,
    NameDuplicationException;

    /**
     * Create a new instance of the PlotBoxInterface implementation.
     * @return a new instance of the PlotBoxInterface implementation.
     */
    public PlotBoxInterface newPlot();

    /**
     * Remove the plot from the current container, if there is one.
     */
    public void remove();

    /**
     * Remove the plot from the frame if the container is null.
     */
    public void removeNullContainer();

    /**
     * Set the frame of the plotter.
     * @param frame The frame to set.
     * @see #getFrame()
     */
    public void setFrame(Object frame);

    /**
     * Set the title of the tableau.
     * @param title the title to set.
     */
    public void setTableauTitle(String title);

    /**
     * Set the platform dependent container of the plotter.
     * The container can be AWT container or Android view.
     * @param container the platform dependent container.
     * @see #getPlatformContainer()
     */
    public void setPlatformContainer(Object container);

    /**
     * Update size attribute of the plotter.
     */
    public void updateSize();

    /**
     * Update values of the attributes.
     */
    public void updateWindowAndSizeAttributes();
}