Package com.inductiveautomation.perspective.designer.workspace.pageconfig

Class SessionPropsAdapter

java.lang.Object

com.inductiveautomation.perspective.designer.workspace.propertyeditor.AbstractDesignAdapter

com.inductiveautomation.perspective.designer.workspace.pageconfig.SessionPropsAdapter

All Implemented Interfaces:

DesignAdapter

public class SessionPropsAdapter
extends AbstractDesignAdapter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SessionPropsAdapter.SessionAdapterBridge

Field Summary

Fields

Modifier and Type	Field	Description
final SessionPropsAdapter.SessionAdapterBridge	bridge

Fields inherited from class com.inductiveautomation.perspective.designer.workspace.propertyeditor.AbstractDesignAdapter

context

Constructor Summary

Constructors

Constructor	Description
SessionPropsAdapter(ViewWorkspace workspace)

Method Summary

Modifier and Type	Method	Description
void	alterPropertyConfig(PropertyConfigChange change, boolean createUndoAction)
void	alterViewPermissions(PermissionsConfig config)
void	commit()	Called by the workspace right before a save occurs, so we can commit the session props to the local project
JavaJsBridge	getBridge()
DeepSelection	getDeepSelection()
com.teamdev.jxbrowser.js.JsObject	getDesignerComponentStore()	Expected to be non-null if the results of DesignAdapter.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()
CompletableFuture<List<String>>	getSymbolicPath(String indexPath)
ViewStructure	getViewStructure()
void	shutdown()

Methods inherited from class com.inductiveautomation.perspective.designer.workspace.propertyeditor.AbstractDesignAdapter

alterEventConfig, alterScriptConfig, getComponentDetails, getContext, getEffectivePipeSelectionAppearance, insertProperty, removeChildPropertyConfigs, removeProperty, renameProperty, sendRaw, writeProperties, writeProperty

Methods inherited from class java.lang.Object

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

Field Details

bridge

public final SessionPropsAdapter.SessionAdapterBridge bridge

Constructor Details

SessionPropsAdapter

public SessionPropsAdapter(ViewWorkspace workspace)

Method Details

commit

public void commit()

Called by the workspace right before a save occurs, so we can commit the session props to the local project

getBridge

public JavaJsBridge getBridge()

Specified by:

getBridge in class AbstractDesignAdapter

shutdown

public void shutdown()

getEventBus

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

Description copied from interface: DesignAdapter

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

getSelection

public ComponentSelection getSelection()

getSymbolicPath

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

Specified by:

getSymbolicPath in interface DesignAdapter

Overrides:

getSymbolicPath in class AbstractDesignAdapter

getViewStructure

public ViewStructure getViewStructure()

alterViewPermissions

public void alterViewPermissions(PermissionsConfig config)

Specified by:

alterViewPermissions in interface DesignAdapter

Overrides:

alterViewPermissions in class AbstractDesignAdapter

alterPropertyConfig

public void alterPropertyConfig(PropertyConfigChange change,
 boolean createUndoAction)

Specified by:

alterPropertyConfig in interface DesignAdapter

Overrides:

alterPropertyConfig in class AbstractDesignAdapter

getDeepSelection

@Nullable
public DeepSelection getDeepSelection()

getDesignerComponentStore

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

Description copied from interface: DesignAdapter

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

Returns:

a reference to the designer component store, or null.