DesignerContextImpl (ignition 7.9.5 API)

java.lang.Object
- com.inductiveautomation.ignition.client.model.AbstractClientContext
- - com.inductiveautomation.ignition.designer.DesignerContextImpl

All Implemented Interfaces:

ResourceLockManager, ClientContext, ProjectHolder, BaseContext, DesignerContext, DesignerProjectContext
```
public class DesignerContextImpl
extends AbstractClientContext
implements DesignerContext
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class DesignerContextImpl.DesignerProjectHolderImpl

static class DesignerContextImpl.LockInfo

Nested Classes
Modifier and Type	Class and Description
`class`	`DesignerContextImpl.DesignerProjectHolderImpl`
`static class`	`DesignerContextImpl.LockInfo`

Field Summary

Fields
Modifier and Type Field and Description

protected IgnitionDesigner designerGui
- Fields inherited from class com.inductiveautomation.ignition.client.model.AbstractClientContext
  changeSupport, globalProps, log, loggingManager

Fields
Modifier and Type	Field and Description
`protected IgnitionDesigner`	`designerGui`

Constructor Summary

Constructors
Constructor and Description
`DesignerContextImpl(IgnitionDesigner designerGui, LaunchContext launchContext, Project userProject, Project globalProject)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBeanInfoSearchPath(java.lang.String packageName)` Adds the given fully-qualified path name to the Introspector's BeanInfo search path.
`java.util.UUID`	`addFolder(long newResourceId, java.lang.String moduleId, int scope, java.lang.String folderName, java.util.UUID parent)` Adds a new folder under the given parent.
`void`	`addLegacyScriptNode()` Adds the Legacy Script project node for pre-7.7 script modules that have been imported by the user.
`void`	`addPropertyEditor(java.lang.Class<? extends AbstractPropertyEditorPanel> pageClass)` Adds a property editor page that will be incorporated into the Designer's project property editing system.
`boolean`	`canEditResourceProtection()` Checks whether or not the current logged in user can edit the protection bits of project resources.
`XMLDeserializer`	`createDeserializer()` Returns an instance of the XMLDeserializer that can be used to deserialize project resources.
`FunctionFactory`	`createExpressionFunctionFactory()`
`XMLSerializer`	`createSerializer()` Creates a new XML serializer that has been configured by all installed modules for custom serialization delegates
`void`	`deleteResource(long resourceId)` Removes the resource from the current project
`java.lang.Object`	`deserialize(byte[] data, org.apache.log4j.Logger log)` Convenience function to deserialize a gzipped byte array into a single object.
`void`	`editResourceDocs(ProjectResource resource, ProjectScope scope)` Opens up the resource notes editor for the given project resources
`void`	`exportResources(java.util.Collection<java.lang.Long> resourceIds, ProjectScope scope)` Shows the project export window (after doing a commit) with the given resource IDs checked.
`java.util.Map<java.lang.String,java.lang.String>`	`getClientPermissionBundleKeys()`
`javax.swing.Action`	`getCopyAction()`
`javax.swing.Action`	`getCutAction()`
`javax.swing.Action`	`getDeleteAction()`
`PersistentProperties`	`getDesignerPrefs()` Returns a PersistentProperties file that will be stored on a per-user basis for "persistent" but not project-encapsulated preferences
`com.jidesoft.docking.DockingManager`	`getDockingManager()` Returns the JIDE DockingManager for the Designer
`ExecutionManager`	`getExecutionManager()` Returns the shared task execution manager for this client
`java.awt.Frame`	`getFrame()` Returns the owning frame of the designer.
`DesignerContextImpl.DesignerProjectHolderImpl`	`getGlobalProject()` Returns the project holder for the global project.
`LicenseState`	`getLicenseState(java.lang.String moduleId)` Returns the license state for the given module
`DesignerLocalizationManager`	`getLocalizationManager()`
`ResourceLockManager`	`getLockManager()` The resource lock manager that you must use when opening/editing/closing ProjectResources.
`protected LoggerEx`	`getLogger()`
`java.lang.Object`	`getModule(java.lang.String id)` Returns the hook class for another module, used for modules that deal with each other's models.
`java.util.List<ModuleInfo>`	`getModules()` Retrieve the list of all modules currently loaded in this context
`NamedQueryRpc`	`getNamedQueryRpc()` Returns the appropriate named query rpc for the context.
`OPCBrowserPanel`	`getOPCBrowser()` Returns the OPCBrowserPanel that can be used to browse and import OPC items
`javax.swing.Action`	`getPasteAction()`
`ProjectBrowserRoot`	`getProjectBrowserRoot()` Returns the root node of the project browser tree, so that modules may add their own nodes.
`DesignerContextImpl.DesignerProjectHolderImpl`	`getProjectContext()` Returns the designer project holder for the currently opened project.
`DesignerProjectContext`	`getProjectContext(ProjectScope scope)` Provides a way to get the local or global project scope by ProjectScope enum.
`ProjectVersion`	`getProjectVersion()` What version of the project (staging or published) is this client running?
`protected int`	`getProtectionOptionFromDialog()`
`QueryBrowser`	`getQueryBrowserPanel()` Returns the DB query browser tool
`java.lang.String`	`getResourceCategoryKey(Project project, ProjectResource resource)`
`java.lang.String`	`getResourceDisplayName(Project project, ProjectResource resource)`
`javax.swing.Icon`	`getResourceIcon(Project project, ProjectResource resource)`
`javax.swing.RootPaneContainer`	`getRootPaneContainer()` Returns the RootPaneContainer that is currently the owner of the client
`ProjectScope`	`getScope()`
`ScriptManager`	`getScriptManager()` Returns the ScriptManager that can be used to execute Python scripts.
`java.util.List<SearchProvider>`	`getSearchProviders()`
`SQLTagTreeModel`	`getSQLTagTreeModel()`
`StatusBar`	`getStatusBar()` The StatusBar at the bottom of the Designer can be used to display temporary messages and for adding always-present little components that appear in the bottom-right
`TagBrowserPanel`	`getTagBrowser()` Returns the TagBrowserPanel that can be used to select SQLTags
`TagEditor`	`getTagEditor()` Returns the TagEditorPanel that can be used to edit/add SQLTags
`ClientTagManager`	`getTagManager()` Returns the TagManager that can be used to read,write,browse, and subscribe to SQLTags from this context.
`TagUtilities`	`getTagUtilities()` A class that has some handy functions for dealing with SQLTags
`com.jidesoft.action.DockableBarManager`	`getToolbarManager()` Returns the JIDE dockable toolbar manager
`DesignerContextImpl.DesignerProjectHolderImpl`	`getUserProjectHolder()`
`boolean`	`hasLock(long resourceId)` Checks to see if the given lock is currently held, which means either: it has been obtained but not released (it is open) It has been obtained, modified, and then released, but a save operation has not occurred.
`boolean`	`isLockModified(long resourceId)` Returns true if the lock has been obtained and updated
`boolean`	`isLockOpen(long resourceId)` Returns true if the lock has been obtained and not released
`void`	`moveResource(long resourceId, java.util.UUID newParent)` Moves the resource to a new parent.
`long`	`newResourceId()` Creates and obtains the lock for a new resource id
`void`	`registerClientPermissions(java.util.Map<java.lang.String,java.lang.String> bundleMap)` Register id-bundlekey pairs to limit client permissions
`void`	`registerResourceWorkspace(ResourceWorkspace workspace)` Registers a new `ResourceWorkspace`, which is a main editing area for the designer.
`void`	`registerSearchProvider(SearchProvider provider)` Registers a search provider that will be exposed through the find/replace system.
`void`	`releaseLock(long resourceId)` Designer elements should call this function when they are done with the resource that they obtained a lock for.
`protected void`	`releaseResourceLockFromGateway(long resourceId)`
`boolean`	`requestLock(long resourceId)` Requests the lock for the given resource.
`boolean`	`requestLockQuietly(long resourceId)` Just like requestLock, except that if the lock isn't obtained, no error message is displayed.
`protected void`	`setResourceLockManager(DesignerContextImpl.DesignerProjectHolderImpl userProject)`
`protected void`	`showError(java.lang.Exception e)`
`protected void`	`showError(java.lang.String message)`
`protected void`	`showError(java.lang.String message, java.lang.Exception e)`
`void`	`shutdown()`
`void`	`structuredRename(long resourceId, java.lang.String newName)` Attempts to rename the given project resource, respecting the requirement that the name be unique amongst siblings (with respect to the folder structure)
`void`	`synchLocks()` Attempts to re-obtain all locks that this resource lock manager currently has.
`boolean`	`updateLock(long resourceId)` Designer elements should call this function when they have actually updated the resource with the given ID.
`void`	`updateResource(long id, byte[] data)` Convenience call that updates only the serialized bytes of a project resource, leaving all other parameters intact.
`void`	`updateResource(ProjectResource resource)` Adds or updates the given project resource

Methods inherited from class com.inductiveautomation.ignition.client.model.AbstractClientContext
addProjectChangeListener, addPropertyChangeListener, addPropertyChangeListener, applyDiff, applyGlobalDiff, getAuthProfileName, getCacheDir, getDefaultDatasourceName, getDefaultSQLTagsProviderName, getEventBus, getExpressionFunctionFactory, getGlobalProps, getLaunchContext, getLoggingManager, getProgressManager, getProject, getTagPollRate, getUIEventBus, ph, removeProjectChangeListener, resetExpressionFunctionFactory, setGlobalProjectHolder, setGlobalProps, setProjectHolder, updateGlobalProps, updateProject

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.client.model.ClientContext
addPropertyChangeListener, addPropertyChangeListener, applyGlobalDiff, getAuthProfileName, getCacheDir, getDefaultDatasourceName, getDefaultSQLTagsProviderName, getLaunchContext, getProgressManager, getTagPollRate, getUIEventBus

Methods inherited from interface com.inductiveautomation.ignition.common.model.BaseContext
getEventBus, getExpressionFunctionFactory, getLoggingManager

Methods inherited from interface com.inductiveautomation.ignition.client.model.ProjectHolder
addProjectChangeListener, applyDiff, getProject, removeProjectChangeListener

- Field Detail
  - designerGui
```
protected IgnitionDesigner designerGui
```
- Constructor Detail
  - DesignerContextImpl
```
public DesignerContextImpl(IgnitionDesigner designerGui,
                           LaunchContext launchContext,
                           Project userProject,
                           Project globalProject)
