Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting.swing.api;

import java.net.URL;

import java.util.Collection;

import java.util.List;

import javax.swing.Action;

import javax.swing.ImageIcon;

import javax.swing.JComponent;

import javax.swing.JPanel;

import org.gvsig.about.AboutManager;

import org.gvsig.scripting.ScriptingDialog;

import org.gvsig.scripting.ScriptingFolder;

import org.gvsig.scripting.ScriptingManager;

import org.gvsig.scripting.ScriptingScript;

import org.gvsig.scripting.ScriptingUnit;

import org.gvsig.tools.swing.api.Component;

import org.gvsig.tools.swing.api.windowmanager.WindowManager;

/**

 * There are two top level management roles within ScriptingFramework: logical

 * and User's Interface (UI) management.

 *

 * This class is responsible of the UI management role. It provides all the

 * components shown in the ScriptingFramework.

 *

 * @see ScriptingManager

 *

 */

public interface ScriptingUIManager {

    /**

     * Creates a new {@link JScriptingLauncher} component.

     *

     * @return a new {@link JScriptingLauncher}.

     *

     * @see JScriptingLauncher

     */

    public JScriptingLauncher createLauncher();

    /**

     * Creates a new {@link JScriptingComposer} component.

     *

     * @return a new {@link JScriptingComposer}.

     *

     * @see JScriptingComposer

     */

    public JScriptingComposer createComposer();

    /**

     * Creates a new {@link  JScriptingBrowser} component.

     *

     * @param root {@link  ScriptingFolder} that identificates the image.

     * @param foldersOnly boolean to indicate if only will be shown folders (if

     * it's true) or it will be shown the ScriptingBaseScript files too (false

     * value). By default, false

     *

     * @return a new {@link  JScriptingBrowser}.

     *

     * @see JScriptingBrowser

     */

    public JScriptingBrowser createBrowser(ScriptingFolder root, boolean foldersOnly);

    /**

     * Creates a new {@link  JScriptingBrowser} component.

     *

     * @param root {@link  ScriptingFolder} that identificates the image.

     *

     * @return a new {@link  JScriptingBrowser}.

     *

     * @see JScriptingBrowser

     */

    public JScriptingBrowser createBrowser(ScriptingFolder root);

    /**

     * Creates a new {@link  JScriptingInstaller} component.

     *

     * @return a new {@link  JScriptingInstaller}.

     *

     * @see JScriptingInstaller

     */

    public JPanel createInstaller();

    /**

     * Creates a new JEditorPane component with syntax highlight.

     *

     * @return a new {@link JEditorPaneSyntaxHighlighting}.

     *

     * @see JEditorPaneSyntaxHighlighting

     */

    public SyntaxtHighlightTextComponent createSyntaxHighlightingPanel();

    /**

     * Creates a new {@link JCodeEditor} component.

     * @param script

     * @return a new {@link JCodeEditor}.

     *

     * @see JCodeEditor

     */

    public JCodeEditor createJCodeEditor(ScriptingScript script);

    /**

     * Creates a new {@link JDialogEditor} component.

     *

     * @param uimanager

     * @param script

     * @return a new {@link JDialogEditor}.

     *

     * @see JDialogEditor

     */

    public JDialogEditor createJDialogEditor(ScriptingDialog script);

    /**

     * Creates a new {@link JThinlet} component.

     *

     * @return a new {@link JThinlet}.

     *

     * @see JThinlet

     */

    public JThinlet createJThinlet();

    /**

     * Creates a new {@link JThinG} component.

     *

     * @return a new {@link JThinG}.

     *

     * @see JThinG

     */

    public JThinG createJThinG();

    /**

     * Creates a JEditor for the scripting unit passed as parameter.

     * Return null if not exists an editor for this unit.

     * 

     * @param unit

     * @return 

     */

    public JEditor createEditor(ScriptingUnit unit);

    /**

     * Returns a ImageIcon associated with the name.

     *

     * @param name String that identificates the image.

     *

     * @return the ImageIcon identified by the String name.

     */

    public ImageIcon getIcon(String name);

    /**

     * Returns a ImageIcon associated with the name.

     *

     * @param name String that identificates the image.

     * @param size String to specify if the size of the icon would be "small",

     * "medium" or "big" (default value: "small").

     *

     * @return the ImageIcon identified by the String name.

     */

    public ImageIcon getIcon(String name, String size);

    /**

     * Returns the {@link ScriptingManager} of the ScriptingFramework.

     *

     * @return {@link ScriptingManager}

     */

    public ScriptingManager getManager();

    /**

     * Returns the {@link AboutManager} to provide services of the 'About Us'

     * information of the ScriptingFramework.

     *

     * @return the {@link AboutManager}

     *

     * @see AboutManager

     */

    public AboutManager getAboutManager();

    /**

     * Returns a help panel.

     *

     * @return a JPanel with the JavaDocs registered in the application

     */

    public JPanel getHelp();

    /**

     * Returns a help panel.

     *

     * @return a JPanel with the User's help of the application

     */

    public JPanel getUserHelp();

    public void addUserHelp(String langName, URL resource);

    /**

     * Shows a JPanel in a dialog window with it's own characteristics

     *

     * @param panel JPanel included in the dialog's content

     * @param title String with the dialog's title

     *

     */

    public void showDialog(JComponent panel, String title);

    /**

     * Shows a JPanel in a window with it's own characteristics

     *

     * @param panel JPanel included in the window's content

     * @param title String with the window's title

     *

     */

    public void showWindow(JComponent panel, String title);

    /**

     * Shows a JPanel in a tool window with it's own characteristics

     *

     * @param panel JPanel included in the tool's content

     * @param title String with the tool's title

     *

     */

    public void showTool(JComponent panel, String title);

    public String getTranslation(String key);

    public void setWindowManager(WindowManager windowsManager);

    public WindowManager getWindowManager();

    public JScriptingConsole createJScriptingConsole();

    public JScriptingConsole createJScriptingConsole(boolean captureOutput);

    public void addComposerTool(Action action);

    public void addComposerMenu(String text, Action action);

    public Collection<Action> getComposerTools();

    public interface MenuEntry {

        public String getText();

        public Action getAction();

    }

    public Collection<MenuEntry> getComposerMenus();

    public JScriptingComposer getActiveComposer();

    public void addCreatedComponentListener(CreateComponentListener listener);

    public void removeCreatedComponentListener(CreateComponentListener listener);

    public void registerEditor(EditorFactory factory);

    public boolean hasEditor(ScriptingUnit unit);

    public List<EditorFactory> getEditorFactories();

}