ScriptEditControl - Manages events and data flow for the script editor entity. More...

Inheritance diagram for net.sf.gridarta.textedit.scripteditor.ScriptEditControl:

Collaboration diagram for net.sf.gridarta.textedit.scripteditor.ScriptEditControl:

Public Member Functions
boolean	closeActiveTab ()
	Close the active script-tab. More...

boolean	closeAllTabs ()
	Close all opened script-tabs. More...

void	newScript ()
	Open a new empty script document. More...

void	openScriptFile (@NotNull final File file)
	Opens a script file. More...

void	openUser ()
	Open a file which is chosen by the user. More...

void	saveActiveTab ()
	Save the active script-tab to the stored file path. More...

void	saveAsActiveTab ()
	Open a file browser and prompt the user for a location/name to store this file. More...

	ScriptEditControl (@NotNull final FileFilter scriptFileFilter, @NotNull final String scriptSuffix, @NotNull final Frame owner, final File defaultScriptDir, @NotNull final Preferences preferences, @NotNull final Exiter exiter, @NotNull final AppPreferencesModel appPreferencesModel, @NotNull final ScriptEditControlCallback callback)

void	setAction (@NotNull final Action action, @NotNull final String name)
	Sets the Action instance for this editor action. More...

void	setTextAreaDefaults (@NotNull final TextAreaDefaults textAreaDefaults)

Static Public Member Functions
static void	registerActivePopup (@NotNull final CFPythonPopup activePopup)
	Register last active popup. More...

Package Functions
String	getActiveFilePath ()

JEditTextArea	getActiveTextArea ()

Private Member Functions
JFileChooser	createOpenFileChooser (@NotNull final File defaultScriptDir)
	Creates the JFileChooser for opening a script file. More...

boolean	saveTextToFile (@NotNull final File file, @NotNull final String text)
	Write the given text into the specified file. More...

Private Attributes
final AppPreferencesModel	appPreferencesModel
	The global AppPreferencesModel instance. More...

final ScriptEditControlCallback	callback
	The callback function for reporting problems when starting an external editor. More...

final JFileChooser	openFileChooser
	JFileChooser for opening script files. More...

final FileFilter	scriptFileFilter

final String	scriptSuffix

final List< String >	tabs

final ScriptEditView	view

Static Private Attributes
static final ActionBuilder	ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")
	Action Builder. More...

static CFPythonPopup	activePopup
	The currently active popup. More...

static final Category	LOG = Logger.getLogger(ScriptEditControl.class)
	The Logger for printing log messages. More...

Detailed Description

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.

Author: Andreas Vogl

Definition at line 59 of file ScriptEditControl.java.

Constructor & Destructor Documentation

◆ ScriptEditControl()

net.sf.gridarta.textedit.scripteditor.ScriptEditControl.ScriptEditControl	(	@NotNull final FileFilter	scriptFileFilter,
		@NotNull final String	scriptSuffix,
		@NotNull final Frame	owner,
		final File	defaultScriptDir,
		@NotNull final Preferences	preferences,
		@NotNull final Exiter	exiter,
		@NotNull final AppPreferencesModel	appPreferencesModel,
		@NotNull final ScriptEditControlCallback	callback
	)

Parameters

appPreferencesModel	the global AppPreferencesModel instance
callback	the callback function for reporting problems when starting an external editor

Definition at line 118 of file ScriptEditControl.java.

Here is the call graph for this function:

Member Function Documentation

◆ closeActiveTab()

boolean net.sf.gridarta.textedit.scripteditor.ScriptEditControl.closeActiveTab ( )

Close the active script-tab.

Returns: true

if the tab was closed, or
false

if the user has canceled

Definition at line 276 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.closeAllTabs(), and net.sf.gridarta.textedit.scripteditor.Actions.scriptEditClose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ closeAllTabs()

boolean net.sf.gridarta.textedit.scripteditor.ScriptEditControl.closeAllTabs ( )

Close all opened script-tabs.

Returns: true

if all tabs have been closed, or
false

if the user has canceled.