```
- Method Detail
  - getUserProjectHolder
```
public DesignerContextImpl.DesignerProjectHolderImpl getUserProjectHolder()
```
  - getProtectionOptionFromDialog
```
protected int getProtectionOptionFromDialog()
```
  - setResourceLockManager
```
protected void setResourceLockManager(DesignerContextImpl.DesignerProjectHolderImpl userProject)
```
  - getLocalizationManager
```
public DesignerLocalizationManager getLocalizationManager()
```
    Specified by:
    
    getLocalizationManager in interface ClientContext
    
    Specified by:
    
    getLocalizationManager in interface DesignerContext
  - getNamedQueryRpc
```
public NamedQueryRpc getNamedQueryRpc()
```
    Description copied from interface: ClientContext
    
    Returns the appropriate named query rpc for the context. In the gateway and client, we only want to use named queries that have been saved. In the designer, we want to use the current version so that reports and bindings can be seen and used for testing before the project is saved.
    
    Specified by:
    
    getNamedQueryRpc in interface ClientContext
    
    Returns:
    
    The correct NamedQueryRpc implementation for the scope.
  - getProjectContext
```
public DesignerContextImpl.DesignerProjectHolderImpl getProjectContext()
```
    Returns the designer project holder for the currently opened project. Note that for backwards compatibility purposes, DesignerContext is a DesignerProjectContext.
  - getGlobalProject
```
public DesignerContextImpl.DesignerProjectHolderImpl getGlobalProject()
```
    Description copied from interface: DesignerContext
    
    Returns the project holder for the global project. This is where you can put resources that should be shared amongst all projects on the gateway.
    
    Specified by:
    
    getGlobalProject in interface ClientContext
    
    Specified by:
    
    getGlobalProject in interface DesignerContext
    
    Overrides:
    
    getGlobalProject in class AbstractClientContext
  - getProjectContext
```
public DesignerProjectContext getProjectContext(ProjectScope scope)
```
    Description copied from interface: DesignerContext
    
    Provides a way to get the local or global project scope by ProjectScope enum.
    
    Specified by:
    
    getProjectContext in interface DesignerContext
  - getProjectVersion
```
public ProjectVersion getProjectVersion()
```
    Description copied from interface: ClientContext
    
    What version of the project (staging or published) is this client running?
    
    Specified by:
    
    getProjectVersion in interface ClientContext
  - getExecutionManager
```
public ExecutionManager getExecutionManager()
```
    Description copied from interface: ClientContext
    
    Returns the shared task execution manager for this client
    
    Specified by:
    
    getExecutionManager in interface ClientContext
  - getModule
```
public java.lang.Object getModule(java.lang.String id)
```
    Description copied from interface: BaseContext
    
    Returns the hook class for another module, used for modules that deal with each other's models. Example: The reporting plugin's designer hook uses this to get FactoryPMI's palette.
    
    Specified by:
    
    getModule in interface BaseContext
  - getModules
```
public java.util.List<ModuleInfo> getModules()
```
    Description copied from interface: ClientContext
    
    Retrieve the list of all modules currently loaded in this context
    
    Specified by:
    
    getModules in interface ClientContext
  - getLicenseState
```
public LicenseState getLicenseState(java.lang.String moduleId)
```
    Description copied from interface: BaseContext
    
    Returns the license state for the given module
    
    Specified by:
    
    getLicenseState in interface BaseContext
  - exportResources
```
public void exportResources(java.util.Collection<java.lang.Long> resourceIds,
                            ProjectScope scope)
