Interface Component

All Superinterfaces:
AuditingContext, LoggingContext, PerspectiveElement, PropertyTreeOwner
All Known Implementing Classes:
ComponentModel, DesignerComponentModel

public interface Component extends PerspectiveElement
Interface for component instances.
  • Field Details

  • 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)
    • 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:
      getView in interface PerspectiveElement
      Returns:
      The view within which this element exists, or null if this is a Page or Session
    • getPage

      default @NonNull 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

      default @NonNull 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"