Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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 2

 * 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.swing;

import java.awt.Color;

import java.util.ArrayList;

import java.util.HashMap;

import javax.swing.ImageIcon;

import javax.swing.JPanel;

import org.gvsig.raster.swing.buttonbar.ButtonBar;

import org.gvsig.raster.swing.gcanvas.GCanvas;

import org.gvsig.raster.swing.infobypoint.MainInfoByPointPanel;

import org.gvsig.raster.swing.newlayer.CreateNewLayerPanel;

import org.gvsig.raster.swing.newlayer.FileNameManagement;

import org.gvsig.raster.swing.openfile.OpenFileContainer;

import org.gvsig.raster.swing.preview.DataSourcePreview;

import org.gvsig.raster.swing.preview.PreviewPanel;

import org.gvsig.raster.swing.preview.PreviewRenderProcess;

import org.gvsig.raster.swing.roi.ROIPanel;

/**

 * This class is responsible of the management of the library's swing user

 * interface. It is the swing library's main entry point, and provides all the

 * services to manage library swing components.

 * 

 * @see RasterWindowManager

 * @see JValidationServicePanel

 * @author gvSIG team

 * @version $Id$

 */

public interface RasterSwingManager {

    /**

     * Returns the translation of a string.

     * 

     * @param key

     *            String to translate

     * @return a String with the translation of the string passed by parameter

     */

    public String getTranslation(String key);

    /**

     * Registers a new instance of a WindowManager which provides services to

     * the management of the application windows.

     * 

     * @param manager

     *            {@link RasterWindowManager} to register in the

     *            ScriptingUIManager.

     * @see RasterWindowManager

     */

    public void registerWindowManager(RasterWindowManager manager);

    /**

     * Returns the {@link RasterWindowManager}.

     * 

     * @return {@link RasterWindowManager}

     * @see {@link RasterWindowManager}

     */

    public RasterWindowManager getWindowManager();

    public BasePanel createGenericBasePanel();

    /**

     * Creates a canvas to draw graphic layers.

     * @param backgroundColor

     * @return

     */

    public GCanvas createGraphicCanvas(Color backgroundColor);

    /**

     * Creates a preview panel using a data source, a render process and a list

     * of panels

     * @param buttons

     * @param list

     * @param generalPanel

     * @param downPreviewPanel

     * @param renderProcess

     * @param dataSource

     * @return

     */

    @SuppressWarnings("unchecked")

        public PreviewPanel createPreviewPanel(int buttons, 

                    ArrayList list,

                    JPanel generalPanel,

                    JPanel downPreviewPanel,

                    PreviewRenderProcess renderProcess,

                    DataSourcePreview dataSource);

    /**

     * Creates a preview panel using a data source, a render process and a list

     * of panels

     * @param buttons

     * @param list

     * @param generalPanel

     * @param downPreviewPanel

     * @param renderProcess

     * @param dataSource

     * @deprecated Use createSinglePreviewPanel without {@link PreviewRenderProcess} parameter.

     * @return

     */

        public PreviewPanel createSinglePreviewPanel( 

                    PreviewRenderProcess renderProcess,

                    DataSourcePreview dataSource);

    /**

     * Creates a preview panel using a render process. After the creation the function

     * setLayer in {@link PreviewPanel} should be invoked.

     * @param buttons

     * @param list

     * @param generalPanel

     * @param downPreviewPanel

     * @param renderProcess

     * @param dataSource

     * @return

     */

        public PreviewPanel createSinglePreviewPanel( 

                    PreviewRenderProcess renderProcess);

    /**

     * Creates the information by point panel

     * @param translations

     * @param extended

     * @return

     */

    public MainInfoByPointPanel createInfoByPointPanel(

                    HashMap<String, String> translations, 

                    HashMap<String, ImageIcon> icons, 

                    JPanel extended);

    /**

     * Creates a button bar component

     * @return

     */

    public ButtonBar createButtonBar();

    /**

     * Creates a panel to build a new layer

     * @param fileNameManagement

     * @param extList

     *                         List of file extensions to accept

     * @return

     */

    public CreateNewLayerPanel createNewLayerPanel(FileNameManagement fileNameManagement);

    /**

     * Creates a panel to open files

     * @param showBorder

     * @param fileFilter

     * @return

     */

    public OpenFileContainer createOpenFileContainer(boolean showBorder, String[] fileFilter, String defaultPath);

    /**

     * Creates a panel for manage ROIs of raster

     * @return

     */

    public ROIPanel createROIPanel();

}