Package com.inductiveautomation.perspective.designer

Class DesignerHook

java.lang.Object

com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook

com.inductiveautomation.perspective.designer.DesignerHook

All Implemented Interfaces:

Locatable, LocationRenderingUpdater, DesignerModuleHook, PerspectiveDesignerInterface

public class DesignerHook
extends AbstractDesignerModuleHook
implements PerspectiveDesignerInterface, Locatable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLEAR_CACHE_ON_PANEL_LOAD
static final VectorIcons	ICONS
static final String	IN_MEMORY_CACHE
static final String	LIGHTWEIGHT_MODE
static final String	LOG_BROWSER_TO_DISK
static final String	USER_DATA_DIR	System flag used to specify the directory where user data is stored for an instance of the JxBrowser Engine.

Constructor Summary

Constructors

Constructor	Description
DesignerHook()

Method Summary

Modifier and Type	Method	Description
static DesignerHook	get(DesignerContext context)
DesignerActionRegistryImpl	getActionRegistry()
DesignerBindingRegistryImpl	getBindingRegistry()
static String	getBrowserFailedMessage()
String	getCombinedStyles()
ComponentDesignDelegateRegistry	getComponentDesignDelegateRegistry()
DesignerComponentRegistry	getDesignerComponentRegistry()
Collection<String>	getIconLibraries()
Icon	getModuleIcon()	Return an appropriate icon to display for this module.
MenuBarMerge	getModuleMenu()	Returns a menu merge for any global menu additions.
PerspectiveNavNode	getNavNode()
String	getResourceCategoryKey(ResourcePath resourcePath)	Used by modules that add project resources to an Ignition project.
String	getResourceDisplayName(ResourcePath resourcePath)	Allows a module to give an appropriate display name for the resource.
Icon	getResourceIcon(ResourcePath resourcePath)	Allows a module to give an appropriate icon for a resource.
SessionEventDialog	getSessionEventDialog()
PropertySuggestionSourceRegistry	getSuggestionSourceRegistry()
SymbolPropConfig	getSymbolProps()
ViewWorkspace	getWorkspace()
void	locate(Location location)
void	notifyProjectSaveDone()	Notifies the module that the save operation has finished.
void	notifyProjectSaveStart(SaveContext save)	Notifies the module that the user has requested that the project is saved.
void	shutdown()	Called when the module is shut down.
void	startup(DesignerContext context, LicenseState activationState)	The main entrypoint for the module hook.
void	updateLocationRenderer(LocationRenderingInfo builder, Location location)	Provides an opportunity for a module to enrich tag reference locations with extra context.

Methods inherited from class com.inductiveautomation.ignition.designer.model.AbstractDesignerModuleHook

configureDeserializer, configureFunctionFactory, configureSerializer, createPermissionKeys, getFrames, getModuleToolbars, getResourceCategoryKey, getResourceDisplayName, getResourceIcon, initializeScriptManager, notifyActivationStateChanged

Methods inherited from class java.lang.Object

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

Field Details

ICONS

public static final VectorIcons ICONS

LIGHTWEIGHT_MODE

public static final String LIGHTWEIGHT_MODE

See Also:

• Constant Field Values

IN_MEMORY_CACHE

public static final String IN_MEMORY_CACHE

See Also:

• Constant Field Values

USER_DATA_DIR

public static final String USER_DATA_DIR

System flag used to specify the directory where user data is stored for an instance of the JxBrowser Engine. Default is to the designer cache directory/.jxbrowser/<ignition_username>

See Also:

• Constant Field Values

CLEAR_CACHE_ON_PANEL_LOAD

public static final String CLEAR_CACHE_ON_PANEL_LOAD

See Also:

• Constant Field Values

LOG_BROWSER_TO_DISK

public static final String LOG_BROWSER_TO_DISK

See Also:

• Constant Field Values

Constructor Details

DesignerHook

public DesignerHook()

Method Details

get

public static DesignerHook get(DesignerContext context)

getComponentDesignDelegateRegistry

public ComponentDesignDelegateRegistry getComponentDesignDelegateRegistry()

Specified by:

getComponentDesignDelegateRegistry in interface PerspectiveDesignerInterface

getBindingRegistry

public DesignerBindingRegistryImpl getBindingRegistry()

Specified by:

getBindingRegistry in interface PerspectiveDesignerInterface

getSuggestionSourceRegistry

public PropertySuggestionSourceRegistry getSuggestionSourceRegistry()

Specified by:

getSuggestionSourceRegistry in interface PerspectiveDesignerInterface

getActionRegistry

public DesignerActionRegistryImpl getActionRegistry()

Specified by:

getActionRegistry in interface PerspectiveDesignerInterface

getDesignerComponentRegistry