```
    Description copied from interface: DesignerContext
    
    Shows the project export window (after doing a commit) with the given resource IDs checked.
    
    Specified by:
    
    exportResources in interface DesignerContext
  - createExpressionFunctionFactory
```
public FunctionFactory createExpressionFunctionFactory()
```
    Specified by:
    
    createExpressionFunctionFactory in class AbstractClientContext
  - getResourceCategoryKey
```
public java.lang.String getResourceCategoryKey(Project project,
                                               ProjectResource resource)
```
  - getResourceDisplayName
```
public java.lang.String getResourceDisplayName(Project project,
                                               ProjectResource resource)
```
  - getResourceIcon
```
public javax.swing.Icon getResourceIcon(Project project,
                                        ProjectResource resource)
```
  - registerResourceWorkspace
```
public void registerResourceWorkspace(ResourceWorkspace workspace)
```
    Description copied from interface: DesignerContext
    
    Registers a new ResourceWorkspace, which is a main editing area for the designer. The workspace has menus and toolbars associated with it that become visible when the workspace is focused.
    
    Specified by:
    
    registerResourceWorkspace in interface DesignerContext
    
    Parameters:
    
    workspace - The ResourceWorkspace to register with the designer
  - getSearchProviders
```
public java.util.List<SearchProvider> getSearchProviders()
```
    Specified by:
    
    getSearchProviders in interface DesignerContext
  - registerClientPermissions
```
public void registerClientPermissions(java.util.Map<java.lang.String,java.lang.String> bundleMap)
```
    Description copied from interface: DesignerContext
    
    Register id-bundlekey pairs to limit client permissions
    
    Specified by:
    
    registerClientPermissions in interface DesignerContext
    
    Parameters:
    
    bundleMap - Map of ids to bundlekeys. May be null.
  - getClientPermissionBundleKeys
```
public java.util.Map<java.lang.String,java.lang.String> getClientPermissionBundleKeys()
```
    Specified by:
    
    getClientPermissionBundleKeys in interface DesignerContext
  - registerSearchProvider
```
public void registerSearchProvider(SearchProvider provider)
```
    Description copied from interface: DesignerContext
    
    Registers a search provider that will be exposed through the find/replace system.
    
    Specified by:
    
    registerSearchProvider in interface DesignerContext
  - getFrame
```
public java.awt.Frame getFrame()
```
    Description copied from interface: DesignerContext
    
    Returns the owning frame of the designer. Handy for dialog parents
    
    Specified by:
    
    getFrame in interface DesignerContext
  - getCutAction
```
public javax.swing.Action getCutAction()
```
    Specified by:
    
    getCutAction in interface DesignerContext
  - getCopyAction
```
public javax.swing.Action getCopyAction()
```
    Specified by:
    
    getCopyAction in interface DesignerContext
  - getPasteAction
```
public javax.swing.Action getPasteAction()
```
    Specified by:
    
    getPasteAction in interface DesignerContext
  - getDeleteAction
```
public javax.swing.Action getDeleteAction()
```
    Specified by:
    
    getDeleteAction in interface DesignerContext
  - getTagManager
```
public ClientTagManager getTagManager()
```
    Description copied from interface: BaseContext
    
    Returns the TagManager that can be used to read,write,browse, and subscribe to SQLTags from this context.
    
    Specified by:
    
    getTagManager in interface ClientContext
    
    Specified by:
    
    getTagManager in interface BaseContext
  - getSQLTagTreeModel
```
public SQLTagTreeModel getSQLTagTreeModel()
```
    Specified by:
    
    getSQLTagTreeModel in interface DesignerContext
  - addBeanInfoSearchPath
```
public void addBeanInfoSearchPath(java.lang.String packageName)
```
    Description copied from interface: DesignerContext
    
    Adds the given fully-qualified path name to the Introspector's BeanInfo search path. BeanInfos can be important for not only visual beans, but for controlling serialization.
    
    Specified by:
    
    addBeanInfoSearchPath in interface DesignerContext
  - createSerializer
```
public XMLSerializer createSerializer()
```
    Description copied from interface: DesignerContext
    
    Creates a new XML serializer that has been configured by all installed modules for custom serialization delegates
    
    Specified by:
    
    createSerializer in interface DesignerContext
  - createDeserializer
```
public XMLDeserializer createDeserializer()
```
    Description copied from interface: BaseContext
    
    Returns an instance of the XMLDeserializer that can be used to deserialize project resources. Note that this is the only safe way to obtain an instance of XMLDeserializer, because the context will pass the new deserializer around to all loaded modules, giving them a chance to initialize any custom deserialization deletes on it first.
    
    Specified by:
    
    createDeserializer in interface BaseContext
  - getStatusBar
```
public StatusBar getStatusBar()
```
    Description copied from interface: DesignerContext
    
    The StatusBar at the bottom of the Designer can be used to display temporary messages and for adding always-present little components that appear in the bottom-right
    
    Specified by:
    
    getStatusBar in interface DesignerContext
  - getLockManager
```
public ResourceLockManager getLockManager()
```
    Description copied from interface: DesignerContext
    
    The resource lock manager that you must use when opening/editing/closing ProjectResources.
    
    Specified by:
    
    getLockManager in interface DesignerContext
  - shutdown
```
public void shutdown()
```
  - getRootPaneContainer
```
public javax.swing.RootPaneContainer getRootPaneContainer()
```
    Description copied from interface: ClientContext
    
    Returns the RootPaneContainer that is currently the owner of the client
    
    Specified by:
    
    getRootPaneContainer in interface ClientContext
  - getProjectBrowserRoot
```
public ProjectBrowserRoot getProjectBrowserRoot()
```
    Description copied from interface: DesignerContext
    
    Returns the root node of the project browser tree, so that modules may add their own nodes.
    
    Specified by:
    
    getProjectBrowserRoot in interface DesignerContext
    
    See Also:
    
    ProjectBrowserRoot.getGlobalFolder(), ProjectBrowserRoot.getProjectFolder();, AbstractNavTreeNode
  - deserialize
```
public java.lang.Object deserialize(byte[] data,
                                    org.apache.log4j.Logger log)
                             throws SerializationException
