Application: gvSIG desktop » gvSIG scripting

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.scripting.swing.api</artifactId>

	<packaging>jar</packaging>

	<name>org.gvsig.scripting.swing.api</name>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.scripting.swing</artifactId>

		<version>2.3.240</version>

	</parent>

	<dependencies>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.tools.lib</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.tools.swing.api</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.i18n</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.scripting.thing</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.about.api</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.scripting.lib.api</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>javax.help</groupId>

			<artifactId>javahelp</artifactId>

			<scope>compile</scope>

		</dependency>

	</dependencies>

</project>

package org.gvsig.scripting.swing.api;

import java.io.File;

import javax.swing.JPanel;

import thinlet.Thinlet;

/**

 * <code>JThinG</code> is a component that provides an interface to edit the dialog window

 * associated to a {@link ScriptingDialog}.

 * 

 * @see JThinlet

 * 

 */

public abstract class JThinG extends JPanel{

	/**

	 * 

	 */

	private static final long serialVersionUID = -623339194209238547L;

	/**

	 * Loads the file with the code of the dialog interface.

	 * 

	 * @param file File where is the code of the dialog window of the {@link ScriptingDialog}

	 */

	public abstract void load(File file);

	/**

	 * Saves the file with the code of the dialog interface.

	 * 

	 * @param file File where it will be saved the code of the dialog window of the {@link ScriptingDialog}

	 */

	public abstract  void save(File file);

	/**

	 * Gets the Thinlet Component associated to this.

	 * 

	 * @return Thinlet

	 */

	public abstract Thinlet getThinlet();

}

package org.gvsig.scripting.swing.api;

import java.awt.event.ActionListener;

import java.io.File;

import javax.swing.JPanel;

import javax.swing.event.ChangeListener;

import javax.swing.event.ListSelectionListener;

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;

/**

 * <code>JScriptingComposer</code> provides services to the management and

 * edition of the {@link ScriptingUnit}s of the ScriptingFramework.

 *

 * @see JScriptingLauncher

 */

public interface JScriptingComposer extends Component {

    public static final String DOCKED_PROBLEMS = "Problems";

    public static final String DOCKED_CONSOLE = "Console";

    public static final String DOCKED_PROJECTS = "Projects";

    public interface Dock extends Iterable<Dock.DockedPanel> {

        public static final String DOCK_TOP = "North";

        public static final String DOCK_BOTTOM = "South";

        public static final String DOCK_LEFT = "West";

        public static final String DOCK_RIGHT = "East";

        public static final String DOCK_CENTER = "Center";

        public static final String ACTION_ACTIVATE_PANEL = "ActivePanel";

        public static final String ACTION_CLOSE_PANEL = "ClosePanel";

        public interface DockedPanel {

            public String getId();

            public Component getComponent();

            public String getTitle();

            public String getAlign();

            public boolean isModified();

            public void setModified(boolean modified);

            public void remove();

            public void select();

            public void moveto(String position);

        }

        public DockedPanel add(String id, String title, Component compnent, String position);

        public void remove(String id);

        public DockedPanel get(String id);

        public void select(String id);

        public DockedPanel getSelected(String position);

        public void setModified(DockedPanel panel, boolean modified);

        public boolean getModified(DockedPanel panel);

        public void addCloseListener(ActionListener listener);

        public void removeCloseListener(ActionListener listener);

        public void addActivateListener(ActionListener listener);

        public void removeActivateListener(ActionListener listener);

    }    

    public interface Problems extends Component {

        public interface Problem {

            public String getType();

            public String getMessage();

            public String getResourceName();

            public File getResource();

            public int getLineNumber();

        }

        public void addListSelectionListener(ListSelectionListener listener);

        public Problem getSelect();

        public int getCount();

        public Problem get(int n);

        public void removeAll();

        public void add(String type, String message, String resource, String location);

        public void add(String type, String message, String resource, int line, int column);

        public void add(String type, Exception e) ;

    }

    public interface StatusBar extends Component {

        public void clear();

