Package com.inductiveautomation.factorypmi.application.components

Class TemplateCanvas

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanel

com.inductiveautomation.factorypmi.application.components.TemplateCanvas

All Implemented Interfaces:

DynamicPropertyProvider, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, DesignerInitializable, ExtensibleComponent, QualityMonitor, VisionComponent, ImageObserver, MenuContainer, Serializable, Accessible

public class TemplateCanvas
extends AbstractVisionPanel
implements DesignerInitializable, ExtensibleComponent

Vision component that renders multiple template instances inside it. Similar to the TemplateRepeater, but can render multiple, different templates and at custom positions within this container.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplateCanvas.LoadSpec
static enum	TemplateCanvas.ScrollBehavior

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COL_H
static final String	COL_LAYOUT
static final String	COL_NAME
static final String	COL_PARAMETERS
static final String	COL_TEMPLATE
static final String	COL_W
static final String	COL_X
static final String	COL_Y
static final String	COL_Z

Fields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanel

antialias, context, cursorCode, dynamicProps

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle

COMPONENT_RUNNING

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListener

LOCAL_CHANGE_EVENT

Fields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider

RESERVED_SET_KEY

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponent

COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS

Constructor Summary

Constructors

Constructor	Description
TemplateCanvas()

Method Summary

Modifier and Type	Method	Description
protected void	_finishBuilding(com.inductiveautomation.factorypmi.application.components.TemplateCanvas.LoadedTemplates templates)
List<PyComponentWrapper>	getAllTemplates()
Map<String,ExtensionFunction>	getExtensionFunctions()
String	getLayoutConstraints()
int	getScrollBehavior()
TemplateCanvas.ScrollBehavior	getScrollBehaviorEnum()
PyComponentWrapper	getTemplate(String name)
Dataset	getTemplates()
void	initialize()
boolean	isOpaque()
boolean	isShowLoading()
void	localeChanged(Locale newLocale)
protected void	onShutdown()	Subclasses should override this to provide shutdown logic.
protected void	onStartup()	Subclasses should override this to provide startup logic.
protected void	paintComponent(Graphics g)
protected void	rebuild()
protected void	rebuild(boolean force)	Rebuilds the UI, re-creating all the templates.
void	setExtensionFunctions(Map<String,ExtensionFunction> map)
void	setLayoutConstraints(String layoutConstraints)
void	setScrollBehavior(int scrollBehavior)
void	setShowLoading(boolean showLoading)
void	setTemplates(Dataset templates)

Methods inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanel

getAppContext, getCursorCode, getDataQuality, getDynamicProps, getProperties, getPropertyValue, getQuality, getStyles, getToolTipText, initStyleListener, isAntialias, isComponentRunning, isPropertyDefined, paintChildren, paintOverlayOverChildren, setAntialias, setCursorCode, setDataQuality, setDynamicProps, setName, setPropertyValue, setQuality, setStyles, setToolTipText, setVisible, shutdownComponent, startupComponent, translate, updateQuality

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle

getAppContext, shutdownComponent, startupComponent

Field Details

COL_PARAMETERS

public static final String COL_PARAMETERS

See Also:

• Constant Field Values

COL_TEMPLATE

public static final String COL_TEMPLATE

See Also:

• Constant Field Values

COL_NAME

public static final String COL_NAME

See Also:

• Constant Field Values

COL_X

public static final String COL_X

See Also:

• Constant Field Values

COL_Y

public static final String COL_Y

See Also:

• Constant Field Values

COL_W

public static final String COL_W

See Also:

• Constant Field Values

COL_H

public static final String COL_H

See Also:

• Constant Field Values

COL_Z

public static final String COL_Z

See Also:

• Constant Field Values

COL_LAYOUT

public static final String COL_LAYOUT

See Also:

• Constant Field Values

Constructor Details

TemplateCanvas

public TemplateCanvas()

Method Details

isOpaque

public boolean isOpaque()

Overrides:

isOpaque in class JComponent

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class AbstractVisionPanel

onShutdown

protected void onShutdown()

Description copied from class: AbstractVisionPanel

Subclasses should override this to provide shutdown logic.

Overrides:

onShutdown in class AbstractVisionPanel

onStartup

protected void onStartup()

Description copied from class: AbstractVisionPanel

Subclasses should override this to provide startup logic.

Overrides:

onStartup in class AbstractVisionPanel

rebuild

protected void rebuild(boolean force)

Rebuilds the UI, re-creating all the templates.

rebuild

protected void rebuild()

localeChanged

public void localeChanged(Locale newLocale)

Specified by:

localeChanged in interface LocaleListener

Overrides:

localeChanged in class AbstractVisionPanel

_finishBuilding

protected void _finishBuilding(com.inductiveautomation.factorypmi.application.components.TemplateCanvas.LoadedTemplates templates)

initialize

public void initialize()

Specified by:

initialize in interface DesignerInitializable

setTemplates

public void setTemplates(Dataset templates)

getTemplates

public Dataset getTemplates()

getAllTemplates

public List<PyComponentWrapper> getAllTemplates()

getTemplate

public PyComponentWrapper getTemplate(String name)

isShowLoading

public boolean isShowLoading()

setShowLoading

public void setShowLoading(boolean showLoading)

getScrollBehavior

public int getScrollBehavior()

setScrollBehavior

public void setScrollBehavior(int scrollBehavior)

getScrollBehaviorEnum

public TemplateCanvas.ScrollBehavior getScrollBehaviorEnum()

getLayoutConstraints

public String getLayoutConstraints()

setLayoutConstraints

public void setLayoutConstraints(String layoutConstraints)

getExtensionFunctions

public Map<String,ExtensionFunction> getExtensionFunctions()

Specified by:

getExtensionFunctions in interface ExtensibleComponent

setExtensionFunctions

public void setExtensionFunctions(Map<String,ExtensionFunction> map)

Specified by:

setExtensionFunctions in interface ExtensibleComponent