Interface Component
- All Superinterfaces:
AuditingContext, LoggingContext, PerspectiveElement, PropertyTreeOwner
- All Known Implementing Classes:
ComponentModel, DesignerComponentModel
Interface for component instances.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionfindChildByName(@NonNull Iterator<String> pathIterator) findExtensionFunction(String name) voidFire an event on component.getChild(int index) Index path of the component, like "0:5"default @NonNull PagegetPage()@Nullable ComponentgetPropertyConfig(PropertyKey property) default @NonNull SessiongetType()The type ID of this component, like "ia.display.label"@NonNull ViewgetView()Methods inherited from interface AuditingContext
audit, getAuditSnapshotMethods inherited from interface LoggingContext
getLogger, getMdcParent, mdc, mdcSetup, mdcSetupTree, mdcTeardown, mdcTeardownTree, mdcWrapMethods inherited from interface PerspectiveElement
createPropertyReference, getAuditProfile, getName, getQualifiedPath, isRunningMethods inherited from interface PropertyTreeOwner
getPropertyTreeOf
-
Field Details
-
MDC_COMPONENT
- See Also:
-
-
Method Details
-
getParent
@Nullable Component getParent()- Returns:
- parent component, or null if this a root container.
-
getChild
-
getChildren
Collection<Component> getChildren() -
findChildByName
-
findExtensionFunction
-
getPropertyConfig
-
getComponentScriptExtensions
default Map<String, com.inductiveautomation.ignition.common.gson.JsonElement> getComponentScriptExtensions()- Returns:
- module-namespaced extension payloads from the component's
ScriptConfig, or an empty map when absent. Consumers should pull a single namespaced key and tolerate unknown shapes defensively.
-
getView
@NonNull View getView()- Specified by:
getViewin interfacePerspectiveElement- Returns:
- The view within which this element exists, or null if this is a Page or Session
-
getPage
- Specified by:
getPagein interfacePerspectiveElement- Returns:
- The Page that this element is part of. Will return null if this is the Session
-
getSession
- Specified by:
getSessionin interfacePerspectiveElement- Returns:
- The session that this element is a part of.
-
fireEvent
-
getComponentAddressPath
String getComponentAddressPath()Index path of the component, like "0:5" -
getType
String getType()The type ID of this component, like "ia.display.label"
-