Package com.inductiveautomation.sfc.designer.workspace.editors

Class ExpressionParamTable

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.ignition.client.util.gui.SlidingPane

com.inductiveautomation.sfc.designer.workspace.editors.ExpressionParamTable

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class ExpressionParamTable
extends SlidingPane

A SlidingPane which toggles between an AbstractCRUDTable of type ExpressionParam and a CodeEditor which is visible when an expression cell from the table is edited.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.client.util.gui.SlidingPane

SlidingPane.Layout

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 final String	CHILD_EDITING_PROPERTY	This property is for detecting if one of the children of this component which is able to handle the Designer's edit actions is "active" (whether that be "focused" or "selected" depends on the child).

Fields inherited from class com.inductiveautomation.ignition.client.util.gui.SlidingPane

previousSelection, SELECTED_PANE_PROPERTY, selectedPane

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
ExpressionParamTable(DesignerContext context, Property<ExpressionParamCollection> property, String nounKey, boolean showKeyColumn)

Method Summary

Modifier and Type	Method	Description
void	commit()
protected com.inductiveautomation.sfc.designer.workspace.editors.ExpressionParamTable.ChildActiveEditActionHandlerFocusAdapter	createChildActiveEditActionHandlerFocusAdapter(Component parent, DelegatingEditActionHandler delegator, EditActionHandler delegate)	Internal factory method for creating new ExpressionParamTable.ChildActiveEditActionHandlerFocusAdapter instances injected with the given parent Component which owns the delegator, DelegatingEditActionHandler delegator used to delegate handling of the Designer's edit actions to EditActionHandlers of children of the given parent component, and EditActionHandler delegate which will be delegated the handling of the edit actions of the Designer when its component is focused
protected CodeEditorEditActionHandler	createCodeEditorEditActionHandler(com.jidesoft.editor.CodeEditor codeEditor)	Internal factory method for creating new CodeEditorEditActionHandlers injected with the given CodeEditor
protected ExpressionParamCollection	createDefaultCollection()
EditActionHandler	getEditActionHandler()	Getter for the EditActionHandler for this table
protected boolean	isChildEditing()	Whether or not a child of this table which can handle edit actions is currently in edit mode
protected void	setChildEditing(boolean childEditing)	Setter for whether or not a child of this table which can handle edit actions is currently in edit mode.
void	setElement(ChartUIElement element)

Methods inherited from class com.inductiveautomation.ignition.client.util.gui.SlidingPane

addImpl, getSelectedPane, removeAll, setBorder, setSelectedPane

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

CHILD_EDITING_PROPERTY

public static final String CHILD_EDITING_PROPERTY

This property is for detecting if one of the children of this component which is able to handle the Designer's edit actions is "active" (whether that be "focused" or "selected" depends on the child). This provides one clean hook for the parent of this component to understand whether or not it should delegate its edit action handling to this component.

See Also:

• Constant Field Values

Constructor Details

ExpressionParamTable

public ExpressionParamTable(DesignerContext context,
 Property<ExpressionParamCollection> property,
 String nounKey,
 boolean showKeyColumn)

Method Details

isChildEditing

protected boolean isChildEditing()

Whether or not a child of this table which can handle edit actions is currently in edit mode

Returns:

true if a child of this table which can handle edit actions is currently in edit mode, false otherwise

setChildEditing

protected void setChildEditing(boolean childEditing)

Setter for whether or not a child of this table which can handle edit actions is currently in edit mode. Fires the childEditing property change event which can be a useful hook for listeners to be aware when a child is editing (i.e. for delegating the Designer's edit actions)

Parameters:

childEditing - true if a child of this table which can handle edit actions is currently in edit mode, false otherwise

See Also:

• CHILD_EDITING_PROPERTY

createChildActiveEditActionHandlerFocusAdapter

protected com.inductiveautomation.sfc.designer.workspace.editors.ExpressionParamTable.ChildActiveEditActionHandlerFocusAdapter createChildActiveEditActionHandlerFocusAdapter(Component parent,
 DelegatingEditActionHandler delegator,
 EditActionHandler delegate)

Internal factory method for creating new ExpressionParamTable.ChildActiveEditActionHandlerFocusAdapter instances injected with the given parent Component which owns the delegator, DelegatingEditActionHandler delegator used to delegate handling of the Designer's edit actions to EditActionHandlers of children of the given parent component, and EditActionHandler delegate which will be delegated the handling of the edit actions of the Designer when its component is focused

Parameters:

parent - The parent Component which owns the delegator

delegator - The DelegatingEditActionHandler to inject

delegate - The EditActionHandler to inject

Returns:

The new ExpressionParamTable.ChildActiveEditActionHandlerFocusAdapter instance

See Also:

• #createChildActiveEditActionHandlerFocusAdapter(EditActionHandler)

createCodeEditorEditActionHandler

protected CodeEditorEditActionHandler createCodeEditorEditActionHandler(com.jidesoft.editor.CodeEditor codeEditor)

Internal factory method for creating new CodeEditorEditActionHandlers injected with the given CodeEditor

Parameters:

codeEditor - The CodeEditor to inject

Returns:

The new CodeEditorEditActionHandler instance

setElement

public void setElement(ChartUIElement element)

commit

public void commit()

createDefaultCollection

protected ExpressionParamCollection createDefaultCollection()

getEditActionHandler

public EditActionHandler getEditActionHandler()

Getter for the EditActionHandler for this table

Returns:

The EditActionHandler for this table