com.inductiveautomation.factorypmi.designer.property.customizers

Class DynamicPropertyProviderCustomizer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.factorypmi.designer.property.customizers.DynamicPropertyProviderCustomizer

All Implemented Interfaces:

VisionCustomizer, VisionCustomizer.DisplayListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.Customizer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

PublicPrivateCustomPropertyCustomizer

public class DynamicPropertyProviderCustomizer
extends javax.swing.JPanel
implements VisionCustomizer, VisionCustomizer.DisplayListener

The customizer that can be added to any component that is a MutableDynamicPropertyProvider to configure their properties.

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

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface com.inductiveautomation.vision.api.designer.beans.VisionCustomizer

VisionCustomizer.DisplayListener

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Class[]	ALL_CLASSES
protected DesignerContext	context
protected static java.lang.Class[]	DATASET_ONLY
protected MutableDynamicPropertyProvider	provider
static CustomizerDescriptor	VALUE_DESCRIPTOR

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
DynamicPropertyProviderCustomizer()

Method Summary

Modifier and Type	Method and Description
void	cancel()
static void	checkDynamicPropertyName(DynamicPropertyProvider provider, java.lang.String name, java.util.Set<java.lang.String> collisionDetection)
boolean	externalScroll() Return true if you want to be placed in a scroll pane externally
protected java.util.List<com.inductiveautomation.factorypmi.designer.property.customizers.DPDProxy>	getNewPropertyList()
protected static DynamicPropertyDescriptor[]	getProperties(MutableDynamicPropertyProvider provider)
protected java.util.ArrayList<com.inductiveautomation.factorypmi.designer.property.customizers.CustomPropertyEditPanel.PropertyAdapterConfig>	getRemovedPropertyAdapterList()
protected java.util.HashSet<com.inductiveautomation.factorypmi.designer.property.customizers.DPDProxy>	getRemovedPropertySet()
protected void	init()
protected void	initCollisionList(java.util.Set<java.lang.String> collisionDetection)
protected void	initTitle(javax.swing.JDialog owner)
static void	main(java.lang.String[] args)
void	notifyDisplayed() Called when the customizer is displayed on the screen
static PropertyAdapter	renameProperty(java.awt.Component source, java.lang.String oldName, java.lang.String newName) Alters any dependent interactions on the old property name so that they rely on the new name instead.
void	setContext(DesignerContext context)
void	setObject(java.lang.Object bean)
void	setObjects(java.util.List beans)
void	setOwner(javax.swing.JDialog dlg)
protected void	stopTableEditing() Should call CustomPropertyEditPanel.stop() on any installed edit panels.
boolean	tryCommit()
boolean	tryCommit(MutableDynamicPropertyProvider provider, java.util.List<com.inductiveautomation.factorypmi.designer.property.customizers.DPDProxy> newPropertyList, java.awt.Component parentComponent, DesignerContext context, java.util.ArrayList<com.inductiveautomation.factorypmi.designer.property.customizers.CustomPropertyEditPanel.PropertyAdapterConfig> undoRemovePropertyAdapterCongigs)

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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, 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 java.beans.Customizer

addPropertyChangeListener, removePropertyChangeListener

Field Detail

VALUE_DESCRIPTOR

public static final CustomizerDescriptor VALUE_DESCRIPTOR

ALL_CLASSES

protected static final java.lang.Class[] ALL_CLASSES

DATASET_ONLY

protected static final java.lang.Class[] DATASET_ONLY

provider

protected MutableDynamicPropertyProvider provider

context

protected DesignerContext context

Constructor Detail

DynamicPropertyProviderCustomizer

public DynamicPropertyProviderCustomizer()

Method Detail

checkDynamicPropertyName

public static void checkDynamicPropertyName(DynamicPropertyProvider provider,
                                            java.lang.String name,
                                            java.util.Set<java.lang.String> collisionDetection)
                                     throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

setContext

public void setContext(DesignerContext context)

Specified by:

setContext in interface VisionCustomizer

setOwner

public void setOwner(javax.swing.JDialog dlg)

Specified by:

setOwner in interface VisionCustomizer

externalScroll

public boolean externalScroll()

Description copied from interface: VisionCustomizer

Return true if you want to be placed in a scroll pane externally

Specified by:

externalScroll in interface VisionCustomizer

cancel

public void cancel()

Specified by:

cancel in interface VisionCustomizer

setObject

public void setObject(java.lang.Object bean)

Specified by:

setObject in interface java.beans.Customizer

setObjects

public void setObjects(java.util.List beans)

Specified by:

setObjects in interface VisionCustomizer

initTitle

protected void initTitle(javax.swing.JDialog owner)

init

protected void init()

getProperties

protected static DynamicPropertyDescriptor[] getProperties(MutableDynamicPropertyProvider provider)

notifyDisplayed

public void notifyDisplayed()

Description copied from interface: VisionCustomizer.DisplayListener

Called when the customizer is displayed on the screen

Specified by:

notifyDisplayed in interface VisionCustomizer.DisplayListener

stopTableEditing

protected void stopTableEditing()

Should call CustomPropertyEditPanel.stop() on any installed edit panels.

getNewPropertyList

protected java.util.List<com.inductiveautomation.factorypmi.designer.property.customizers.DPDProxy> getNewPropertyList()

getRemovedPropertySet

protected java.util.HashSet<com.inductiveautomation.factorypmi.designer.property.customizers.DPDProxy> getRemovedPropertySet()

getRemovedPropertyAdapterList

protected java.util.ArrayList<com.inductiveautomation.factorypmi.designer.property.customizers.CustomPropertyEditPanel.PropertyAdapterConfig> getRemovedPropertyAdapterList()

initCollisionList

protected void initCollisionList(java.util.Set<java.lang.String> collisionDetection)

tryCommit

public boolean tryCommit(MutableDynamicPropertyProvider provider,
                         java.util.List<com.inductiveautomation.factorypmi.designer.property.customizers.DPDProxy> newPropertyList,
                         java.awt.Component parentComponent,
                         DesignerContext context,
                         java.util.ArrayList<com.inductiveautomation.factorypmi.designer.property.customizers.CustomPropertyEditPanel.PropertyAdapterConfig> undoRemovePropertyAdapterCongigs)

tryCommit

public boolean tryCommit()

Specified by:

tryCommit in interface VisionCustomizer

renameProperty

public static PropertyAdapter renameProperty(java.awt.Component source,
                                             java.lang.String oldName,
                                             java.lang.String newName)

Alters any dependent interactions on the old property name so that they rely on the new name instead. Doesn't actually rename the dynamic property on the source component.

main

public static void main(java.lang.String[] args)