Package com.inductiveautomation.vision.api.client

Interface VisionClientInterface

All Known Subinterfaces:
VisionDesignerInterface
All Known Implementing Classes:
ClientContextImpl, VisionDesignerImpl
public interface VisionClientInterface
The public API interface for the Vision client. You can safely cast the Vision module to an instance of VisionClientInterface in either the client or designer context.

Example: 

 ClientContext context = ...
 VisionClientInterface vision = (VisionClientInterface)context.getModule(VisionClientInterface.VISION_MODULE_ID);
See Also:

  • Field Details

  • Method Details

    • addExtensibleBindingType

      void addExtensibleBindingType(BindingType binding)
      Adds a new binding type to be used in the extensible binding system
      Parameters:
      binding - The binding type to add.

    • getBindingType

      BindingType getBindingType(String bindingTypeKey)
      Gets a binding type by its key.
      Parameters:
      bindingTypeKey - The unique key for the binding type.
      Returns:
      The binding type, or null if not found.

    • getNavUtil

      NavUtilities getNavUtil()
      Gets the NavUtilities for the primary desktop.
      Returns:
      The navigation utilities.

    • getNavUtil

      NavUtilities getNavUtil(String desktopHandle)
      Gets the NavUtilities for a secondary desktop, by handle.
      Parameters:
      desktopHandle - The handle of the desktop.
      Returns:
      The navigation utilities for the specified desktop.

    • getGuiUtil

      WindowUtilities getGuiUtil()
      Gets the WindowUtilities for the primary desktop.
      Returns:
      The GUI utilities.

    • getGuiUtil

      WindowUtilities getGuiUtil(String desktopHandle)
      Gets the WindowUtilities for a secondary desktop, by handle.
      Parameters:
      desktopHandle - The handle of the desktop.
      Returns:
      The GUI utilities for the specified desktop.

    • addWindowListener

      void addWindowListener(VisionWindowListener listener)
      Adds a listener to be notified when windows are opened and closed. Only works during runtime, not designer.
      Parameters:
      listener - The window listener to add.

    • removeWindowListener

      void removeWindowListener(VisionWindowListener listener)
      Removes a window listener.
      Parameters:
      listener - The window listener to remove.