Package com.inductiveautomation.perspective.gateway.api

Interface Component

All Superinterfaces:

AuditingContext, LoggingContext, PerspectiveElement, PropertyTreeOwner

All Known Implementing Classes:

ComponentModel, DesignerComponentModel

public interface Component
extends PerspectiveElement

Interface for component instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MDC_COMPONENT

Method Summary

Modifier and Type	Method	Description
Optional<PerspectiveElement>	findChildByName(Iterator<String> pathIterator)
Optional<ExtensionFunction>	findExtensionFunction(String name)
void	fireEvent(String eventType, String eventName, Object eventObject)	Fire an event on component.
Optional<Component>	getChild(int index)
Collection<Component>	getChildren()
String	getComponentAddressPath()	Index path of the component, like "0:5"
default Page	getPage()
Component	getParent()
Optional<PropertyConfig>	getPropertyConfig(PropertyKey property)
default Session	getSession()
String	getType()	The type ID of this component, like "ia.display.label"
View	getView()

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, getQualifiedPath, isRunning

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

getPropertyTreeOf

Field Details

MDC_COMPONENT

static final String MDC_COMPONENT

See Also:

• Constant Field Values

Method Details

getParent

@Nullable
Component getParent()

Returns:

parent component, or null if this a root container.

getChild

Optional<Component> getChild(int index)

getChildren

Collection<Component> getChildren()

findChildByName

Optional<PerspectiveElement> findChildByName(@Nonnull
 Iterator<String> pathIterator)

findExtensionFunction

Optional<ExtensionFunction> findExtensionFunction(String name)

getPropertyConfig

Optional<PropertyConfig> getPropertyConfig(PropertyKey property)

getView

@Nonnull
View getView()

Specified by:

getView in interface PerspectiveElement

Returns:

The view within which this element exists, or null if this is a Page or Session

getPage

@Nonnull
default Page getPage()

Specified by:

getPage in interface PerspectiveElement

Returns:

The Page that this element is part of. Will return null if this is the Session

getSession

@Nonnull
default Session getSession()

Specified by:

getSession in interface PerspectiveElement

Returns:

The session that this element is a part of.

fireEvent

void fireEvent(String eventType,
 String eventName,
 Object eventObject)

Fire an event on component. Can either be a 'component' event or a 'delegate' event.

getComponentAddressPath

String getComponentAddressPath()

Index path of the component, like "0:5"

getType

String getType()

The type ID of this component, like "ia.display.label"