net.sf.gridarta.textedit.scripteditor

Class ScriptEditControl

java.lang.Object

net.sf.gridarta.textedit.scripteditor.ScriptEditControl

All Implemented Interfaces:

EditorAction

public class ScriptEditControl
extends java.lang.Object
implements EditorAction

ScriptEditControl - Manages events and data flow for the script editor entity. There's always at most only one frame open. Additional files get attached to the tab bar.

Constructor Summary

Constructors

Constructor and Description
ScriptEditControl(javax.swing.filechooser.FileFilter scriptFileFilter, java.lang.String scriptSuffix, java.awt.Frame owner, java.io.File defaultScriptDir, java.util.prefs.Preferences preferences, Exiter exiter)

Method Summary

Modifier and Type	Method and Description
boolean	closeActiveTab() Close the active script-tab.
boolean	closeAllTabs() Close all opened script-tabs.
void	newScript() Open a new empty script document.
void	openScriptFile(java.lang.String pathName) Open a new empty script document.
void	openUser() Open a file which is chosen by the user.
static void	registerActivePopup(CFPythonPopup activePopup) Register last active popup.
void	saveActiveTab() Save the active script-tab to the stored file path.
void	saveAsActiveTab() Open a file browser and prompt the user for a location/name to store this file.
boolean	saveTextToFile(java.io.File file, java.lang.String text) Write the given text into the specified file.
void	setAction(javax.swing.Action action, java.lang.String name) Sets the Action instance for this editor action.
void	setTextAreaDefaults(TextAreaDefaults textAreaDefaults) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptEditControl

public ScriptEditControl(@NotNull
                         javax.swing.filechooser.FileFilter scriptFileFilter,
                         @NotNull
                         java.lang.String scriptSuffix,
                         @NotNull
                         java.awt.Frame owner,
                         java.io.File defaultScriptDir,
                         @NotNull
                         java.util.prefs.Preferences preferences,
                         @NotNull
                         Exiter exiter)

Method Detail

setTextAreaDefaults

@Deprecated
public void setTextAreaDefaults(@NotNull
                                            TextAreaDefaults textAreaDefaults)

Deprecated.

registerActivePopup

public static void registerActivePopup(@NotNull
                                       CFPythonPopup activePopup)

Register last active popup. When the script pad frame is hidden, this popup will be closed (if still open).

Parameters:

activePopup - active popup to register

newScript

@ActionMethod
public void newScript()

Open a new empty script document.

openScriptFile

public void openScriptFile(@NotNull
                           java.lang.String pathName)

Open a new empty script document.

openUser

public void openUser()

Open a file which is chosen by the user.

closeActiveTab

public boolean closeActiveTab()

Close the active script-tab.

Returns:

true if the tab was closed, or false if the user has canceled

closeAllTabs

public boolean closeAllTabs()

Close all opened script-tabs.

Returns:

true if all tabs have been closed, or false if the user has canceled.

saveAsActiveTab

public void saveAsActiveTab()

Open a file browser and prompt the user for a location/name to store this file. If everything goes fine, the file is saved.

saveActiveTab

public void saveActiveTab()

Save the active script-tab to the stored file path.

saveTextToFile

public boolean saveTextToFile(@NotNull
                              java.io.File file,
                              @NotNull
                              java.lang.String text)

Write the given text into the specified file.

Parameters:

file - text gets saved into this file

text - text to be saved

Returns:

true if the file was saved, or false if an error occurred

setAction

public void setAction(@NotNull
                      javax.swing.Action action,
                      @NotNull
                      java.lang.String name)

Sets the Action instance for this editor action.

Specified by:

setAction in interface EditorAction

Parameters:

action - the action instance

name - the name of the action