Definition at line 307 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditControl.closeActiveTab(), net.sf.gridarta.textedit.scripteditor.ScriptEditView.getSelectedIndex(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.tabs, and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.view.

Referenced by net.sf.gridarta.action.ExitAction.canExit(), net.sf.gridarta.textedit.scripteditor.Actions.scriptEditCloseAll(), net.sf.gridarta.textedit.scripteditor.EditWindowListener.windowClosed(), and net.sf.gridarta.textedit.scripteditor.EditWindowListener.windowClosing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createOpenFileChooser()

JFileChooser net.sf.gridarta.textedit.scripteditor.ScriptEditControl.createOpenFileChooser ( @NotNull final File defaultScriptDir )

private

Creates the JFileChooser for opening a script file.

Parameters

defaultScriptDir the initial directory for the file chooser; will be ignored if invalid

Returns: the file chooser

Definition at line 234 of file ScriptEditControl.java.

References net.sf.gridarta.utils.FileChooserUtils.sanitizeCurrentDirectory(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.scriptFileFilter, and net.sf.gridarta.utils.FileChooserUtils.setCurrentDirectory().

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.ScriptEditControl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveFilePath()

String net.sf.gridarta.textedit.scripteditor.ScriptEditControl.getActiveFilePath ( )

package

Returns: file path of active tab, null if no path is available

Definition at line 426 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditView.getSelectedIndex(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.tabs, and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.view.

Referenced by net.sf.gridarta.textedit.scripteditor.Actions.refresh(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveActiveTab(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveAsActiveTab().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveTextArea()

JEditTextArea net.sf.gridarta.textedit.scripteditor.ScriptEditControl.getActiveTextArea ( )

package

Returns: currently active JEditTextArea, or null if none are open

Definition at line 418 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditView.getActiveTextArea(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.view.

Referenced by net.sf.gridarta.textedit.scripteditor.CFPythonPopup.MenuActionListener.actionPerformed(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.closeActiveTab(), net.sf.gridarta.textedit.scripteditor.Actions.executeAction(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveActiveTab(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveAsActiveTab().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ newScript()

void net.sf.gridarta.textedit.scripteditor.ScriptEditControl.newScript ( )

Open a new empty script document.

Definition at line 146 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditView.addTab(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.tabs, and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.view.

Referenced by net.sf.gridarta.gui.misc.DefaultFileControl< G, A, R >.openFile(), net.sf.gridarta.maincontrol.GUIMainControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.openFile(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openUser(), and net.sf.gridarta.textedit.scripteditor.Actions.scriptEditNewScript().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openScriptFile()

void net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openScriptFile ( @NotNull final File file )

Opens a script file.

Parameters

file	the script file to open

Definition at line 155 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditView.addTab(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.appPreferencesModel, net.sf.gridarta.textedit.scripteditor.ScriptEditControl.callback, editor, net.sf.gridarta.utils.AppPreferencesModel.getEditor(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.LOG, net.sf.gridarta.utils.AppPreferencesModel.splitCommand(), net.sf.gridarta.textedit.scripteditor.ScriptEditControlCallback.statusMessage(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.tabs, and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.view.

Referenced by net.sf.gridarta.gui.scripts.ScriptArchEditor< G, A, R >.createNewEvent(), net.sf.gridarta.gui.misc.DefaultFileControl< G, A, R >.openFile(), net.sf.gridarta.maincontrol.GUIMainControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.openFile(), net.sf.gridarta.gui.scripts.ScriptedEventEditor< net.sf.gridarta.var.daimonin.model.gameobject.GameObject, net.sf.gridarta.var.daimonin.model.maparchobject.MapArchObject, net.sf.gridarta.var.daimonin.model.archetype.Archetype >.openScript(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openUser()

void net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openUser ( )

Open a file which is chosen by the user.

Definition at line 252 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditControl.newScript(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openFileChooser, net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openScriptFile(), net.sf.gridarta.utils.FileChooserUtils.sanitizeCurrentDirectory(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.view.

Referenced by net.sf.gridarta.textedit.scripteditor.Actions.scriptEditOpen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerActivePopup()

static void net.sf.gridarta.textedit.scripteditor.ScriptEditControl.registerActivePopup ( @NotNull final CFPythonPopup activePopup )

static

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

Definition at line 138 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditControl.activePopup.

Referenced by net.sf.gridarta.textedit.scripteditor.CFPythonPopup.setCaretPosition().

Here is the caller graph for this function:

◆ saveActiveTab()

void net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveActiveTab ( )

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

Definition at line 377 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditControl.getActiveFilePath(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.getActiveTextArea(), net.sf.gridarta.textedit.textarea.JEditTextArea.getText(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.LOG, net.sf.gridarta.textedit.textarea.JEditTextArea.resetModified(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveAsActiveTab(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveTextToFile().

Referenced by net.sf.gridarta.textedit.textarea.actions.Save.actionPerformed(), and net.sf.gridarta.textedit.scripteditor.Actions.scriptEditSave().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAsActiveTab()

void net.sf.gridarta.textedit.scripteditor.ScriptEditControl.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.

Definition at line 321 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveActiveTab(), and net.sf.gridarta.textedit.scripteditor.Actions.scriptEditSaveAs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveTextToFile()

boolean net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveTextToFile	(	@NotNull final File	file,
		@NotNull final String	text
	)

private

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

Definition at line 398 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditView.showMessage(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.view.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveActiveTab(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveAsActiveTab().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAction()

void net.sf.gridarta.textedit.scripteditor.ScriptEditControl.setAction	(	@NotNull final Action	action,
		@NotNull final String	name
	)

Sets the Action instance for this editor action.

Parameters

action	the action instance
name	the name of the action

Implements net.sf.gridarta.utils.EditorAction.

Definition at line 438 of file ScriptEditControl.java.

◆ setTextAreaDefaults()

void net.sf.gridarta.textedit.scripteditor.ScriptEditControl.setTextAreaDefaults ( @NotNull final TextAreaDefaults textAreaDefaults )

Definition at line 129 of file ScriptEditControl.java.

References net.sf.gridarta.textedit.scripteditor.ScriptEditView.setTextAreaDefaults(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.view.

Referenced by net.sf.gridarta.maincontrol.GUIMainControl< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.GUIMainControl().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ ACTION_BUILDER

final ActionBuilder net.sf.gridarta.textedit.scripteditor.ScriptEditControl.ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta")

staticprivate

Action Builder.

Definition at line 71 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.closeActiveTab().

◆ activePopup

CFPythonPopup net.sf.gridarta.textedit.scripteditor.ScriptEditControl.activePopup

staticprivate

The currently active popup.

Set to

null

if none has been opened yet.

Definition at line 79 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.closeActiveTab(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.registerActivePopup().

◆ appPreferencesModel

final AppPreferencesModel net.sf.gridarta.textedit.scripteditor.ScriptEditControl.appPreferencesModel

private

The global AppPreferencesModel instance.

Definition at line 103 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openScriptFile(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.ScriptEditControl().

◆ callback

final ScriptEditControlCallback net.sf.gridarta.textedit.scripteditor.ScriptEditControl.callback

private

The callback function for reporting problems when starting an external editor.

Definition at line 110 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openScriptFile(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.ScriptEditControl().

◆ LOG

final Category net.sf.gridarta.textedit.scripteditor.ScriptEditControl.LOG = Logger.getLogger(ScriptEditControl.class)

staticprivate

The Logger for printing log messages.

Definition at line 65 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openScriptFile(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveActiveTab().

◆ openFileChooser

final JFileChooser net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openFileChooser

private

JFileChooser for opening script files.

Definition at line 91 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openUser(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveAsActiveTab(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.ScriptEditControl().

◆ scriptFileFilter

final FileFilter net.sf.gridarta.textedit.scripteditor.ScriptEditControl.scriptFileFilter

private

Definition at line 94 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.createOpenFileChooser(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.ScriptEditControl().

◆ scriptSuffix

final String net.sf.gridarta.textedit.scripteditor.ScriptEditControl.scriptSuffix

private

Definition at line 97 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveAsActiveTab(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.ScriptEditControl().

◆ tabs

final List<String> net.sf.gridarta.textedit.scripteditor.ScriptEditControl.tabs

private

Definition at line 85 of file ScriptEditControl.java.

Referenced by net.sf.gridarta.textedit.scripteditor.ScriptEditControl.closeActiveTab(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.closeAllTabs(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.getActiveFilePath(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.newScript(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.openScriptFile(), net.sf.gridarta.textedit.scripteditor.ScriptEditControl.saveAsActiveTab(), and net.sf.gridarta.textedit.scripteditor.ScriptEditControl.ScriptEditControl().

◆ view

final ScriptEditView net.sf.gridarta.textedit.scripteditor.ScriptEditControl.view

private

Definition at line 82 of file ScriptEditControl.java.

The documentation for this class was generated from the following file:

src/textedit/src/main/java/net/sf/gridarta/textedit/scripteditor/ScriptEditControl.java

Public Member Functions

Static Public Member Functions

Package Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ScriptEditControl()

Member Function Documentation

◆ closeActiveTab()

◆ closeAllTabs()

◆ createOpenFileChooser()

◆ getActiveFilePath()

◆ getActiveTextArea()

◆ newScript()

◆ openScriptFile()

◆ openUser()

◆ registerActivePopup()

◆ saveActiveTab()

◆ saveAsActiveTab()

◆ saveTextToFile()

◆ setAction()

◆ setTextAreaDefaults()

Member Data Documentation

◆ ACTION_BUILDER

◆ activePopup

◆ appPreferencesModel

◆ callback

◆ LOG

◆ openFileChooser

◆ scriptFileFilter

◆ scriptSuffix

◆ tabs

◆ view