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
,java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.beans.VetoableChangeListener
,java.io.Serializable
,java.util.EventListener
,javax.accessibility.Accessible
public class VisionTemplate extends BasicContainer implements TopLevelContainer
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
OPEN_AS_DESIGN_MASTER
-
Fields inherited from class com.inductiveautomation.factorypmi.application.components.BasicContainer
PANEL_CONTAINS_DEFAULT_BTN
-
Fields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanel
antialias, 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.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 VisionTemplate()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
assignInstanceName(java.lang.String instanceName)
There is a reason this doesn't follow proper bean naming: it needs to be read-only.java.util.List<javax.swing.JComponent>
getChildrenForSerialization()
java.awt.Component
getComponentForPath(java.lang.String path)
DynamicPropertyDescriptor
getDropTargetProperty()
java.lang.String
getInstanceName()
InteractionController
getInteractionController()
java.lang.String
getPathForComponent(java.awt.Component component)
ResourcePath
getResourcePath()
void
initialize(VisionClientContext context)
Connect adapters, UDTInit, BindingInitboolean
isEnableLayout()
boolean
isInstalled()
boolean
isPropertyDefinedAndPublic(java.lang.String name)
boolean
isStarted()
boolean
layoutAsGroup()
protected void
paintBackground(java.awt.Graphics g)
void
setChildrenForSerialization(java.util.List<javax.swing.JComponent> children)
void
setEnableLayout(boolean enableLayout)
void
setGroup(boolean group)
void
setHeight(int newHeight)
void
setInstanceName(java.lang.String dummy)
Deprecated.void
setInteractionController(InteractionController controller)
void
setResourcePath(ResourcePath resourcePath)
void
setSize(int width, int height)
Overridden to get rid of the bounds2d rectangle that FPMILayout will put here.void
setWidth(int newWidth)
void
shutdown()
Shutdown the root.void
startup()
Startup Adapters, startup components-
Methods inherited from class com.inductiveautomation.factorypmi.application.components.BasicContainer
add, addComponent, getComponent, getNextName, getPosition, getSpringInfo, getSpringLayout, getTexturePath, initializeName, isCombineRepaints, isGroup, isOffsettingContainer, isOpaque, 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, vetoableChange
-
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, localeChanged, onShutdown, onStartup, paintChildren, 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, 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, update
-
Methods inherited from class java.awt.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, 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, show, show, size, 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
-
Methods inherited from interface com.inductiveautomation.ignition.client.designable.DesignableContainer
addPropertyChangeListener, addPropertyChangeListener, getClientProperty, getName, putClientProperty, removePropertyChangeListener, removePropertyChangeListener
-
Methods inherited from interface com.inductiveautomation.vision.api.client.components.model.QualityMonitor
getDataQuality, getQuality, setDataQuality, setQuality, updateQuality
-
Methods inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionContainer
getComponent, getComponentCount, getComponents, getParent, repaint, revalidate
-
-
-
-
Field Detail
-
OPEN_AS_DESIGN_MASTER
public static final java.lang.String OPEN_AS_DESIGN_MASTER
- See Also:
- Constant Field Values
-
-
Method Detail
-
getPathForComponent
public java.lang.String getPathForComponent(java.awt.Component component)
- Specified by:
getPathForComponent
in interfaceBindingRoot
-
getComponentForPath
public java.awt.Component getComponentForPath(java.lang.String path)
- Specified by:
getComponentForPath
in interfaceBindingRoot
-
assignInstanceName
public void assignInstanceName(java.lang.String instanceName)
There is a reason this doesn't follow proper bean naming: it needs to be read-only.
-
setInstanceName
@Deprecated public void setInstanceName(java.lang.String dummy)
Deprecated.
-
getInstanceName
public java.lang.String getInstanceName()
-
isEnableLayout
public boolean isEnableLayout()
-
setEnableLayout
public void setEnableLayout(boolean enableLayout)
-
layoutAsGroup
public boolean layoutAsGroup()
- Specified by:
layoutAsGroup
in interfaceVisionContainer
- Overrides:
layoutAsGroup
in 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:
setGroup
in classBasicContainer
-
setWidth
public void setWidth(int newWidth)
-
setHeight
public void setHeight(int newHeight)
-
setSize
public void setSize(int width, int height)
Overridden to get rid of the bounds2d rectangle that FPMILayout will put here.- Overrides:
setSize
in classjava.awt.Component
-
initialize
public void initialize(VisionClientContext context)
Connect adapters, UDTInit, BindingInit- Specified by:
initialize
in interfaceBindingRoot
-
startup
public void startup()
Startup Adapters, startup components- Specified by:
startup
in interfaceBindingRoot
-
isStarted
public boolean isStarted()
-
shutdown
public void shutdown()
Description copied from interface:BindingRoot
Shutdown the root. Shut-down adapters, and shut-down any children ComponentLifecycles.- Specified by:
shutdown
in interfaceBindingRoot
-
paintBackground
protected void paintBackground(java.awt.Graphics g)
- Overrides:
paintBackground
in classBasicContainer
-
getChildrenForSerialization
public java.util.List<javax.swing.JComponent> getChildrenForSerialization()
-
setChildrenForSerialization
public void setChildrenForSerialization(java.util.List<javax.swing.JComponent> children)
-
getInteractionController
public InteractionController getInteractionController()
- Specified by:
getInteractionController
in interfaceBindingRoot
-
setInteractionController
public void setInteractionController(InteractionController controller)
-
isPropertyDefinedAndPublic
public boolean isPropertyDefinedAndPublic(java.lang.String name)
-
getDropTargetProperty
public DynamicPropertyDescriptor getDropTargetProperty()
-
getResourcePath
public ResourcePath getResourcePath()
- Specified by:
getResourcePath
in interfaceDesignableContainer
-
setResourcePath
public void setResourcePath(ResourcePath resourcePath)
-
-