```
    Description copied from interface: ClientContext
    
    Convenience function to deserialize a gzipped byte array into a single object. If multiple objects are found, they will be discarded. Warnings are logged to the given logger. If data is null or empty, null is returned.
    
    Specified by:
    
    deserialize in interface ClientContext
    
    Throws:
    
    SerializationException
  - addPropertyEditor
```
public void addPropertyEditor(java.lang.Class<? extends AbstractPropertyEditorPanel> pageClass)
```
    Description copied from interface: DesignerContext
    
    Adds a property editor page that will be incorporated into the Designer's project property editing system. This class will be instantiated the first time that the property editor is displayed, and must have either a nullary constructor or a constructor that takes a DesignerContext.
    
    The Property Editing framework is designed around the idea that modules will store properties in opaquely xml-serialized project resources which can be uniquely identified by their module ID and resource type. The property editing UI will handle the de/serialization and project syncing tasks so that the property editor pages can simply focus on UI.
    
    Specified by:
    
    addPropertyEditor in interface DesignerContext
  - getScriptManager
```
public ScriptManager getScriptManager()
```
    Description copied from interface: BaseContext
    
    Returns the ScriptManager that can be used to execute Python scripts.
    
    Specified by:
    
    getScriptManager in interface BaseContext
  - getDockingManager
```
public com.jidesoft.docking.DockingManager getDockingManager()
```
    Description copied from interface: DesignerContext
    
    Returns the JIDE DockingManager for the Designer
    
    Specified by:
    
    getDockingManager in interface DesignerContext
  - getToolbarManager
```
public com.jidesoft.action.DockableBarManager getToolbarManager()
```
    Description copied from interface: DesignerContext
    
    Returns the JIDE dockable toolbar manager
    
    Specified by:
    
    getToolbarManager in interface DesignerContext
  - getTagEditor
```
public TagEditor getTagEditor()
```
    Description copied from interface: DesignerContext
    
    Returns the TagEditorPanel that can be used to edit/add SQLTags
    
    Specified by:
    
    getTagEditor in interface DesignerContext
  - getTagBrowser
```
public TagBrowserPanel getTagBrowser()
```
    Description copied from interface: DesignerContext
    
    Returns the TagBrowserPanel that can be used to select SQLTags
    
    Specified by:
    
    getTagBrowser in interface DesignerContext
  - getOPCBrowser
```
public OPCBrowserPanel getOPCBrowser()
```
    Description copied from interface: DesignerContext
    
    Returns the OPCBrowserPanel that can be used to browse and import OPC items
    
    Specified by:
    
    getOPCBrowser in interface DesignerContext
  - getQueryBrowserPanel
```
public QueryBrowser getQueryBrowserPanel()
```
    Description copied from interface: DesignerContext
    
    Returns the DB query browser tool
    
    Specified by:
    
    getQueryBrowserPanel in interface DesignerContext
  - getTagUtilities
```
public TagUtilities getTagUtilities()
```
    Description copied from interface: DesignerContext
    
    A class that has some handy functions for dealing with SQLTags
    
    Specified by:
    
    getTagUtilities in interface DesignerContext
  - editResourceDocs
```
public void editResourceDocs(ProjectResource resource,
                             ProjectScope scope)
