com.inductiveautomation.ignition.designer.scripteditor.workspace

Class ScriptWorkspace

java.lang.Object

com.inductiveautomation.ignition.designer.scripteditor.workspace.ScriptWorkspace

All Implemented Interfaces:

ResourceWorkspace

public class ScriptWorkspace
extends java.lang.Object
implements ResourceWorkspace

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ScriptWorkspace(DesignerContext context)

Method Summary

Modifier and Type	Method and Description
void	addWorkspaceChangeListener(ScriptWorkspaceListener listener)
void	closeScript(java.lang.String resourceType, long resourceId)
void	fireSelectionChange(ScriptTab tab)
void	fireSelectionChange(java.lang.String type, java.lang.Long id)
void	floatTab(ScriptTab tab) Pushes a tab from the workspace and puts it in the editing frame
DesignerContext	getDesignerContext()
EditActionHandler	getEditActionHandler() The handler that responds to common edit actions, like cut, copy, paste, and delete
int	getFloatingTabCount()
java.util.Collection<ResourceWorkspaceFrame>	getFrames() Returns a collection of ResourceWorkspaceFrames that will be associated with this workspace.
java.lang.String	getKey() Returns a keyname for the workspace.
MenuBarMerge	getMenu() Returns a menu merge for the menu options that should be present when this workspace is active.
java.util.List<com.jidesoft.action.CommandBar>	getToolbars() Returns the toolbars that will be added when this workspace is active.
javax.swing.JComponent	getWorkspace() The component that makes up the workspace itself.
boolean	isActive()
boolean	isFrameEditorOpen()
boolean	isScriptOpen(java.lang.String type, long id)
void	notifyTabClosed(ScriptTab tab) Called from the editors when a tab has been closed.
void	onActivation() Called when the resource workspace will become the active workspace and will be displayed.
void	onDeactivation() Called when the resource workspace will be swapped out for a different workspace.
void	openScript(java.lang.String type, long id)
void	refreshSelectedScripts()
void	removeWorkspaceChangeListener(ScriptWorkspaceListener listener)
void	resetFrames(com.jidesoft.docking.DockingManager dockingManager, com.jidesoft.action.DockableBarManager barManager) Programmatically set the options on the frames and bars that represent the workspace's "defaults"
void	save(ScriptTab tab) Updates the project resource for this script tab, serializing the script and updating the lock
void	saveAll()
void	selectFrameEditor()
void	selectScript(java.lang.String type, long id)
void	shutdown()
void	unFloatTab(ScriptTab tab) Pulls a tab from the floating editing frame and puts it in the workspace

Methods inherited from class java.lang.Object

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

Field Detail

SCRIPT_WORKSPACE_KEY

public static final java.lang.String SCRIPT_WORKSPACE_KEY

See Also:

Constant Field Values

Constructor Detail

ScriptWorkspace

public ScriptWorkspace(DesignerContext context)

Method Detail

getWorkspace

public javax.swing.JComponent getWorkspace()

Description copied from interface: ResourceWorkspace

The component that makes up the workspace itself. Must not be null

Specified by:

getWorkspace in interface ResourceWorkspace

getKey

public java.lang.String getKey()

Description copied from interface: ResourceWorkspace

Returns a keyname for the workspace. Used by nav tree nodes to specify which workspace to switch to when they are selected.

Specified by:

getKey in interface ResourceWorkspace

getMenu

public MenuBarMerge getMenu()

Description copied from interface: ResourceWorkspace

Returns a menu merge for the menu options that should be present when this workspace is active. May be null.

Specified by:

getMenu in interface ResourceWorkspace

getToolbars

public java.util.List<com.jidesoft.action.CommandBar> getToolbars()

Description copied from interface: ResourceWorkspace

Returns the toolbars that will be added when this workspace is active. May be null or empty.

Specified by:

getToolbars in interface ResourceWorkspace

getFrames

public java.util.Collection<ResourceWorkspaceFrame> getFrames()

Description copied from interface: ResourceWorkspace

Returns a collection of ResourceWorkspaceFrames that will be associated with this workspace. May be null or empty.

Specified by:

getFrames in interface ResourceWorkspace

getEditActionHandler

public EditActionHandler getEditActionHandler()

Description copied from interface: ResourceWorkspace

The handler that responds to common edit actions, like cut, copy, paste, and delete

Specified by:

getEditActionHandler in interface ResourceWorkspace

resetFrames

public void resetFrames(com.jidesoft.docking.DockingManager dockingManager,
                        com.jidesoft.action.DockableBarManager barManager)

Description copied from interface: ResourceWorkspace

Programmatically set the options on the frames and bars that represent the workspace's "defaults"

Specified by:

resetFrames in interface ResourceWorkspace

onActivation

public void onActivation()

Description copied from interface: ResourceWorkspace

Called when the resource workspace will become the active workspace and will be displayed.

Specified by:

onActivation in interface ResourceWorkspace

onDeactivation

public void onDeactivation()

Description copied from interface: ResourceWorkspace

Called when the resource workspace will be swapped out for a different workspace.

Specified by:

onDeactivation in interface ResourceWorkspace

isActive

public boolean isActive()

isFrameEditorOpen

public boolean isFrameEditorOpen()

unFloatTab

public void unFloatTab(ScriptTab tab)

Pulls a tab from the floating editing frame and puts it in the workspace

floatTab

public void floatTab(ScriptTab tab)

Pushes a tab from the workspace and puts it in the editing frame

openScript

public void openScript(java.lang.String type,
                       long id)

getDesignerContext

public DesignerContext getDesignerContext()

closeScript

public void closeScript(java.lang.String resourceType,
                        long resourceId)

notifyTabClosed

public void notifyTabClosed(ScriptTab tab)

Called from the editors when a tab has been closed. Releases the resource lock

isScriptOpen

public boolean isScriptOpen(java.lang.String type,
                            long id)

selectScript

public void selectScript(java.lang.String type,
                         long id)

save

public void save(ScriptTab tab)

Updates the project resource for this script tab, serializing the script and updating the lock

saveAll

public void saveAll()

refreshSelectedScripts

public void refreshSelectedScripts()

fireSelectionChange

public void fireSelectionChange(ScriptTab tab)

fireSelectionChange

public void fireSelectionChange(java.lang.String type,
                                java.lang.Long id)

addWorkspaceChangeListener

public void addWorkspaceChangeListener(ScriptWorkspaceListener listener)

removeWorkspaceChangeListener

public void removeWorkspaceChangeListener(ScriptWorkspaceListener listener)

shutdown

public void shutdown()

getFloatingTabCount

public int getFloatingTabCount()

selectFrameEditor

public void selectFrameEditor()