DesignerContextProxy

java.lang.Object
- com.inductiveautomation.ignition.designer.DesignerContextProxy

All Implemented Interfaces:

ResourceLockManager, ClientContext, ProjectHolder, CommonContext, DesignerContext, DesignerProjectContext
```
public class DesignerContextProxy
extends java.lang.Object
implements DesignerContext
```
This is used for parts of the designer that hold onto a DesignerContext, even though every time you load a project a new designer context is made. So, this context can be permanent, and we just switch out the inner context delegate.

Constructor Summary

Constructors
Constructor and Description

DesignerContextProxy()

Constructors
Constructor and Description
`DesignerContextProxy()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated 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`	`addProjectChangeListener(ProjectChangeListener listener)` Adds a listener that will recieve project diffs when the project changes
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener pcl)`
`void`	`addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener pcl)`
`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.
`void`	`applyDiff(Project diff, boolean dirty)`
`void`	`applyGlobalDiff(Project diff, boolean dirty)`
`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.
`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.lang.String`	`getAuthProfileName()` Returns the current project's user source
`java.lang.String`	`getCacheDir()` Deprecated.
`java.util.Map<java.lang.String,java.lang.String>`	`getClientPermissionBundleKeys()`
`DesignerContext`	`getContext()`
`javax.swing.Action`	`getCopyAction()`
`javax.swing.Action`	`getCutAction()`
`java.lang.String`	`getDefaultDatasourceName()` Returns the current project's default datasource name
`java.lang.String`	`getDefaultTagProviderName()` Returns the current project's default Tag provider
`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
`com.google.common.eventbus.EventBus`	`getEventBus()` This is a generic event bus that can be used by any part of Ignition within a single scope (jvm)
`ExecutionManager`	`getExecutionManager()` Returns the shared task execution manager for this client
`FunctionFactory`	`getExpressionFunctionFactory()` Returns the core function factory used by expressions.
`java.awt.Frame`	`getFrame()` Returns the owning frame of the designer.
`DesignerProjectContext`	`getGlobalProject()` Returns the project holder for the global project.
`LaunchContext`	`getLaunchContext()`
`LicenseState`	`getLicenseState(java.lang.String moduleId)` Returns the license state for the given module
`DesignerLocalizationManager`	`getLocalizationManager()`
`ResourceLockManager`	`getLockManager()` Deprecated.
`LogFilterSettings`	`getLoggingManager()`
`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()`
`ClientProgressManager`	`getProgressManager()` Returns the progress manager, which allows the execution of long running or async tasks.
`Project`	`getProject()` Gets the underlying project.
`ProjectBrowserRoot`	`getProjectBrowserRoot()` Returns the root node of the project browser tree, so that modules may add their own nodes.
`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?
`QueryBrowser`	`getQueryBrowserPanel()` Returns the DB query browser tool
`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()`
`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 Tags
`TagEditor`	`getTagEditor()` Returns the TagEditorPanel that can be used to edit/add Tags
`ClientTagManager`	`getTagManager()` Returns the manager that provides access to Ignition's tag system.
`int`	`getTagPollRate()` Returns the rate at which Tags should be polled for updates
`com.jidesoft.action.DockableBarManager`	`getToolbarManager()` Returns the JIDE dockable toolbar manager
`com.google.common.eventbus.EventBus`	`getUIEventBus()` This event bus schedules event notification on the swing EDT.
`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.
`void`	`removeProjectChangeListener(ProjectChangeListener listener)`
`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.
`void`	`setContext(DesignerContext context)`
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DesignerContextProxy
```
public DesignerContextProxy()
```
- Method Detail
  - getContext
```
public DesignerContext getContext()
```
  - setContext
```
public void setContext(DesignerContext context)
```
  - getScope
```
public ProjectScope getScope()
```
    Specified by:
    
    getScope in interface DesignerProjectContext
  - 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
  - getLoggingManager
```
public LogFilterSettings getLoggingManager()
```
    Specified by:
    
    getLoggingManager in interface CommonContext
  - getGlobalProject