```
    Description copied from interface: DesignerContext
    
    Opens up the resource notes editor for the given project resources
    
    Specified by:
    
    editResourceDocs in interface DesignerContext
  - getDesignerPrefs
```
public PersistentProperties getDesignerPrefs()
```
    Description copied from interface: DesignerContext
    
    Returns a PersistentProperties file that will be stored on a per-user basis for "persistent" but not project-encapsulated preferences
    
    Specified by:
    
    getDesignerPrefs in interface DesignerContext
  - deleteResource
```
public void deleteResource(long resourceId)
```
    Description copied from interface: DesignerProjectContext
    
    Removes the resource from the current project
    
    Specified by:
    
    deleteResource in interface DesignerProjectContext
  - updateResource
```
public void updateResource(long id,
                           byte[] data)
```
    Description copied from interface: DesignerProjectContext
    
    Convenience call that updates only the serialized bytes of a project resource, leaving all other parameters intact.
    
    Specified by:
    
    updateResource in interface DesignerProjectContext
  - updateResource
```
public void updateResource(ProjectResource resource)
```
    Description copied from interface: DesignerProjectContext
    
    Adds or updates the given project resource
    
    Specified by:
    
    updateResource in interface DesignerProjectContext
  - structuredRename
```
public void structuredRename(long resourceId,
                             java.lang.String newName)
                      throws java.lang.IllegalArgumentException
