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 java.lang.String
MDC_COMPONENT
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.util.Optional<PerspectiveElement>
findChildByName(java.util.Iterator<java.lang.String> pathIterator)
java.util.Optional<ExtensionFunction>
findExtensionFunction(java.lang.String name)
void
fireEvent(java.lang.String eventType, java.lang.String eventName, java.lang.Object eventObject)
Fire an event on component.java.util.Optional<Component>
getChild(int index)
java.util.Collection<Component>
getChildren()
java.lang.String
getComponentAddressPath()
Index path of the component, like "0:5"default Page
getPage()
Component
getParent()
default Session
getSession()
-
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, getView
-
Methods inherited from interface com.inductiveautomation.perspective.gateway.api.PropertyTreeOwner
getPropertyTreeOf
-
-
-
-
Field Detail
-
MDC_COMPONENT
static final java.lang.String MDC_COMPONENT
- See Also:
- Constant Field Values
-
-
Method Detail
-
getParent
@Nullable Component getParent()
- Returns:
- parent component, or null if this a root container.
-
getChild
java.util.Optional<Component> getChild(int index)
-
getChildren
java.util.Collection<Component> getChildren()
-
findChildByName
java.util.Optional<PerspectiveElement> findChildByName(@Nonnull java.util.Iterator<java.lang.String> pathIterator)
-
findExtensionFunction
java.util.Optional<ExtensionFunction> findExtensionFunction(java.lang.String name)
-
getPage
@Nullable default Page getPage()
- Specified by:
getPage
in interfacePerspectiveElement
- 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 interfacePerspectiveElement
- Returns:
- The session that this element is a part of.
-
fireEvent
void fireEvent(java.lang.String eventType, java.lang.String eventName, java.lang.Object eventObject)
Fire an event on component. Can either be a 'component' event or a 'delegate' event.
-
getComponentAddressPath
java.lang.String getComponentAddressPath()
Index path of the component, like "0:5"
-
-