```
public DesignerProjectContext 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
  - getEventBus
```
public com.google.common.eventbus.EventBus getEventBus()
```
    Description copied from interface: CommonContext
    
    This is a generic event bus that can be used by any part of Ignition within a single scope (jvm)
    
    Specified by:
    
    getEventBus in interface CommonContext
  - getUIEventBus
```
public com.google.common.eventbus.EventBus getUIEventBus()
```
    Description copied from interface: ClientContext
    
    This event bus schedules event notification on the swing EDT. This is opposed to the event bus found on CommonContext.getEventBus(), which schedules event notification on a background thread.
    
    Specified by:
    
    getUIEventBus in interface ClientContext
  - 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.
  - getExpressionFunctionFactory
```
public FunctionFactory getExpressionFunctionFactory()
```
    Description copied from interface: CommonContext
    
    Returns the core function factory used by expressions. Includes extension functions registered by modules.
    
    Specified by:
    
    getExpressionFunctionFactory in interface CommonContext
  - getLocalizationManager
```
public DesignerLocalizationManager getLocalizationManager()
```
    Specified by:
    
    getLocalizationManager in interface ClientContext
    
    Specified by:
    
    getLocalizationManager in interface DesignerContext
  - getLaunchContext
```
public LaunchContext getLaunchContext()
```
    Specified by:
    
    getLaunchContext in interface ClientContext
  - getCacheDir
```
@Deprecated
public java.lang.String getCacheDir()
```
    Deprecated.
    
    Specified by:
    
    getCacheDir in interface ClientContext
  - 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
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
```
    Specified by:
    
    addPropertyChangeListener in interface ClientContext
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String property,
                                      java.beans.PropertyChangeListener pcl)
```
    Specified by:
    
    addPropertyChangeListener in interface ClientContext
  - 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
  - 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
  - getProgressManager
```
public ClientProgressManager getProgressManager()
```
    Description copied from interface: ClientContext
    
    Returns the progress manager, which allows the execution of long running or async tasks.
    
    Specified by:
    
    getProgressManager in interface ClientContext
  - 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
  - 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
  - getDefaultDatasourceName
```
public java.lang.String getDefaultDatasourceName()
```
    Description copied from interface: ClientContext
    
    Returns the current project's default datasource name
    
    Specified by:
    
    getDefaultDatasourceName in interface ClientContext
  - getDefaultTagProviderName
```
public java.lang.String getDefaultTagProviderName()
```
    Description copied from interface: ClientContext
    
    Returns the current project's default Tag provider
    
    Specified by:
    
    getDefaultTagProviderName in interface ClientContext
  - getAuthProfileName
```
public java.lang.String getAuthProfileName()
```
    Description copied from interface: ClientContext
    
    Returns the current project's user source
    
    Specified by:
    
    getAuthProfileName in interface ClientContext
  - 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
  - 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
  - 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
  - getCopyAction
```
public javax.swing.Action getCopyAction()
```
    Specified by:
    
    getCopyAction in interface DesignerContext
  - getCutAction
```
public javax.swing.Action getCutAction()
```
    Specified by:
    
    getCutAction in interface DesignerContext
  - getDeleteAction
```
public javax.swing.Action getDeleteAction()
```
    Specified by:
    
    getDeleteAction in interface DesignerContext
  - getPasteAction
```
public javax.swing.Action getPasteAction()
```
    Specified by:
    
    getPasteAction in interface DesignerContext
  - 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
  - getTagPollRate
```
public int getTagPollRate()
```
    Description copied from interface: ClientContext
    
    Returns the rate at which Tags should be polled for updates
    
    Specified by:
    
    getTagPollRate in interface ClientContext
  - 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
  - getTagManager
```
public ClientTagManager getTagManager()
```
    Description copied from interface: CommonContext
    
    Returns the manager that provides access to Ignition's tag system.
    
    Specified by:
    
    getTagManager in interface ClientContext
    
    Specified by:
    
    getTagManager in interface CommonContext
  - 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
  - createDeserializer
```
public XMLDeserializer createDeserializer()
```
    Description copied from interface: CommonContext
    
    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 CommonContext
  - 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: CommonContext
    
    Returns the ScriptManager that can be used to execute Python scripts.
    
    Specified by:
    
    getScriptManager in interface CommonContext
  - 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
  - getTagBrowser
```
public TagBrowserPanel getTagBrowser()
```
    Description copied from interface: DesignerContext
    
    Returns the TagBrowserPanel that can be used to select Tags
    
    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
  - getTagEditor
```
public TagEditor getTagEditor()
```
    Description copied from interface: DesignerContext
    
    Returns the TagEditorPanel that can be used to edit/add Tags
    
    Specified by:
    
    getTagEditor in interface DesignerContext
  - getQueryBrowserPanel
```
public QueryBrowser getQueryBrowserPanel()
```
    Description copied from interface: DesignerContext
    
    Returns the DB query browser tool
    
    Specified by:
    
    getQueryBrowserPanel 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
  - getProject
```
public Project getProject()
```
    Description copied from interface: ProjectHolder
    
    Gets the underlying project. Do not modify resources directly, see ProjectHolder.addProjectChangeListener(ProjectChangeListener) and #deleteResource(long)
    
    Specified by:
    
    getProject in interface ProjectHolder
  - applyDiff
```
public void applyDiff(Project diff,
                      boolean dirty)