public DesignerComponentRegistry getDesignerComponentRegistry()

Specified by:

getDesignerComponentRegistry in interface PerspectiveDesignerInterface

startup

public void startup(DesignerContext context,
 LicenseState activationState)

Description copied from interface: DesignerModuleHook

The main entrypoint for the module hook. This will only be called once for a given project. If another project is ever opened, DesignerModuleHook.shutdown() will be called and a new hook will be instantiated

Specified by:

startup in interface DesignerModuleHook

Overrides:

startup in class AbstractDesignerModuleHook

getWorkspace

public ViewWorkspace getWorkspace()

getNavNode

public PerspectiveNavNode getNavNode()

getSessionEventDialog

public SessionEventDialog getSessionEventDialog()

getResourceCategoryKey

public String getResourceCategoryKey(ResourcePath resourcePath)

Description copied from interface: DesignerModuleHook

Used by modules that add project resources to an Ignition project. This will be called when the platform needs to render your resource type in first-party UI. Only project resources that match this module's ID will passed to this function.

Specified by:

getResourceCategoryKey in interface DesignerModuleHook

Parameters:

resourcePath - A resource path within this module's resources.

Returns:

A bundle resource key for the category of this resource.

getResourceDisplayName

public String getResourceDisplayName(ResourcePath resourcePath)

Description copied from interface: DesignerModuleHook

Allows a module to give an appropriate display name for the resource. For most resources this won't be necessary (the resource's name itself should be used), but for some resources whose name is null, this may be appropriate.

Specified by:

getResourceDisplayName in interface DesignerModuleHook

Returns:

the name for a resource, or null to use the resource's folder path/name.

getModuleIcon

@Nullable
public Icon getModuleIcon()

Description copied from interface: DesignerModuleHook

Return an appropriate icon to display for this module. Ideally, an InteractiveIcon of some kind.

Specified by:

getModuleIcon in interface DesignerModuleHook

See Also:

• InteractiveSvgIcon
• InteractiveVectorIcon
• VectorIcons.getInteractive

getResourceIcon

public Icon getResourceIcon(ResourcePath resourcePath)

Description copied from interface: DesignerModuleHook

Allows a module to give an appropriate icon for a resource.

Specified by:

getResourceIcon in interface DesignerModuleHook

See Also:

• InteractiveSvgIcon
• InteractiveVectorIcon
• VectorIcons.getInteractive

updateLocationRenderer

public void updateLocationRenderer(@Nonnull
 LocationRenderingInfo builder,
 @Nonnull
 Location location)

Description copied from interface: DesignerModuleHook

Provides an opportunity for a module to enrich tag reference locations with extra context. The location provided is guaranteed to reside within your module. Call methods on LocationRenderingInfo to enrich the rendering.

Specified by:

updateLocationRenderer in interface DesignerModuleHook

Specified by:

updateLocationRenderer in interface LocationRenderingUpdater

See Also:

• LocationRenderingUpdater

locate

public void locate(Location location)

Specified by:

locate in interface Locatable

getIconLibraries

public Collection<String> getIconLibraries()

getModuleMenu

public MenuBarMerge getModuleMenu()

Description copied from interface: DesignerModuleHook

Returns a menu merge for any global menu additions. May be null.

Specified by:

getModuleMenu in interface DesignerModuleHook

Overrides:

getModuleMenu in class AbstractDesignerModuleHook

See Also:

• JMenuMerge

shutdown

public void shutdown()

Description copied from interface: DesignerModuleHook

Called when the module is shut down. This will happen if the user opens a different project within the same designer session - the existing modules will be shut down, and new module hooks will be instantiated and started up.

Specified by:

shutdown in interface DesignerModuleHook

Overrides:

shutdown in class AbstractDesignerModuleHook

notifyProjectSaveStart

public void notifyProjectSaveStart(SaveContext save)

Description copied from interface: DesignerModuleHook

Notifies the module that the user has requested that the project is saved. The module must check-in any checked-out resources that it is holding.

Specified by:

notifyProjectSaveStart in interface DesignerModuleHook

Overrides:

notifyProjectSaveStart in class AbstractDesignerModuleHook

notifyProjectSaveDone

public void notifyProjectSaveDone()

Description copied from interface: DesignerModuleHook

Notifies the module that the save operation has finished. This is the cue to check-out any previously checked-out resources that it was forced to check-in before the save.

Specified by:

notifyProjectSaveDone in interface DesignerModuleHook

Overrides:

notifyProjectSaveDone in class AbstractDesignerModuleHook

getCombinedStyles

public String getCombinedStyles()

getSymbolProps

public SymbolPropConfig getSymbolProps()

getBrowserFailedMessage

public static String getBrowserFailedMessage()