Package com.inductiveautomation.factorypmi.application.components.template

Class TemplateHolder

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.template.TemplateHolder

All Implemented Interfaces:

DeferredPropertyDescriptor, DynamicPropertyProvider, TemplateListener, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, QualityMonitor, VisionComponent, ImageObserver, MenuContainer, Serializable, Accessible

public class TemplateHolder
extends AbstractVisionPanel
implements TemplateListener, DeferredPropertyDescriptor

See Also:

• Serialized Form

Nested Class Summary

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 Overlay	errorOverlay

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
TemplateHolder()

Method Summary

Modifier and Type	Method	Description
DynamicPropertyDescriptor	getDropTargetProperty()
VisionTemplate	getLoadedTemplate()
Map<String,Object>	getParameterValues()
DynamicPropertyDescriptor[]	getProperties()
Object	getPropertyValue(String name)
String	getTemplatePath()
void	initTemplate(VisionClientContext context)	This call comes in when the window (or any UI root) that we belong to is opened.
boolean	isPropertyDefined(String name)
protected void	loadTemplate(VisionClientContext context)
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)
void	setName(String newName)
void	setParameterValues(Map<String,Object> parameterValues)
void	setPropertyValue(String name, Object value)
void	setTemplatePath(String templatePath)
protected void	setupLogger()
protected void	startupTemplate()
void	templateRemoved(TemplateEvent event)
void	templateUpdated(TemplateEvent event)

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

getAppContext, getCursorCode, getDataQuality, getDynamicProps, getQuality, getStyles, getToolTipText, initStyleListener, isAntialias, isComponentRunning, localeChanged, paintChildren, paintOverlayOverChildren, setAntialias, setCursorCode, setDataQuality, setDynamicProps, 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, isOpaque, 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

Field Details

errorOverlay

public static Overlay errorOverlay

Constructor Details

TemplateHolder

public TemplateHolder()

Method Details

setName

public void setName(String newName)

Overrides:

setName in class AbstractVisionPanel

setupLogger

protected void setupLogger()

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class AbstractVisionPanel

getLoadedTemplate

public VisionTemplate getLoadedTemplate()

getTemplatePath

public String getTemplatePath()

setTemplatePath

public void setTemplatePath(String templatePath)

getParameterValues

public Map<String,Object> getParameterValues()

setParameterValues

public void setParameterValues(Map<String,Object> parameterValues)

getDropTargetProperty

public DynamicPropertyDescriptor getDropTargetProperty()

loadTemplate

protected void loadTemplate(VisionClientContext context)

startupTemplate

protected void startupTemplate()

templateRemoved

public void templateRemoved(TemplateEvent event)

Specified by:

templateRemoved in interface TemplateListener

templateUpdated

public void templateUpdated(TemplateEvent event)

Specified by:

templateUpdated in interface TemplateListener

initTemplate

public void initTemplate(VisionClientContext context)

This call comes in when the window (or any UI root) that we belong to is opened.

onStartup

protected void onStartup()

Description copied from class: AbstractVisionPanel

Subclasses should override this to provide startup logic.

Overrides:

onStartup 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

getProperties

public DynamicPropertyDescriptor[] getProperties()

Specified by:

getProperties in interface DynamicPropertyProvider

Overrides:

getProperties in class AbstractVisionPanel

getPropertyValue

public Object getPropertyValue(String name)

Specified by:

getPropertyValue in interface DynamicPropertyProvider

Overrides:

getPropertyValue in class AbstractVisionPanel

setPropertyValue

public void setPropertyValue(String name,
 Object value)
                      throws ClassCastException

Specified by:

setPropertyValue in interface DynamicPropertyProvider

Overrides:

setPropertyValue in class AbstractVisionPanel

Throws:

ClassCastException

isPropertyDefined

public boolean isPropertyDefined(String name)

Specified by:

isPropertyDefined in interface DynamicPropertyProvider

Overrides:

isPropertyDefined in class AbstractVisionPanel