```
    Specified by:
    
    applyDiff in interface ProjectHolder
  - applyGlobalDiff
```
public void applyGlobalDiff(Project diff,
                            boolean dirty)
```
    Specified by:
    
    applyGlobalDiff in interface ClientContext
  - removeProjectChangeListener
```
public void removeProjectChangeListener(ProjectChangeListener listener)
```
    Specified by:
    
    removeProjectChangeListener in interface ProjectHolder
  - addProjectChangeListener
```
public void addProjectChangeListener(ProjectChangeListener listener)
```
    Description copied from interface: ProjectHolder
    
    Adds a listener that will recieve project diffs when the project changes
    
    Specified by:
    
    addProjectChangeListener in interface ProjectHolder
  - updateResource
```
public void updateResource(ProjectResource resource)
```
    Description copied from interface: DesignerProjectContext
    
    Adds or updates the given project resource
    
    Specified by:
    
    updateResource in interface DesignerProjectContext
  - getModule
```
public java.lang.Object getModule(java.lang.String id)
```
    Description copied from interface: CommonContext
    
    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 CommonContext
  - 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
  - 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
  - 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
  - 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
  - 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.
  - 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
  - getLockManager
```
@Deprecated
public ResourceLockManager getLockManager()
```
    Deprecated.
    
    Description copied from interface: DesignerContext
    
    The resource lock manager that you must use when opening/editing/closing ProjectResources.
    
    Specified by:
    
    getLockManager in interface DesignerContext
  - getLicenseState
```
public LicenseState getLicenseState(java.lang.String moduleId)
```
    Description copied from interface: CommonContext
    
    Returns the license state for the given module
    
    Specified by:
    
    getLicenseState in interface CommonContext
  - 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
  - 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.
  - 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
  - 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
  - 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
  - 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

Class DesignerContextProxy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DesignerContextProxy

Method Detail

getContext

setContext

getScope

getProjectContext

getLoggingManager

getGlobalProject

getEventBus

getUIEventBus

getNamedQueryRpc

getExpressionFunctionFactory

getLocalizationManager

getLaunchContext

getCacheDir

addBeanInfoSearchPath

addPropertyChangeListener

addPropertyChangeListener

exportResources

getProjectVersion

getExecutionManager

getProgressManager

createSerializer

getDesignerPrefs

getDefaultDatasourceName

getDefaultTagProviderName

getAuthProfileName

getSearchProviders

registerClientPermissions

getClientPermissionBundleKeys

canEditResourceProtection

registerSearchProvider

getFrame

getCopyAction

getCutAction

getDeleteAction

getPasteAction

getRootPaneContainer

getTagPollRate

getStatusBar

getTagManager

registerResourceWorkspace

createDeserializer

getProjectBrowserRoot

deserialize

addPropertyEditor

getScriptManager

getDockingManager

getToolbarManager

getTagBrowser

getOPCBrowser

getTagEditor

getQueryBrowserPanel

deleteResource

getProject

applyDiff

applyGlobalDiff

removeProjectChangeListener

addProjectChangeListener

updateResource

getModule

getModules

editResourceDocs

addFolder

moveResource

structuredRename

updateResource

getLockManager

getLicenseState

requestLock

requestLockQuietly

updateLock

releaseLock

hasLock

isLockModified