Package com.inductiveautomation.perspective.designer.api

Interface DesignAdapter

All Known Implementing Classes:

AbstractDesignAdapter, SessionPropsAdapter

public interface DesignAdapter

Contains methods and events that are used to design a view in the perspective workspace.

Method Summary

Modifier and Type	Method	Description
void	alterEventConfig(EventConfigChange change)
void	alterPropertyConfig(PropertyConfigChange change)
void	alterScriptConfig(ScriptConfigChange change)
void	alterViewPermissions(PermissionsConfig config)
java.util.concurrent.CompletableFuture<ComponentDetails>	getComponentDetails(java.lang.String componentIndexPath)
DesignerContext	getContext()
DeepSelection	getDeepSelection()
com.teamdev.jxbrowser.js.JsObject	getDesignerComponentStore()	Expected to be non-null iff the results of getDeepSelection() are non-null.
com.google.common.eventbus.EventBus	getEventBus()	Event bus that can be used to listen to the following event types: SelectionChangeEvent DeepSelectionChangeEvent DeepSelectionUpdateEvent SelectionPropertyUpdateEvent EditorShutdownEvent
ComponentSelection	getSelection()
java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>>	getSymbolicPath(java.lang.String indexPath)
ViewStructure	getViewStructure()
void	removeChildPropertyConfigs(java.lang.String componentIndexPath, PropertyType scope, java.lang.String propertyPath)
void	removeProperty(java.lang.String componentIndexPath, PropertyType scope, java.lang.String pathToParent, int index)
void	removeProperty(java.lang.String componentIndexPath, PropertyType scope, java.lang.String pathToParent, java.lang.String name)
void	renameProperty(java.lang.String componentIndexPath, PropertyType scope, java.lang.String pathToParent, java.lang.String oldName, java.lang.String newName)
void	sendRaw(java.lang.String protocol, java.lang.String payloadJson)
void	write(java.lang.String componentIndexPath, PropertyType scope, java.lang.String propertyPath, java.lang.String valueAsJson)

Method Detail

getContext

DesignerContext getContext()

getEventBus

com.google.common.eventbus.EventBus getEventBus()

Event bus that can be used to listen to the following event types: SelectionChangeEvent DeepSelectionChangeEvent DeepSelectionUpdateEvent SelectionPropertyUpdateEvent EditorShutdownEvent

getSymbolicPath

java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getSymbolicPath(java.lang.String indexPath)

getComponentDetails

java.util.concurrent.CompletableFuture<ComponentDetails> getComponentDetails(java.lang.String componentIndexPath)

getDeepSelection

@Nullable
DeepSelection getDeepSelection()

getDesignerComponentStore

@Nullable
com.teamdev.jxbrowser.js.JsObject getDesignerComponentStore()

Expected to be non-null iff the results of getDeepSelection() are non-null.

Returns:

a reference to the designer component store, or null.

getSelection

ComponentSelection getSelection()

getViewStructure

ViewStructure getViewStructure()

write

void write(java.lang.String componentIndexPath,
           PropertyType scope,
           java.lang.String propertyPath,
           java.lang.String valueAsJson)

renameProperty

void renameProperty(java.lang.String componentIndexPath,
                    PropertyType scope,
                    java.lang.String pathToParent,
                    java.lang.String oldName,
                    java.lang.String newName)

removeProperty

void removeProperty(java.lang.String componentIndexPath,
                    PropertyType scope,
                    java.lang.String pathToParent,
                    java.lang.String name)

removeProperty

void removeProperty(java.lang.String componentIndexPath,
                    PropertyType scope,
                    java.lang.String pathToParent,
                    int index)

removeChildPropertyConfigs

void removeChildPropertyConfigs(java.lang.String componentIndexPath,
                                PropertyType scope,
                                java.lang.String propertyPath)

alterPropertyConfig

void alterPropertyConfig(PropertyConfigChange change)

alterEventConfig

void alterEventConfig(EventConfigChange change)

alterScriptConfig

void alterScriptConfig(ScriptConfigChange change)

alterViewPermissions

void alterViewPermissions(PermissionsConfig config)

sendRaw

void sendRaw(java.lang.String protocol,
             java.lang.String payloadJson)