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, boolean createUndoAction)
void	alterScriptConfig(ScriptConfigChange change)
void	alterViewPermissions(PermissionsConfig config)
CompletableFuture<ComponentDetails>	getComponentDetails(String componentIndexPath)
DesignerContext	getContext()
DeepSelection	getDeepSelection()
com.teamdev.jxbrowser.js.JsObject	getDesignerComponentStore()	Expected to be non-null if the results of getDeepSelection() are non-null.
CompletableFuture<String>	getEffectivePipeSelectionAppearance()
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()
CompletableFuture<List<String>>	getSymbolicPath(String indexPath)
ViewStructure	getViewStructure()
void	insertProperty(InsertPropertyChange change)
void	removeChildPropertyConfigs(String componentIndexPath, PropertyType scope, String propertyPath)
void	removeProperty(RemovePropertyChange change, boolean createUndoAction)
void	renameProperty(RenamePropertyChange change, boolean createUndoAction)
void	sendRaw(String protocol, String payloadJson)
void	writeProperties(WritePropertiesChange change)
void	writeProperty(WritePropertyChange change, boolean createUndoAction)

Method Details

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

CompletableFuture<List<String>> getSymbolicPath(String indexPath)

getComponentDetails

CompletableFuture<ComponentDetails> getComponentDetails(String componentIndexPath)

getEffectivePipeSelectionAppearance

CompletableFuture<String> getEffectivePipeSelectionAppearance()

getDeepSelection

@Nullable
DeepSelection getDeepSelection()

getDesignerComponentStore

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

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

Returns:

a reference to the designer component store, or null.

getSelection

ComponentSelection getSelection()

getViewStructure

ViewStructure getViewStructure()

writeProperty

void writeProperty(WritePropertyChange change,
 boolean createUndoAction)

writeProperties

void writeProperties(WritePropertiesChange change)

insertProperty

void insertProperty(InsertPropertyChange change)

renameProperty

void renameProperty(RenamePropertyChange change,
 boolean createUndoAction)

removeProperty

void removeProperty(RemovePropertyChange change,
 boolean createUndoAction)

removeChildPropertyConfigs

void removeChildPropertyConfigs(String componentIndexPath,
 PropertyType scope,
 String propertyPath)

alterPropertyConfig

void alterPropertyConfig(PropertyConfigChange change,
 boolean createUndoAction)

alterEventConfig

void alterEventConfig(EventConfigChange change)

alterScriptConfig

void alterScriptConfig(ScriptConfigChange change)

alterViewPermissions

void alterViewPermissions(PermissionsConfig config)

sendRaw

void sendRaw(String protocol,
 String payloadJson)