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:

ClientContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VISION_MODULE_ID

Method Summary

Modifier and Type	Method and Description
void	addExtensibleBindingType(BindingType binding) Adds a new binding type to be used in the extensible binding system
void	addWindowListener(VisionWindowListener listener) Adds a listener to be notified when windows are opened and closed.
BindingType	getBindingType(java.lang.String bindingTypeKey)
WindowUtilities	getGuiUtil()
WindowUtilities	getGuiUtil(java.lang.String desktopHandle) Gets the WindowUtilities for a secondary desktop, by handle
NavUtilities	getNavUtil() Gets the NavUtilities (for the primary desktop
NavUtilities	getNavUtil(java.lang.String desktopHandle) Gets the NavUtilities for a secondary desktop, by handle
void	removeWindowListener(VisionWindowListener listener) Removes window listener

Field Detail

VISION_MODULE_ID

static final java.lang.String VISION_MODULE_ID

See Also:

Constant Field Values

Method Detail

addExtensibleBindingType

void addExtensibleBindingType(BindingType binding)

Adds a new binding type to be used in the extensible binding system

getBindingType

BindingType getBindingType(java.lang.String bindingTypeKey)

getNavUtil

NavUtilities getNavUtil()

Gets the NavUtilities (for the primary desktop

getNavUtil

NavUtilities getNavUtil(java.lang.String desktopHandle)

Gets the NavUtilities for a secondary desktop, by handle

getGuiUtil

WindowUtilities getGuiUtil()

getGuiUtil

WindowUtilities getGuiUtil(java.lang.String desktopHandle)

Gets the WindowUtilities for a secondary desktop, by handle

addWindowListener

void addWindowListener(VisionWindowListener listener)

Adds a listener to be notified when windows are opened and closed. Only works during runtime, not designer

removeWindowListener

void removeWindowListener(VisionWindowListener listener)

Removes window listener