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 Details

  • Method Details

    • getId

      ViewInstanceId getId()

    • getPage

      @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

    • 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

    • 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)