001/*****************************************************************************
002 * Copyright by The HDF Group.                                               *
003 * Copyright by the Board of Trustees of the University of Illinois.         *
004 * All rights reserved.                                                      *
005 *                                                                           *
006 * This file is part of the HDF Java Products distribution.                  *
007 * The full copyright notice, including terms governing use, modification,   *
008 * and redistribution, is contained in the files COPYING and Copyright.html. *
009 * COPYING can be found at the root of the source code distribution tree.    *
010 * Or, see http://hdfgroup.org/products/hdf-java/doc/Copyright.html.         *
011 * If you do not have access to either file, you may request a copy from     *
012 * help@hdfgroup.org.                                                        *
013 ****************************************************************************/
014
015package hdf.view;
016
017import hdf.object.HObject;
018
019/**
020 * 
021 * Defines a list of APIs for the main HDFView winodows
022 * 
023 * @author Peter X. Cao
024 * @version 2.4 9/6/2007
025 */
026public abstract interface ViewManager {
027    /** data content is displayed, and add the dataview to the main windows */
028    public abstract void addDataView(DataView dataView);
029
030    /** data content is closed, and remove the dataview from the main window */
031    public abstract void removeDataView(DataView dataView);
032
033    /**
034     * Returns DataView contains the specified data object. It is useful to
035     * avoid redundant display of data object that is opened already.
036     * 
037     * @param dataObject
038     *            the whose presence in the main view is to be tested.
039     * @return DataView contains the specified data object, null if the data
040     *         object is not displayed.
041     */
042    public abstract DataView getDataView(HObject dataObject);
043
044    /** display feedback message */
045    public abstract void showStatus(String msg);
046
047    /** returns the current treeView */
048    public abstract TreeView getTreeView();
049
050    /** Tree mouse event fired */
051    public abstract void mouseEventFired(java.awt.event.MouseEvent e);
052}