Package com.inductiveautomation.ignition.designer.propertyeditor.config

Class ConfigPropertyEditPanel<T extends PropertyConfigurationController>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.ignition.designer.propertyeditor.config.ConfigPropertyEditPanel<T>

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

TagGroupEditorPanel.TagGroupPropertyPanel, TagPropertyEditPanel

public class ConfigPropertyEditPanel<T extends PropertyConfigurationController>
extends JPanel

Holds the editor table and custom property button. Listens to property change events.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ConfigPropertyEditPanel.ConfigPropertyEditTable
protected class	ConfigPropertyEditPanel.EditorRenderer
protected class	ConfigPropertyEditPanel.PropWrapperEditObserver<T>

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
protected final DesignerContext	context
com.inductiveautomation.ignition.designer.propertyeditor.config.table.editor.ConfigPropertyEditorRenderer<T>	editor
protected static PropertyEditModel	EMPTY_EDIT_MODEL
protected Comparator<Property>	namePropertyFirst
protected DefaultPropertyPane	pane
com.inductiveautomation.ignition.designer.propertyeditor.config.table.editor.ConfigPropertyEditorRenderer<T>	renderer
protected ConfigPropertyTable	table
protected T	target

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	Description
ConfigPropertyEditPanel(DesignerContext context, boolean allowCustomProperties)

Method Summary

Modifier and Type	Method	Description
void	cancelEdit()
void	clear()
protected void	configureMenuForProperty(JPopupMenu menu, PropWrapper property)
protected ConfigPropTableModel	createModelFrom(List<PropWrapper> newModel)
protected DefaultPropertyPane	createPane(ConfigPropertyTable table)
protected ConfigPropertyEditPanel<T>.ConfigPropertyEditTable	createTable()
protected void	editCustomProperty(Property<?> current)
protected void	evaluateModelForPropertyChange(Property<?> prop)
protected List<?>	filterOptions(Property<?> prop, Collection<?> options)	We may want to further filter the options based on the prop
void	firePropertyValueUpdated(String property)
DefaultPropertyPane	getPane()
protected Component	getParentFrame()
protected Collection<Property<?>>	getPropertiesForTarget()
protected Property<?>	getPropertyAt(int row)
protected Object	getPropertyValue(Property<?> prop)
protected Property<?>	getSelectedProperty()
T	getTarget()
void	init(boolean allowCustomProperties)
protected void	initToolBar(boolean allowCustomProperties)
protected boolean	isCustomProperty(Property<?> prop)
protected boolean	isPropertyBindable(Property<?> prop)
protected boolean	isPropertyMetaMutable(T target, Property<?> prop)
protected boolean	isPropertyMutable(T target, Property<?> prop)
protected boolean	isPropertyVisible(T target, Property<?> prop)
protected void	onBeforePropertyChange(Property<?> prop, Object oldValue, Object newValue)
void	onPropertyChanged(Property<?> prop)	Should be called when we know a property has changed.
protected void	rebuildInternal()
protected void	rebuildModel()
void	setTarget(T target)
protected void	showCategory(Property<?> prop)
protected void	showCustomEditor(Property<?> prop, CustomPropertyEditor editor)
boolean	stopCellEditing()
protected <T> PropWrapper<T>	toWrapper(Property<T> prop)
protected boolean	validateEdit(Property<?> prop, Object newValue)

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, 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, 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

Field Details

EMPTY_EDIT_MODEL

protected static PropertyEditModel EMPTY_EDIT_MODEL

context

protected final DesignerContext context

pane

protected DefaultPropertyPane pane

table

protected ConfigPropertyTable table

target

protected T extends PropertyConfigurationController target

editor

public com.inductiveautomation.ignition.designer.propertyeditor.config.table.editor.ConfigPropertyEditorRenderer<T extends PropertyConfigurationController> editor

renderer

public com.inductiveautomation.ignition.designer.propertyeditor.config.table.editor.ConfigPropertyEditorRenderer<T extends PropertyConfigurationController> renderer

namePropertyFirst

protected Comparator<Property> namePropertyFirst

Constructor Details

ConfigPropertyEditPanel

public ConfigPropertyEditPanel(DesignerContext context,
 boolean allowCustomProperties)

Method Details

getTarget

public T getTarget()

setTarget

public void setTarget(T target)

clear

public void clear()

firePropertyValueUpdated

public void firePropertyValueUpdated(String property)

init

public void init(boolean allowCustomProperties)

createTable

protected ConfigPropertyEditPanel<T>.ConfigPropertyEditTable createTable()

createPane

protected DefaultPropertyPane createPane(ConfigPropertyTable table)

getPane

public DefaultPropertyPane getPane()

initToolBar

protected void initToolBar(boolean allowCustomProperties)

editCustomProperty

protected void editCustomProperty(Property<?> current)

getPropertyValue

protected Object getPropertyValue(Property<?> prop)

getSelectedProperty

protected Property<?> getSelectedProperty()

getPropertyAt

protected Property<?> getPropertyAt(int row)

isCustomProperty

protected boolean isCustomProperty(Property<?> prop)

rebuildModel

protected void rebuildModel()

evaluateModelForPropertyChange

protected void evaluateModelForPropertyChange(Property<?> prop)

cancelEdit

public void cancelEdit()

rebuildInternal

protected void rebuildInternal()

getPropertiesForTarget

protected Collection<Property<?>> getPropertiesForTarget()

stopCellEditing

public boolean stopCellEditing()

isPropertyVisible

protected boolean isPropertyVisible(T target,
 Property<?> prop)

isPropertyMutable

protected boolean isPropertyMutable(T target,
 Property<?> prop)

isPropertyMetaMutable

protected boolean isPropertyMetaMutable(T target,
 Property<?> prop)

createModelFrom

protected ConfigPropTableModel createModelFrom(List<PropWrapper> newModel)

validateEdit

protected boolean validateEdit(Property<?> prop,
 Object newValue)

isPropertyBindable

protected boolean isPropertyBindable(Property<?> prop)

filterOptions

protected List<?> filterOptions(Property<?> prop,
 Collection<?> options)

We may want to further filter the options based on the prop

toWrapper

protected <T> PropWrapper<T> toWrapper(Property<T> prop)

showCustomEditor

protected void showCustomEditor(Property<?> prop,
 CustomPropertyEditor editor)

showCategory

protected void showCategory(Property<?> prop)

configureMenuForProperty

protected void configureMenuForProperty(JPopupMenu menu,
 PropWrapper property)

onBeforePropertyChange

protected void onBeforePropertyChange(Property<?> prop,
 Object oldValue,
 Object newValue)
                               throws PropertyVetoException

Throws:

PropertyVetoException

getParentFrame

protected Component getParentFrame()

onPropertyChanged

public void onPropertyChanged(Property<?> prop)

Should be called when we know a property has changed. Public since occasionally that is handled externally, like for custom editors.