```
    Description copied from interface: DesignerProjectContext
    
    Attempts to rename the given project resource, respecting the requirement that the name be unique amongst siblings (with respect to the folder structure)
    
    Specified by:
    
    structuredRename in interface DesignerProjectContext
    
    Parameters:
    
    resourceId - The ID of the resource to rename
    
    newName - The new name
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown when the name is not unique.
  - moveResource
```
public void moveResource(long resourceId,
                         java.util.UUID newParent)
```
    Description copied from interface: DesignerProjectContext
    
    Moves the resource to a new parent. If the name is already in use by a child of that parent, the resource will be renamed automatically.
    
    Specified by:
    
    moveResource in interface DesignerProjectContext
  - addFolder
```
public java.util.UUID addFolder(long newResourceId,
                                java.lang.String moduleId,
                                int scope,
                                java.lang.String folderName,
                                java.util.UUID parent)
```
    Description copied from interface: DesignerProjectContext
    
    Adds a new folder under the given parent. If there is already a child with the given name, the name will be automatically modified
    
    Specified by:
    
    addFolder in interface DesignerProjectContext
    
    Returns:
    
    the UUID of the new folder
  - newResourceId
```
public long newResourceId()
                   throws java.lang.Exception
```
    Description copied from interface: ResourceLockManager
    
    Creates and obtains the lock for a new resource id
    
    Specified by:
    
    newResourceId in interface ResourceLockManager
    
    Throws:
    
    java.lang.Exception
  - getScope
```
public ProjectScope getScope()
```
    Specified by:
    
    getScope in interface DesignerProjectContext
  - updateLock
```
public boolean updateLock(long resourceId)
```
    Description copied from interface: ResourceLockManager
    
    Designer elements should call this function when they have actually updated the resource with the given ID. Note that you MUST have the lock before updating the resource!
    
    Specified by:
    
    updateLock in interface ResourceLockManager
    
    Returns:
    
    True if we still have the lock.
  - hasLock
```
public boolean hasLock(long resourceId)
```
    Description copied from interface: ResourceLockManager
    Checks to see if the given lock is currently held, which means either:
    1. it has been obtained but not released (it is open)
    2. It has been obtained, modified, and then released, but a save operation has not occurred.
    Specified by:
    
    hasLock in interface ResourceLockManager
  - isLockModified
```
public boolean isLockModified(long resourceId)
```
    Description copied from interface: ResourceLockManager
    
    Returns true if the lock has been obtained and updated
    
    Specified by:
    
    isLockModified in interface ResourceLockManager
  - isLockOpen
```
public boolean isLockOpen(long resourceId)
```
    Description copied from interface: ResourceLockManager
    
    Returns true if the lock has been obtained and not released
    
    Specified by:
    
    isLockOpen in interface ResourceLockManager
  - releaseLock
```
public void releaseLock(long resourceId)
```
    Description copied from interface: ResourceLockManager
    
    Designer elements should call this function when they are done with the resource that they obtained a lock for. Note that you must have the lock for the resource before releasing it!
    
    Specified by:
    
    releaseLock in interface ResourceLockManager
  - synchLocks
```
public void synchLocks()
```
    Description copied from interface: ResourceLockManager
    
    Attempts to re-obtain all locks that this resource lock manager currently has. Used in situations where the gateway has lost our lock set. (re-connections)
    
    Specified by:
    
    synchLocks in interface ResourceLockManager
  - requestLock
```
public boolean requestLock(long resourceId)
```
    Description copied from interface: ResourceLockManager
    
    Requests the lock for the given resource. If the lock is obtained, true is returned. If the lock isn't able to be obtained, false is returned.
    
    Specified by:
    
    requestLock in interface ResourceLockManager
  - requestLockQuietly
```
public boolean requestLockQuietly(long resourceId)
```
    Description copied from interface: ResourceLockManager
    
    Just like requestLock, except that if the lock isn't obtained, no error message is displayed.
    
    Specified by:
    
    requestLockQuietly in interface ResourceLockManager
  - canEditResourceProtection
```
public boolean canEditResourceProtection()
                                  throws GatewayException
