Package org.gvsig.scripting.swing.api

Interface ScriptingUIManager

All Superinterfaces:
org.gvsig.tools.swing.api.script.ScriptSwingManager
public interface ScriptingUIManager extends org.gvsig.tools.swing.api.script.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:

  • Field Details

  • Method Details

    • createLauncher

      JScriptingLauncher createLauncher()
      Creates a new JScriptingLauncher component.
      Returns:
      a new JScriptingLauncher.
      See Also:

    • createComposer

      JScriptingComposer createComposer()
      Creates a new JScriptingComposer component.
      Returns:
      a new JScriptingComposer.
      See Also:

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

    • createBrowser

      JScriptingBrowser createBrowser(ScriptingFolder root)
      Creates a new JScriptingBrowser component.
      Parameters:
      root - ScriptingFolder that identificates the image.
      Returns:
      a new JScriptingBrowser.
      See Also:

    • createInstaller

      JPanel createInstaller()
      Creates a new
      invalid reference 
      JScriptingInstaller
      component.
      Returns:
      a new
      invalid reference 
      JScriptingInstaller
      .
      See Also:
      • invalid reference 
        JScriptingInstaller

    • createSyntaxHighlightingPanel

      SyntaxtHighlightTextComponent createSyntaxHighlightingPanel()
      Creates a new JEditorPane component with syntax highlight.
      Returns:
      a new
      invalid reference 
      JEditorPaneSyntaxHighlighting
      .
      See Also:
      • invalid reference 
        JEditorPaneSyntaxHighlighting

    • createJCodeEditor

      JCodeEditor createJCodeEditor(ScriptingScript script)
      Creates a new JCodeEditor component.
      Parameters:
      script -
      Returns:
      a new JCodeEditor.
      See Also:

    • createJDialogEditor

      JDialogEditor createJDialogEditor(ScriptingDialog script)
      Creates a new JDialogEditor component.
      Parameters:
      script -
      uimanager -
      Returns:
      a new JDialogEditor.
      See Also:

    • createJThinlet

      JThinlet createJThinlet()
      Creates a new JThinlet component.
      Returns:
      a new JThinlet.
      See Also:

    • createJThinG

      JThinG createJThinG()
      Creates a new JThinG component.
      Returns:
      a new JThinG.
      See Also:

    • 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

      ImageIcon getIcon(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

      ImageIcon getIcon(String name, 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

      org.gvsig.about.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(JComponent panel, 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(JComponent panel, 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(JComponent panel, 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

      String getTranslation(String key)

    • setWindowManager

      void setWindowManager(org.gvsig.tools.swing.api.windowmanager.WindowManager windowsManager)

    • getWindowManager

      org.gvsig.tools.swing.api.windowmanager.WindowManager getWindowManager()

    • createJScriptingConsole

      JScriptingConsole createJScriptingConsole()

    • createJScriptingConsole

      JScriptingConsole createJScriptingConsole(boolean captureOutput)

    • addComposerTool

      void addComposerTool(Action action)

    • addComposerMenu

      void addComposerMenu(String text, Action action)

    • getComposerTools

      Collection<Action> getComposerTools()

    • getComposerMenus

      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

      List<EditorFactory> getEditorFactories()