org.gvsig.scripting.swing.api

Interface ScriptingUIManager

All Superinterfaces:

ScriptSwingManager

All Known Implementing Classes:

DefaultScriptingUIManager

public interface ScriptingUIManager
extends ScriptSwingManager

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 Also:

ScriptingManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ScriptingUIManager.MenuEntry

Nested classes/interfaces inherited from interface org.gvsig.tools.swing.api.script.ScriptSwingManager

ScriptSwingManager.ScriptChooserPanel, ScriptSwingManager.ScriptEditor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCRIPT_COMPOSER_AUTORUN

Method Summary

Modifier and Type	Method and Description
void	addComposerMenu(java.lang.String text, javax.swing.Action action)
void	addComposerTool(javax.swing.Action action)
void	addCreatedComponentListener(CreateComponentListener listener)
JScriptingBrowser	createBrowser(ScriptingFolder root) Creates a new JScriptingBrowser component.
JScriptingBrowser	createBrowser(ScriptingFolder root, boolean foldersOnly) Creates a new JScriptingBrowser component.
JScriptingComposer	createComposer() Creates a new JScriptingComposer component.
JEditor	createEditor(ScriptingUnit unit) Creates a JEditor for the scripting unit passed as parameter.
javax.swing.JPanel	createInstaller() Creates a new JScriptingInstaller component.
JCodeEditor	createJCodeEditor(ScriptingScript script) Creates a new JCodeEditor component.
JDialogEditor	createJDialogEditor(ScriptingDialog script) Creates a new JDialogEditor component.
JScriptingConsole	createJScriptingConsole()
JScriptingConsole	createJScriptingConsole(boolean captureOutput)
JThinG	createJThinG() Creates a new JThinG component.
JThinlet	createJThinlet() Creates a new JThinlet component.
JScriptingLauncher	createLauncher() Creates a new JScriptingLauncher component.
SyntaxtHighlightTextComponent	createSyntaxHighlightingPanel() Creates a new JEditorPane component with syntax highlight.
AboutManager	getAboutManager() Returns the AboutManager to provide services of the 'About Us' information of the ScriptingFramework.
JScriptingComposer	getActiveComposer()
java.util.Collection<ScriptingUIManager.MenuEntry>	getComposerMenus()
java.util.Collection<javax.swing.Action>	getComposerTools()
java.util.List<EditorFactory>	getEditorFactories()
javax.swing.ImageIcon	getIcon(java.lang.String name) Returns a ImageIcon associated with the name.
javax.swing.ImageIcon	getIcon(java.lang.String name, java.lang.String size) Returns a ImageIcon associated with the name.
ScriptingManager	getManager() Returns the ScriptingManager of the ScriptingFramework.
java.lang.String	getTranslation(java.lang.String key)
WindowManager	getWindowManager()
boolean	hasEditor(ScriptingUnit unit)
void	registerEditor(EditorFactory factory)
void	removeCreatedComponentListener(CreateComponentListener listener)
void	setWindowManager(WindowManager windowsManager)
void	showDialog(javax.swing.JComponent panel, java.lang.String title) Shows a JPanel in a dialog window with it's own characteristics
void	showTool(javax.swing.JComponent panel, java.lang.String title) Shows a JPanel in a tool window with it's own characteristics
void	showWindow(javax.swing.JComponent panel, java.lang.String title) Shows a JPanel in a window with it's own characteristics

Methods inherited from interface org.gvsig.tools.swing.api.script.ScriptSwingManager

createListScriptPickerController, createListScriptPickerController, createScriptChooserPanel, createScriptEditor, createScriptPickerController

Field Detail

SCRIPT_COMPOSER_AUTORUN

static final java.lang.String SCRIPT_COMPOSER_AUTORUN

See Also:

Constant Field Values

Method Detail

createLauncher

JScriptingLauncher createLauncher()

Creates a new JScriptingLauncher component.

Returns:

a new JScriptingLauncher.

See Also:

JScriptingLauncher

createComposer

JScriptingComposer createComposer()

Creates a new JScriptingComposer component.

Returns:

a new JScriptingComposer.

See Also:

JScriptingComposer

createBrowser

JScriptingBrowser createBrowser(ScriptingFolder root,
                                boolean foldersOnly)

Creates a new JScriptingBrowser component.

Parameters:

root - ScriptingFolder that identificates the image.

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

Returns:

a new JScriptingBrowser.

See Also:

JScriptingBrowser

createBrowser

JScriptingBrowser createBrowser(ScriptingFolder root)

Creates a new JScriptingBrowser component.

Parameters:

root - ScriptingFolder that identificates the image.

Returns:

a new JScriptingBrowser.

See Also:

JScriptingBrowser

createInstaller

javax.swing.JPanel createInstaller()

Creates a new JScriptingInstaller component.

Returns:

a new JScriptingInstaller.

See Also:

JScriptingInstaller

createSyntaxHighlightingPanel

SyntaxtHighlightTextComponent createSyntaxHighlightingPanel()

Creates a new JEditorPane component with syntax highlight.

Returns:

a new JEditorPaneSyntaxHighlighting.

See Also:

JEditorPaneSyntaxHighlighting

createJCodeEditor

JCodeEditor createJCodeEditor(ScriptingScript script)

Creates a new JCodeEditor component.

Parameters:

script -

Returns:

a new JCodeEditor.

See Also:

JCodeEditor

createJDialogEditor

JDialogEditor createJDialogEditor(ScriptingDialog script)

Creates a new JDialogEditor component.

Parameters:

uimanager -

script -

Returns:

a new JDialogEditor.

See Also:

JDialogEditor

createJThinlet

JThinlet createJThinlet()

Creates a new JThinlet component.

Returns:

a new JThinlet.

See Also:

JThinlet

createJThinG

JThinG createJThinG()

Creates a new JThinG component.

Returns:

a new JThinG.

See Also:

JThinG

createEditor

JEditor createEditor(ScriptingUnit unit)

Creates a JEditor for the scripting unit passed as parameter. Return null if not exists an editor for this unit.

Parameters:

unit -

Returns:

getIcon

javax.swing.ImageIcon getIcon(java.lang.String name)

Returns a ImageIcon associated with the name.

Parameters:

name - String that identificates the image.

Returns:

the ImageIcon identified by the String name.

getIcon

javax.swing.ImageIcon getIcon(java.lang.String name,
                              java.lang.String size)

Returns a ImageIcon associated with the name.

Parameters:

name - String that identificates the image.

size - String to specify if the size of the icon would be "small", "medium" or "big" (default value: "small").

Returns:

the ImageIcon identified by the String name.

getManager

ScriptingManager getManager()

Returns the ScriptingManager of the ScriptingFramework.

Returns:

ScriptingManager

getAboutManager

AboutManager getAboutManager()

Returns the AboutManager to provide services of the 'About Us' information of the ScriptingFramework.

Returns:

the AboutManager

See Also:

AboutManager

showDialog

void showDialog(javax.swing.JComponent panel,
                java.lang.String title)

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

Parameters:

panel - JPanel included in the dialog's content

title - String with the dialog's title

showWindow

void showWindow(javax.swing.JComponent panel,
                java.lang.String title)

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

Parameters:

panel - JPanel included in the window's content

title - String with the window's title

showTool

void showTool(javax.swing.JComponent panel,
              java.lang.String title)

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

Parameters:

panel - JPanel included in the tool's content

title - String with the tool's title

getTranslation

java.lang.String getTranslation(java.lang.String key)

setWindowManager

void setWindowManager(WindowManager windowsManager)

getWindowManager

WindowManager getWindowManager()

createJScriptingConsole

JScriptingConsole createJScriptingConsole()

createJScriptingConsole

JScriptingConsole createJScriptingConsole(boolean captureOutput)

addComposerTool

void addComposerTool(javax.swing.Action action)

addComposerMenu

void addComposerMenu(java.lang.String text,
                     javax.swing.Action action)

getComposerTools

java.util.Collection<javax.swing.Action> getComposerTools()

getComposerMenus

java.util.Collection<ScriptingUIManager.MenuEntry> getComposerMenus()

getActiveComposer

JScriptingComposer getActiveComposer()

addCreatedComponentListener

void addCreatedComponentListener(CreateComponentListener listener)

removeCreatedComponentListener

void removeCreatedComponentListener(CreateComponentListener listener)

registerEditor

void registerEditor(EditorFactory factory)

hasEditor

boolean hasEditor(ScriptingUnit unit)

getEditorFactories

java.util.List<EditorFactory> getEditorFactories()