        public void message(String message);

        public void setPosition(int line);

        public void setPosition(int line, int column);

    }

    public JPanel getAboutUsDialog();

    public void setWindowManager(WindowManager windowsManager);

    public WindowManager getWindowManager();

    public JEditor getCurrentEditor();

    public ScriptingScript getCurrentScript();

    public Dock getDock();

    public Problems getProblems();

    public JScriptingConsole getConsole();

    public JScriptingLauncher getProjects();

    public StatusBar getStatusbar();

    public void addChangeEditorListener(ChangeListener listener);

    public void removeChangeEditorListener(ChangeListener listener);

    public void refreshProjects();

}

package org.gvsig.scripting.swing.api;

import java.awt.Color;

import java.awt.event.ActionListener;

import java.awt.event.FocusListener;

import java.awt.event.KeyListener;

import javax.swing.Icon;

import javax.swing.JScrollPane;

import javax.swing.text.JTextComponent;

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

public interface SyntaxtHighlightTextComponent extends Component {

	public interface UpdateCaretPositionActionEvent extends org.gvsig.texteditor.JTextEditor.UpdateCaretPositionActionEvent {

                @Override

		public int getLine();

                @Override

		public int getColumn();

                @Override

		public boolean hasLineAndColumn();

	}

	public JTextComponent getJTextComponent();

	public JScrollPane getJScrollPane();

	public void setText(String text);

	public String getText();

	public void setContentType(String contentType);

	public String getContentType();

	public void addUpdateCaretPositionActionListener(ActionListener updateCaretPosition);

	public void addKeyListener(KeyListener keyListener);

        public void discardAllEdits();

        public void removeTrackingIcons();

        public void removeTrackingIcons(String tag);

        public void addLineTrackingIcon(String tag, int line, Icon icon, String tip, Color color);

        public void addLineTrackingIcon(String tag, int line, Icon icon, String tip);

        public void gotoline(int line);

        public void setEditable(boolean editable);

        public boolean isEditable();

        public void addFocusListener(FocusListener l);

}

package org.gvsig.scripting.swing.api;

import org.gvsig.scripting.ScriptingScript;

/**

 * <code>JCodeEditor</code> is a component that support edition to a {@link ScriptingScript}.

 * 

 * @see JEditor

 * @see JDialogEditor

 * 

 */

public interface JCodeEditor extends JTextEditor {

