com.inductiveautomation.ignition.designer.model

Interface DesignerContext

All Superinterfaces:

ClientContext, CommonContext, DesignerProjectContext, ProjectHolder, ResourceLockManager

All Known Implementing Classes:

DesignerContextImpl, DesignerContextProxy

public interface DesignerContext
extends ClientContext, DesignerProjectContext

Method Summary

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.
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.
XMLSerializer	createSerializer() Creates a new XML serializer that has been configured by all installed modules for custom serialization delegates
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
java.awt.Frame	getFrame() Returns the owning frame of the designer.
DesignerProjectContext	getGlobalProject() Returns the project holder for the global project.
DesignerLocalizationManager	getLocalizationManager()
ResourceLockManager	getLockManager() Deprecated. The Designer Context is a lock manager now.
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.
DesignerProjectContext	getProjectContext(ProjectScope scope) Provides a way to get the local or global project scope by ProjectScope enum.
QueryBrowser	getQueryBrowserPanel() Returns the DB query browser tool
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
com.jidesoft.action.DockableBarManager	getToolbarManager() Returns the JIDE dockable toolbar manager
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.

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

addPropertyChangeListener, addPropertyChangeListener, applyGlobalDiff, deserialize, getAuthProfileName, getCacheDir, getDefaultDatasourceName, getDefaultTagProviderName, getExecutionManager, getLaunchContext, getModules, getNamedQueryRpc, getProgressManager, getProjectVersion, getRootPaneContainer, getTagManager, getTagPollRate, getUIEventBus

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

createDeserializer, getEventBus, getExpressionFunctionFactory, getLicenseState, getLoggingManager, getModule, getScriptManager

Methods inherited from interface com.inductiveautomation.ignition.designer.model.DesignerProjectContext

addFolder, canEditResourceProtection, deleteResource, getScope, moveResource, structuredRename, updateResource, updateResource

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

addProjectChangeListener, applyDiff, getProject, removeProjectChangeListener

Methods inherited from interface com.inductiveautomation.ignition.client.gateway_interface.ResourceLockManager

hasLock, isLockModified, isLockOpen, newResourceId, releaseLock, requestLock, requestLockQuietly, synchLocks, updateLock

Method Detail

getGlobalProject

DesignerProjectContext getGlobalProject()

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

getProjectContext

DesignerProjectContext getProjectContext(ProjectScope scope)

Provides a way to get the local or global project scope by ProjectScope enum.

exportResources

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.

addBeanInfoSearchPath

void addBeanInfoSearchPath(java.lang.String packageName)

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.

createSerializer

XMLSerializer createSerializer()

Creates a new XML serializer that has been configured by all installed modules for custom serialization delegates

getStatusBar

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

editResourceDocs

void editResourceDocs(ProjectResource resource,
                      ProjectScope scope)

Opens up the resource notes editor for the given project resources

getProjectBrowserRoot

ProjectBrowserRoot getProjectBrowserRoot()

Returns the root node of the project browser tree, so that modules may add their own nodes.

See Also:

ProjectBrowserRoot.getGlobalFolder(), ProjectBrowserRoot.getProjectFolder(), AbstractNavTreeNode

getDesignerPrefs

PersistentProperties getDesignerPrefs()

Returns a PersistentProperties file that will be stored on a per-user basis for "persistent" but not project-encapsulated preferences

getLocalizationManager

DesignerLocalizationManager getLocalizationManager()

Specified by:

getLocalizationManager in interface ClientContext

getFrame

java.awt.Frame getFrame()

Returns the owning frame of the designer. Handy for dialog parents

getCutAction

javax.swing.Action getCutAction()

getCopyAction

javax.swing.Action getCopyAction()

getPasteAction

javax.swing.Action getPasteAction()

getDeleteAction

javax.swing.Action getDeleteAction()

getTagEditor

TagEditor getTagEditor()

Returns the TagEditorPanel that can be used to edit/add Tags

getTagBrowser

TagBrowserPanel getTagBrowser()

Returns the TagBrowserPanel that can be used to select Tags

getOPCBrowser

OPCBrowserPanel getOPCBrowser()

Returns the OPCBrowserPanel that can be used to browse and import OPC items

getQueryBrowserPanel

QueryBrowser getQueryBrowserPanel()

Returns the DB query browser tool

getDockingManager

com.jidesoft.docking.DockingManager getDockingManager()

Returns the JIDE DockingManager for the Designer

getToolbarManager

com.jidesoft.action.DockableBarManager getToolbarManager()

Returns the JIDE dockable toolbar manager

registerResourceWorkspace

void registerResourceWorkspace(ResourceWorkspace workspace)

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.

Parameters:

workspace - The ResourceWorkspace to register with the designer

getLockManager

@Deprecated
ResourceLockManager getLockManager()

Deprecated. The Designer Context is a lock manager now.

The resource lock manager that you must use when opening/editing/closing ProjectResources.

addPropertyEditor

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. 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.

registerSearchProvider

void registerSearchProvider(SearchProvider provider)

Registers a search provider that will be exposed through the find/replace system.

getSearchProviders

java.util.List<SearchProvider> getSearchProviders()

registerClientPermissions

void registerClientPermissions(java.util.Map<java.lang.String,java.lang.String> bundleMap)

Register id-bundlekey pairs to limit client permissions

Parameters:

bundleMap - Map of ids to bundlekeys. May be null.

getClientPermissionBundleKeys

java.util.Map<java.lang.String,java.lang.String> getClientPermissionBundleKeys()