Package com.inductiveautomation.vision.api.designer

Interface VisionDesignerInterface

All Superinterfaces:

VisionClientInterface

All Known Implementing Classes:

VisionDesignerImpl

public interface VisionDesignerInterface
extends VisionClientInterface

Field Summary

Fields inherited from interface com.inductiveautomation.vision.api.client.VisionClientInterface

VISION_MODULE_ID

Method Summary

Modifier and Type	Method	Description
void	addNewWindow(ResourcePath parentFolder, int width, int height, Consumer<ResourcePath> onAfter)	Adds a new window to the FPMIApp being designed
void	addWindowDropHandler(WindowDropHandler handler)	Add a new drop handler for custom drop types onto windows and templates
Component	cloneComponent(Component comp)
boolean	configureBinding(Component component, String property, BindingConfiguration configuration)	Configures a new property binding for the component.property using the given configuration.
DesignerPrefs	getCurrentPrefs()
DesignerContext	getDesignerContext()
Palette	getPalette()
WindowWorkspace	getWorkspace()
void	openBindingDialog(Component component, String property)	Opens the binding dialog for a given component.
void	removeWindowDropHandler(WindowDropHandler handler)	Removes a drop handler for custom drop types onto windows and templates

Methods inherited from interface com.inductiveautomation.vision.api.client.VisionClientInterface

addExtensibleBindingType, addWindowListener, getBindingType, getGuiUtil, getGuiUtil, getNavUtil, getNavUtil, removeWindowListener

Method Details

getPalette

Palette getPalette()

addNewWindow

void addNewWindow(ResourcePath parentFolder,
 int width,
 int height,
 Consumer<ResourcePath> onAfter)

Adds a new window to the FPMIApp being designed

cloneComponent

Component cloneComponent(Component comp)

getCurrentPrefs

DesignerPrefs getCurrentPrefs()

getWorkspace

WindowWorkspace getWorkspace()

getDesignerContext

DesignerContext getDesignerContext()

openBindingDialog

void openBindingDialog(Component component,
 String property)
                throws NotBindableException

Opens the binding dialog for a given component. The component should be on a window that is currently open for design

Throws:

NotBindableException

configureBinding

boolean configureBinding(Component component,
 String property,
 BindingConfiguration configuration)
                  throws Exception

Configures a new property binding for the component.property using the given configuration. The binding type is defined by the configuration's BindingConfiguration.getBindingType()

Throws:

Exception

addWindowDropHandler

void addWindowDropHandler(WindowDropHandler handler)

Add a new drop handler for custom drop types onto windows and templates

removeWindowDropHandler

void removeWindowDropHandler(WindowDropHandler handler)

Removes a drop handler for custom drop types onto windows and templates