Package com.inductiveautomation.perspective.gateway.api

Interface View

All Superinterfaces:

AuditingContext, LoggingContext, PerspectiveElement, PropertyTreeOwner

All Known Implementing Classes:

DesignerViewModel, ViewModel

public interface View
extends PerspectiveElement

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MDC_VIEW

Method Summary

Modifier and Type	Method	Description
Optional<PerspectiveElement>	findChildByIndexLocation(String indexLocation)	Tries to look up a component by its index location.
Optional<PerspectiveElement>	findChildByPath(String path)	Tries to look up a component by its name path.
ViewInstanceId	getId()
Optional<PropertyConfig>	getPropertyConfig(PropertyKey property)
Component	getRootContainer()
com.google.common.eventbus.EventBus	getViewEventBus()	Deprecated. Replaced by getViewEventManager().
EventManager	getViewEventManager()

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.AuditingContext

audit, getAuditSnapshot

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.LoggingContext

getLogger, getMdcParent, mdc, mdcSetup, mdcSetupTree, mdcTeardown, mdcTeardownTree, mdcWrap

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.PerspectiveElement

createPropertyReference, getAuditProfile, getName, getPage, getQualifiedPath, getSession, getView, isRunning

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.PropertyTreeOwner

getPropertyTreeOf

Field Details

MDC_VIEW

static final String MDC_VIEW

See Also:

• Constant Field Values

Method Details

getId

ViewInstanceId getId()

getRootContainer

Component getRootContainer()

getViewEventBus

@Deprecated
com.google.common.eventbus.EventBus getViewEventBus()

Deprecated.

Replaced by getViewEventManager(). Will be removed in 8.2.0

getViewEventManager

EventManager getViewEventManager()

findChildByPath

Optional<PerspectiveElement> findChildByPath(String path)

Tries to look up a component by its name path. Some examples:

"/": returns the view

"/root": returns the root container if the root container's name is "root"

"/root/foo": returns a component called "foo" contained with in the root container called "root"

findChildByIndexLocation

Optional<PerspectiveElement> findChildByIndexLocation(String indexLocation)

Tries to look up a component by its index location. Some examples:

"": returns the view

"0": returns the root container

"0:4" returns a child of the root container at index 4

getPropertyConfig

Optional<PropertyConfig> getPropertyConfig(PropertyKey property)