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,- java.awt.image.ImageObserver,- java.awt.MenuContainer,- java.io.Serializable,- javax.accessibility.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 SummaryNested Classes Modifier and Type Class Description static classTemplateCanvas.LoadSpecstatic classTemplateCanvas.ScrollBehavior- 
Nested classes/interfaces inherited from class javax.swing.JPaneljavax.swing.JPanel.AccessibleJPanel
 - 
Nested classes/interfaces inherited from class javax.swing.JComponentjavax.swing.JComponent.AccessibleJComponent
 
- 
 - 
Field SummaryFields Modifier and Type Field Description static java.lang.StringCOL_Hstatic java.lang.StringCOL_LAYOUTstatic java.lang.StringCOL_NAMEstatic java.lang.StringCOL_PARAMETERSstatic java.lang.StringCOL_TEMPLATEstatic java.lang.StringCOL_Wstatic java.lang.StringCOL_Xstatic java.lang.StringCOL_Ystatic java.lang.StringCOL_Z- 
Fields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanelantialias, context, cursorCode, dynamicProps
 - 
Fields inherited from class javax.swing.JComponentlistenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 - 
Fields inherited from class java.awt.ComponentaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 - 
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycleCOMPONENT_RUNNING
 - 
Fields inherited from interface java.awt.image.ImageObserverABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 - 
Fields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListenerLOCAL_CHANGE_EVENT
 - 
Fields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProviderRESERVED_SET_KEY
 - 
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponentCOMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS
 
- 
 - 
Constructor SummaryConstructors Constructor Description TemplateCanvas()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void_finishBuilding(com.inductiveautomation.factorypmi.application.components.TemplateCanvas.LoadedTemplates templates)java.util.List<PyComponentWrapper>getAllTemplates()java.util.Map<java.lang.String,ExtensionFunction>getExtensionFunctions()java.lang.StringgetLayoutConstraints()intgetScrollBehavior()TemplateCanvas.ScrollBehaviorgetScrollBehaviorEnum()PyComponentWrappergetTemplate(java.lang.String name)DatasetgetTemplates()voidinitialize()booleanisOpaque()booleanisShowLoading()voidlocaleChanged(java.util.Locale newLocale)protected voidonShutdown()Subclasses should override this to provide shutdown logic.protected voidonStartup()Subclasses should override this to provide startup logic.protected voidpaintComponent(java.awt.Graphics g)protected voidrebuild()protected voidrebuild(boolean force)Rebuilds the UI, re-creating all the templates.voidsetExtensionFunctions(java.util.Map<java.lang.String,ExtensionFunction> map)voidsetLayoutConstraints(java.lang.String layoutConstraints)voidsetScrollBehavior(int scrollBehavior)voidsetShowLoading(boolean showLoading)voidsetTemplates(Dataset templates)- 
Methods inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanelgetAppContext, 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.JPanelgetAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 - 
Methods inherited from class javax.swing.JComponentaddAncestorListener, 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.Containeradd, 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.Componentaction, 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.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecyclegetAppContext, shutdownComponent, startupComponent
 
- 
 
- 
- 
- 
Field Detail- 
COL_PARAMETERSpublic static final java.lang.String COL_PARAMETERS - See Also:
- Constant Field Values
 
 - 
COL_TEMPLATEpublic static final java.lang.String COL_TEMPLATE - See Also:
- Constant Field Values
 
 - 
COL_NAMEpublic static final java.lang.String COL_NAME - See Also:
- Constant Field Values
 
 - 
COL_Xpublic static final java.lang.String COL_X - See Also:
- Constant Field Values
 
 - 
COL_Ypublic static final java.lang.String COL_Y - See Also:
- Constant Field Values
 
 - 
COL_Wpublic static final java.lang.String COL_W - See Also:
- Constant Field Values
 
 - 
COL_Hpublic static final java.lang.String COL_H - See Also:
- Constant Field Values
 
 - 
COL_Zpublic static final java.lang.String COL_Z - See Also:
- Constant Field Values
 
 - 
COL_LAYOUTpublic static final java.lang.String COL_LAYOUT - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
isOpaquepublic boolean isOpaque() - Overrides:
- isOpaquein class- javax.swing.JComponent
 
 - 
paintComponentprotected void paintComponent(java.awt.Graphics g) - Overrides:
- paintComponentin class- AbstractVisionPanel
 
 - 
onShutdownprotected void onShutdown() Description copied from class:AbstractVisionPanelSubclasses should override this to provide shutdown logic.- Overrides:
- onShutdownin class- AbstractVisionPanel
 
 - 
onStartupprotected void onStartup() Description copied from class:AbstractVisionPanelSubclasses should override this to provide startup logic.- Overrides:
- onStartupin class- AbstractVisionPanel
 
 - 
rebuildprotected void rebuild(boolean force) Rebuilds the UI, re-creating all the templates.
 - 
rebuildprotected void rebuild() 
 - 
localeChangedpublic void localeChanged(java.util.Locale newLocale) - Specified by:
- localeChangedin interface- LocaleListener
- Overrides:
- localeChangedin class- AbstractVisionPanel
 
 - 
_finishBuildingprotected void _finishBuilding(com.inductiveautomation.factorypmi.application.components.TemplateCanvas.LoadedTemplates templates) 
 - 
initializepublic void initialize() - Specified by:
- initializein interface- DesignerInitializable
 
 - 
setTemplatespublic void setTemplates(Dataset templates) 
 - 
getTemplatespublic Dataset getTemplates() 
 - 
getAllTemplatespublic java.util.List<PyComponentWrapper> getAllTemplates() 
 - 
getTemplatepublic PyComponentWrapper getTemplate(java.lang.String name) 
 - 
isShowLoadingpublic boolean isShowLoading() 
 - 
setShowLoadingpublic void setShowLoading(boolean showLoading) 
 - 
getScrollBehaviorpublic int getScrollBehavior() 
 - 
setScrollBehaviorpublic void setScrollBehavior(int scrollBehavior) 
 - 
getScrollBehaviorEnumpublic TemplateCanvas.ScrollBehavior getScrollBehaviorEnum() 
 - 
getLayoutConstraintspublic java.lang.String getLayoutConstraints() 
 - 
setLayoutConstraintspublic void setLayoutConstraints(java.lang.String layoutConstraints) 
 - 
getExtensionFunctionspublic java.util.Map<java.lang.String,ExtensionFunction> getExtensionFunctions() - Specified by:
- getExtensionFunctionsin interface- ExtensibleComponent
 
 - 
setExtensionFunctionspublic void setExtensionFunctions(java.util.Map<java.lang.String,ExtensionFunction> map) - Specified by:
- setExtensionFunctionsin interface- ExtensibleComponent
 
 
- 
 
-