```
    Description copied from interface: DesignerProjectContext
    
    Checks whether or not the current logged in user can edit the protection bits of project resources. Note: RPC call to gateway.
    
    Specified by:
    
    canEditResourceProtection in interface DesignerProjectContext
    
    Throws:
    
    GatewayException
  - showError
```
protected void showError(java.lang.String message)
```
  - showError
```
protected void showError(java.lang.Exception e)
```
  - showError
```
protected void showError(java.lang.String message,
                         java.lang.Exception e)
```
  - releaseResourceLockFromGateway
```
protected void releaseResourceLockFromGateway(long resourceId)
                                       throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getLogger
```
protected LoggerEx getLogger()
```
  - addLegacyScriptNode
```
public void addLegacyScriptNode()
```
    Adds the Legacy Script project node for pre-7.7 script modules that have been imported by the user.

Class DesignerContextImpl

Nested Class Summary

Field Summary

Fields inherited from class com.inductiveautomation.ignition.client.model.AbstractClientContext

Constructor Summary

Method Summary

Methods inherited from class com.inductiveautomation.ignition.client.model.AbstractClientContext

Methods inherited from class java.lang.Object

Methods inherited from interface com.inductiveautomation.ignition.client.model.ClientContext

Methods inherited from interface com.inductiveautomation.ignition.common.model.BaseContext

