Class VisionTemplate
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.BasicContainer
com.inductiveautomation.factorypmi.application.components.template.VisionTemplate
- All Implemented Interfaces:
BindingRoot, DynamicPropertyProvider, DesignableContainer, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, QualityMonitor, TopLevelContainer, VisionComponent, VisionContainer, ImageObserver, MenuContainer, VetoableChangeListener, Serializable, EventListener, Accessible
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class JPanel
JPanel.AccessibleJPanelNested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsFields inherited from class BasicContainer
PANEL_CONTAINS_DEFAULT_BTNFields inherited from class AbstractVisionPanel
antialias, context, cursorCode, dynamicPropsFields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface ComponentLifecycle
COMPONENT_RUNNINGFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface LocaleListener
LOCAL_CHANGE_EVENTFields inherited from interface MutableDynamicPropertyProvider
RESERVED_SET_KEYFields inherited from interface VisionComponent
COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidassignInstanceName(String instanceName) There is a reason this doesn't follow proper bean naming: it needs to be read-only.getComponentForPath(String path) getPathForComponent(Component component) voidinitialize(VisionClientContext context) Connect adapters, UDTInit, BindingInitbooleanbooleanbooleanbooleanReturns true if this BindingRoot is considered to be running/active.booleanprotected voidvoidsetChildrenForSerialization(List<JComponent> children) voidsetEnableLayout(boolean enableLayout) voidsetGroup(boolean group) voidsetHeight(int newHeight) voidsetInstanceName(String dummy) Deprecated.voidsetInteractionController(InteractionController controller) voidsetResourcePath(ResourcePath resourcePath) voidsetSize(int width, int height) Overridden to get rid of the bounds2d rectangle that FPMILayout will put here.voidsetWidth(int newWidth) voidshutdown()Shutdown the root.voidstartup()Startup Adapters, startup componentsMethods inherited from class BasicContainer
add, addComponent, getComponent, getNextName, getPosition, getSpringInfo, getSpringLayout, getTexturePath, initializeName, isCombineRepaints, isGroup, isOffsettingContainer, isOptimizedDrawingEnabled, moveBackward, moveForward, moveToBack, moveToFront, paintComponent, paintOverlayOverChildren, paintTexture, privateAdd, putSpringInfo, remove, sanitizeName, setBackground, setBoundsEx, setCombineRepaints, setForeground, setLayout, setLocked, setOpaque, setOptimizedDrawingEnabled, setPosition, setPreferredBoundsEx, setRotation, setSecuritySettings, setTexturePath, toString, validateName, validateName, vetoableChangeMethods inherited from class AbstractVisionPanel
getAppContext, getCursorCode, getDataQuality, getDynamicProps, getProperties, getPropertyValue, getQuality, getStyles, getToolTipText, initStyleListener, isAntialias, isComponentRunning, isPropertyDefined, localeChanged, onShutdown, onStartup, paintChildren, setAntialias, setCursorCode, setDataQuality, setDynamicProps, setName, setPropertyValue, setQuality, setStyles, setToolTipText, setVisible, shutdownComponent, startupComponent, translate, updateQualityMethods inherited from class JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class 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, isOpaque, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, updateMethods inherited from class Container
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, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTreeMethods inherited from class 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, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycleMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface ComponentLifecycle
getAppContext, shutdownComponent, startupComponentMethods inherited from interface DesignableContainer
addPropertyChangeListener, addPropertyChangeListener, getClientProperty, getName, putClientProperty, removePropertyChangeListener, removePropertyChangeListenerMethods inherited from interface QualityMonitor
getDataQuality, getQuality, setDataQuality, setQuality, updateQualityMethods inherited from interface VisionContainer
getComponent, getComponentCount, getComponents, getParent, repaint, revalidate
-
Field Details
-
OPEN_AS_DESIGN_MASTER
- See Also:
-
-
Constructor Details
-
VisionTemplate
public VisionTemplate()
-
-
Method Details
-
getPathForComponent
- Specified by:
getPathForComponentin interfaceBindingRoot
-
getComponentForPath
- Specified by:
getComponentForPathin interfaceBindingRoot
-
assignInstanceName
There is a reason this doesn't follow proper bean naming: it needs to be read-only. -
setInstanceName
Deprecated. -
getInstanceName
-
isEnableLayout
public boolean isEnableLayout() -
setEnableLayout
public void setEnableLayout(boolean enableLayout) -
layoutAsGroup
public boolean layoutAsGroup()- Specified by:
layoutAsGroupin interfaceVisionContainer- Overrides:
layoutAsGroupin classBasicContainer
-
isInstalled
public boolean isInstalled()- Returns:
- true if this template is installed as a template instance. False if the template is open as a design master
-
setGroup
public void setGroup(boolean group) - Overrides:
setGroupin classBasicContainer
-
setWidth
public void setWidth(int newWidth) -
setHeight
public void setHeight(int newHeight) -
setSize
-
initialize
Connect adapters, UDTInit, BindingInit- Specified by:
initializein interfaceBindingRoot
-
startup
public void startup()Startup Adapters, startup components- Specified by:
startupin interfaceBindingRoot
-
isStarted
public boolean isStarted()Description copied from interface:BindingRootReturns true if this BindingRoot is considered to be running/active. Typically, this means that its initialized, started, and hasn't been shutdown.- Specified by:
isStartedin interfaceBindingRoot
-
shutdown
public void shutdown()Description copied from interface:BindingRootShutdown the root. Shut-down adapters, and shut-down any children ComponentLifecycles.- Specified by:
shutdownin interfaceBindingRoot
-
paintBackground
- Overrides:
paintBackgroundin classBasicContainer
-
getChildrenForSerialization
-
setChildrenForSerialization
-
getInteractionController
- Specified by:
getInteractionControllerin interfaceBindingRoot
-
setInteractionController
-
isPropertyDefinedAndPublic
-
getDropTargetProperty
-
getResourcePath
- Specified by:
getResourcePathin interfaceDesignableContainer
-
setResourcePath
-
getTemplateContext
- Returns:
- the client context used when this template was initialized
-