        public ScriptingScript getScript();

}

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.script.ScriptSwingManager;

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 extends ScriptSwingManager {

    public static final String SCRIPT_COMPOSER_AUTORUN = "scautorun";

    /**

     * 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();

    /**

     * 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();

}

package org.gvsig.scripting.swing.api;

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

public interface CreateComponentListener {

    public void componentCreated(Component component);

}

package org.gvsig.scripting.swing.api;

import java.awt.Dimension;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import org.gvsig.scripting.ScriptingBaseScript;

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

/**

 * <code>JScriptingLauncher</code> is a component that contains

 * {@link JScriptingBrowser}s to navigate for the User's Folder and for System's

 * Folder. It has a tab for each {@link JScriptingBrowser}. It catches the

 * exceptions throws by {@link JScriptingBrowser} and it do the associated

 * action or throw a new exception to the {@link JScriptingComposer} (if it's

 * included on it)

 *

 * @see JScriptingBrowser

 * @see JScriptingComposer

 *

 */

public interface JScriptingLauncher extends Component {

    public static final int DEFAULT_ACTION = 1;

    public static final int SELECTION_ACTION = 2;

    public static final int DROPDOWN_ACTION = 3;

    /**

     * Reloads the content of the {@link JScriptingBrowser}s

     *

     */

    public void refresh();

    /**

     * Return the selected browser in this launcher.

     * 

     * @return 

     */

    public JScriptingBrowser getSelectedBrowser();

    /**

     * Registra un listener para ser informado cuando se realiza doble click

     * sobre un ScriptingUnit.

     *

     * @param listener

     */

    public void addDefaultActionListener(ActionListener listener);

}

package org.gvsig.scripting.swing.api;

import org.gvsig.tools.locator.BaseLocator;

public class ScriptingSwingLocator extends BaseLocator {

	private static final String LOCATOR_NAME = "ScriptingSwingLocator";

	public static final String UIMANAGER_NAME = "scriptingswinglocator.uimanager";

	public static final String UIMANAGER_DESCRIPTION = "Scripting UIManager";

	/**

	 * Unique instance.

	 */

	private static final ScriptingSwingLocator instance = new ScriptingSwingLocator();

	/**

	 * Return the singleton instance.

	 *

	 * @return the singleton instance

	 */

	public static ScriptingSwingLocator getInstance() {

		return instance;

	}

	/**

	 * Return the Locator's name

	 *

	 * @return a String with the Locator's name

	 */

	@Override

    public String getLocatorName() {

		return LOCATOR_NAME;

	}

    /**

     * Registers the Class implementing the ScriptingUIManager interface.

     * 

     * @param clazz

     *            implementing the ScriptingUIManager interface

     */

    public static void registerUIManager(

        Class<? extends ScriptingUIManager> clazz) {

		getInstance().register(UIMANAGER_NAME, UIMANAGER_DESCRIPTION, clazz);

	}

	/**

	 * Gets the instance of the {@link ScriptingUIManager} registered.

	 *

	 * @return {@link ScriptingUIManager}

	 */

	public static ScriptingUIManager getUIManager() {

		return (ScriptingUIManager) getInstance().get(UIMANAGER_NAME);

	}

}

package org.gvsig.scripting.swing.api;

import java.awt.Color;

import java.io.PrintStream;

import java.io.Writer;

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

public interface JScriptingConsole extends Component {

    public void append(String s);

    public void append(String msg, Color color);

    public void clear();

    public PrintStream errors();

    public PrintStream output();

    public Writer getOutputWriter();

    public Writer getErrorsWriter();     

}

package org.gvsig.scripting.swing.api;

import org.gvsig.scripting.ScriptingLibrary;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.locator.ReferenceNotRegisteredException;

public class ScriptingSwingLibrary extends AbstractLibrary {

    @Override

    public void doRegistration() {

        registerAsAPI(ScriptingSwingLibrary.class);

        require(ScriptingLibrary.class);

    }

    @Override

    protected void doInitialize() throws LibraryException {

        // Nothing to do

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

        // Validate there is any implementation registered.

        ScriptingUIManager manager = ScriptingSwingLocator.getUIManager();

        if (manager == null) {

            throw new ReferenceNotRegisteredException(

                ScriptingSwingLocator.UIMANAGER_NAME,

                ScriptingSwingLocator.getInstance());

        }

    }

}

package org.gvsig.scripting.swing.api;

import java.awt.event.ActionListener;

import java.beans.PropertyChangeListener;

import org.gvsig.scripting.ScriptingBaseScript;

import org.gvsig.scripting.ScriptingUnit;

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

/**

 * <code>AbstractJEditor</code> is a component that provides services to edit the content of

 * a {@link ScriptingBaseScript}.

 * 

 * @see JCodeEditor

 * @see JDialogEditor

 * 

 */

public interface JEditor  extends Component {

	public ScriptingUnit getUnit();

	public void addChangeListener(PropertyChangeListener listener);

	public void save();

        public boolean isModified();

        public void set(ScriptingUnit unit);

        public void fetch(ScriptingUnit unit);

}

package org.gvsig.scripting.swing.api;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.scripting.ScriptingUnit;

public abstract class AbstractEditorFactory implements EditorFactory {

    private final String description;

    private final String name;

    protected AbstractEditorFactory(String name, String description) {

        if( StringUtils.isEmpty(name) ) {

            this.name = this.getClass().getSimpleName();

        } else {

            this.name = name;

        }

        if( StringUtils.isEmpty(description) ) {

            this.description = "";

        } else {

            this.description = description;

        }

    }

    @Override

    public String getName() {

        return this.name;

    }

    @Override

    public String getDescription() {

        return this.description;

    }

    @Override

    public int getPriority() {

        return 1000;

    }

    @Override

    public JEditor create(ScriptingUnit unit) {

        if( this.canCreate(unit) ) {

            return doCreate(unit);

        }

        throw new IllegalArgumentException();

    }

    protected abstract JEditor doCreate(ScriptingUnit unit);

}

package org.gvsig.scripting.swing.api;

import java.awt.event.ActionListener;

import javax.swing.text.JTextComponent;

public interface JTextEditor  extends JEditor {

	public void reload();

        public void selectLine(int line);

        public void gotoline(int line);

        public int getLineCount();

	public JTextComponent getJTextComponent();

        public SyntaxtHighlightTextComponent getSyntaxtHighlightTextComponent();

        public void addUpdateCaretPositionActionListener(ActionListener actionlistener);        

}

package org.gvsig.scripting.swing.api;

import org.gvsig.scripting.ScriptingUnit;

public interface EditorFactory {

    public String getName();

    public String getDescription();

    public int getPriority();

    public JEditor create(ScriptingUnit unit);

    public boolean canCreate(ScriptingUnit unit);

}

package org.gvsig.scripting.swing.api;

import org.gvsig.scripting.ScriptingDialog;

/**

 * <code>JDialogEditor</code> is a component that support edition to a {@link ScriptingDialog).

 * 

 * @see JEditor

 * @see JCodeEditor

 * 

 */

public interface JDialogEditor extends JCodeEditor {

	/**

	 * Gets the {@link ScriptingDialog} associated with this JDialogEditor

	 * 

	 * @return {@link ScriptingDialog}

	 */

	public abstract ScriptingDialog getDialog();

	public abstract void reloadDialog();

}

package org.gvsig.scripting.swing.api;

import java.awt.LayoutManager;

import java.awt.event.ActionListener;

import javax.swing.tree.TreePath;

import org.gvsig.scripting.ScriptingBaseScript;

import org.gvsig.scripting.ScriptingFolder;

import org.gvsig.scripting.ScriptingManager;

import org.gvsig.scripting.ScriptingUnit;

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

/**

 * <code>JScriptingBrowser</code> is a component that shows hierachically a

 * system folder. It launch events on selection or double.clic of each

 * {@link ScriptingUnit}. In case of {@link ScriptingFolder} a selection will

 * load the content lazily, and double-clic will expand it. In case of

 * {@link ScriptingBaseScript} will throw a exception to the

 * {@link JScriptingLauncher}

 *

 * @see JScriptingLauncher

 *

 */

public interface JScriptingBrowser extends Component {

    public static final int DEFAULT_ACTION = 1;

    public static final int SELECTION_ACTION = 2;

    public static final int DROPDOWN_ACTION = 3;

    public interface BrowserActionEvent {

        public Object getSource();

        public int getID();

        public String getActionCommand();

        public ScriptingUnit getUnit();

    }

    public ScriptingManager getManager();

    public ScriptingFolder getRoot();

    public ScriptingUnit getSelectedNode();

    public TreePath getSelectionPath();

    public void setSelectionPath(TreePath path);

    public void addActionListener(ActionListener listener);

}

package org.gvsig.scripting.swing.api;

import java.awt.Dimension;

import java.awt.event.ActionListener;

import java.io.File;

import javax.swing.JPanel;

import javax.swing.event.AncestorEvent;

import thinlet.Thinlet;

public abstract class JThinlet extends JPanel {

	/**

	 * 

	 */

	private static final long serialVersionUID = -1758582617532787515L;

	public abstract void load(File file);

	public abstract Thinlet getThinlet();

	public abstract void invoke(String name);

	public abstract Dimension getPreferredSize();

	public abstract void ancestorAdded(AncestorEvent event);

	public abstract void ancestorMoved(AncestorEvent event);

	public abstract void ancestorRemoved(AncestorEvent event);

	public abstract void addActionListener(ActionListener actionlistener);

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.scripting package documentation</title>

</head>

<body>

	<p>TODO: Example library description.</p>

	<p>See the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#packagecomment">Javadoc Tool documentation about the package file</a></p>

</body>

</html>

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.scripting package documentation</title>

</head>

<body>

	<p>TODO: Example library overview.</p>

	<p>See the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overviewcomment">Javadoc Tool documentation about the overview file</a></p>

</body>

</html>

# Resource bundle texts for the Spanish language locale (es)

Example.returns_value=devuelve el valor

# Resource bundle texts for the English language locale (en)

Example.returns_value=returns value

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.scripting package documentation</title>

</head>

<body>

	<p>TODO: Example library overview.</p>

	<p>See the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overviewcomment">Javadoc Tool documentation about the overview file</a></p>

</body>

</html>

Put into this folder the resources needed by your library classes.

This folder is added to the runtime classpath, so you can load any resources 

through the ClassLoader.

By default, into this folder you can find some examples of resource bundle 

property files that may be used by your library classes.

org.gvsig.scripting.swing.api.ScriptingSwingLibrary

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<!-- 

Log4J configuration file for unit tests execution.

 -->

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- Appender configuration to show logging messages through the console -->

	<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">

		<layout class="org.apache.log4j.PatternLayout">

			<param name="ConversionPattern" value="%d{HH:mm:ss,SSS} %-5p [%c{2}.%M()]\n  %m%n" />

		</layout>

	</appender>

	<!-- 

	Activate logging messages of DEBUG level of higher only for the

	DefaultExampleManager class.

	You can put full classes names or packages instead, to configure

	logging for all the classes and subpackages of the package.

	-->

	<category name="org.gvsig.scripting.impl.DefaultExampleManager">

		<priority value="DEBUG" />

	</category>

	<!-- 

	By default, show only logging messages of INFO level or higher, 

	through the previously configured CONSOLE appender. 

	-->

	<root>

		<priority value="INFO" />

		<appender-ref ref="CONSOLE" />

	</root>

</log4j:configuration>

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

Put into this folder the resources needed by your test classes.

This folder is added to the Tests classpath, so you can load any resources 

through the ClassLoader.

By default, in this folder you can find an example of log4j configuration,

prepared to log messages through the console, so logging works when you

run your tests classes.

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

For each class you are going to test, create one Test class with the same

name as the class to test, ending with Test.

For example, the unit tests of the "ExampleLibrary" class are performed

by the "ExampleLibraryTest" class.

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.scripting.swing</artifactId>

	<packaging>pom</packaging>

	<name>${project.artifactId}</name>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.scripting</artifactId>

		<version>2.3.240</version>

	</parent>

	<modules>

		<module>org.gvsig.scripting.swing.api</module>

		<module>org.gvsig.scripting.swing.impl</module>

	</modules>

</project>

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <artifactId>org.gvsig.scripting.swing.impl</artifactId>

    <packaging>jar</packaging>

    <name>${project.artifactId}</name>

    <parent>

        <groupId>org.gvsig</groupId>

        <artifactId>org.gvsig.scripting.swing</artifactId>

        <version>2.3.240</version>

    </parent>

    <dependencies>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.swing.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.scripting.thing</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.about.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.scripting.lib.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.scripting.lib.impl</artifactId>

            <scope>runtime</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.scripting.swing.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>javax.help</groupId>

            <artifactId>javahelp</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>com.fifesoft</groupId>

            <artifactId>rsyntaxtextarea</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>com.fifesoft</groupId>

            <artifactId>rstaui</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.installer.lib.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.installer.lib.spi</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>com.jeta</groupId>

            <artifactId>formsrt</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>com.jgoodies</groupId>

            <artifactId>jgoodies-forms</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.lib</artifactId>

            <scope>test</scope>

            <type>test-jar</type>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.ui</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.installer.swing.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.util.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

          <groupId>com.jidesoft</groupId>

          <artifactId>jide-oss</artifactId>

        </dependency>

        <dependency>

            <groupId>org.apache.tika</groupId>

            <artifactId>tika-core</artifactId>

            <scope>compile</scope>

        </dependency>

<!--        <dependency>

            <groupId>org.apache.tika</groupId>

            <artifactId>tika-parsers</artifactId>

            <scope>compile</scope>

        </dependency>-->

    </dependencies>

    <build>

        <plugins>

            <!-- TODO: MAKE TESTS WORK AND REMOVE THIS OPTION -->

            <plugin>

                <groupId>org.apache.maven.plugins</groupId>

                <artifactId>maven-surefire-plugin</artifactId>

                <configuration>

                    <skipTests>true</skipTests>

                </configuration>

            </plugin>

        </plugins>

    </build>

</project>

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

For each class you are going to test, create one Test class with the same

name as the class to test, ending with Test.

For example, the unit tests of the "ExampleLibrary" class are performed

by the "ExampleLibraryTest" class.

package org.gvsig.scripting;

import java.awt.BorderLayout;

import java.io.File;

import javax.swing.JFrame;

import org.gvsig.scripting.swing.api.JThinlet;

import org.gvsig.scripting.swing.impl.DefaultJThinlet;

public class MyTestJScriptableThinlet {

	public static void main(String[] args) {

		// Creamos el JPanel del thinlet y le

		// cargamos el xml de pruebas.

		JThinlet panel = new DefaultJThinlet(new File("/home/jobacas/ScriptFramework/org.gvsig.scripting/src/org/gvsig/scripting/impl/xul/thing.xml"));

		JFrame frame = new JFrame("TEST JScriptableThinlet");

		frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

		frame.setLayout(new BorderLayout());

		frame.setSize(500, 400);

		// Añadimos el JPanel del thinlet al frame.

		frame.add(panel, BorderLayout.CENTER);

		//frame.pack();

		frame.setVisible(true);

	}

}

package org.gvsig.scripting.impl;

import java.awt.BorderLayout;

import javax.swing.JFrame;

import org.gvsig.scripting.swing.impl.DefaultJThinG;

public class MyTestDefaultJThinG {

	public static void main(String[] args) {

		// Creamos el JPanel del thinlet y le

		// cargamos el xml de pruebas.

		DefaultJThinG panel = new DefaultJThinG();

		JFrame frame = new JFrame("TEST JScriptableThinlet");

		frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

		frame.setLayout(new BorderLayout());

		frame.setSize(500, 400);

		// Añadimos el JPanel del thinlet al frame.

		frame.add(panel, BorderLayout.CENTER);

		frame.pack();

		frame.setVisible(true);

	}

}

package org.gvsig.scripting;

import java.awt.BorderLayout;

import javax.swing.JFrame;

import org.gvsig.scripting.swing.impl.DefaultJThinG;

public class MyTestJScriptableThinG {

	public static void main(String[] args) {

		// Creamos el JPanel del thinlet y le

		// cargamos el xml de pruebas.

		DefaultJThinG panel = new DefaultJThinG();

		JFrame frame = new JFrame("TEST JScriptableThinlet");

		frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

		frame.setLayout(new BorderLayout());

		frame.setSize(500, 400);

		// Añadimos el JPanel del thinlet al frame.

		frame.add(panel, BorderLayout.CENTER);

		//frame.pack();

		frame.setVisible(true);

	}

}

package org.gvsig.scripting;

import java.awt.BorderLayout;

import java.awt.Dimension;

import javax.swing.JFrame;

import javax.swing.JPanel;

import org.gvsig.scripting.swing.api.ScriptingSwingLocator;

import org.gvsig.scripting.swing.api.ScriptingUIManager;

import org.gvsig.scripting.swing.impl.DefaultJScriptingBrowser;

public class MyTestJScriptingBrowser extends JPanel {

	/**

	 * 

	 */

	private static final long serialVersionUID = 1L;

	private DefaultJScriptingBrowser treePanel;

	public MyTestJScriptingBrowser() {