Methods inherited from interface com.inductiveautomation.ignition.client.model.ProjectHolder

Field Detail

designerGui

Constructor Detail

DesignerContextImpl

Method Detail

getUserProjectHolder

getProtectionOptionFromDialog

setResourceLockManager

getLocalizationManager

getNamedQueryRpc

getProjectContext

getGlobalProject

getProjectContext

getProjectVersion

getExecutionManager

getModule

getModules

getLicenseState

exportResources

createExpressionFunctionFactory

getResourceCategoryKey

getResourceDisplayName

getResourceIcon

registerResourceWorkspace

getSearchProviders

registerClientPermissions

getClientPermissionBundleKeys

registerSearchProvider

getFrame

getCutAction

getCopyAction

getPasteAction

getDeleteAction

getTagManager

getSQLTagTreeModel

addBeanInfoSearchPath

createSerializer

createDeserializer

getStatusBar

getLockManager

shutdown

getRootPaneContainer

getProjectBrowserRoot

deserialize

addPropertyEditor

getScriptManager

getDockingManager

getToolbarManager

getTagEditor

getTagBrowser

getOPCBrowser

getQueryBrowserPanel

getTagUtilities

editResourceDocs

getDesignerPrefs

deleteResource

updateResource

updateResource

structuredRename

moveResource

addFolder

newResourceId

getScope

updateLock

hasLock

isLockModified

isLockOpen

releaseLock

synchLocks