Package com.inductiveautomation.perspective.designer.sessionevents

Class KeyEventScriptEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.ignition.designer.scripteditor.GlobalScriptEditor.ScriptConfigPanel

com.inductiveautomation.ignition.designer.scripteditor.AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

com.inductiveautomation.perspective.designer.sessionevents.KeyEventScriptEditor

All Implemented Interfaces:

Locatable, ImageObserver, MenuContainer, Serializable, Accessible

public class KeyEventScriptEditor
extends AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

Class containing the Key Event configuration selector/editor, the script editor, and the dialog to build a key event.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractMultiExtensionFunctionScriptEditor

AbstractMultiExtensionFunctionScriptEditor.SelectionListener

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 inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractMultiExtensionFunctionScriptEditor

currentEdit, list, LIST_DISABLED, LIST_NORMAL, listModel, scriptArea, scripts, splitPane

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

Method Summary

Modifier and Type	Method	Description
protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	buildDescriptor()
protected KeyEvent	chooseNewKey()
protected void	configureListCell(JLabel cell, KeyEvent key, boolean selected)
protected JPanel	getConfigPanel(KeyEvent key)
protected Icon	getDeleteIcon()
String	getFunctionValue()	The identifier stored in the TagReferenceLocation.FUNCTION_KEY when this type of script is executed.
Icon	getIcon()
protected Icon	getNewIcon()
protected String	getNoun()	Return of name of the thing being configured, "timer" for "timer scripts", etc."
protected Icon	getReconfigureIcon()
protected Map<KeyEvent,String>	getScripts(ScriptConfig sc)
String	getTitleKey()	A resource key that will be used for the title and description as follows: titleKey + ".Title" and titleKey + ".Desc"
protected boolean	isReconfigureActionPresent()	Should item's keys be reconfigurable?
protected KeyEvent	reconfigureKey(KeyEvent key)
protected void	storeScripts(ScriptConfig sc, Map<KeyEvent,String> keyEventScripts)
protected String	toLocatableValue(KeyEvent key)

Methods inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractMultiExtensionFunctionScriptEditor

createScriptEditor, doDelete, doNew, doReconfigure, doSave, getCappedNoun, getCompilableScript, getDefaultNewScript, getScriptEditorPanel, getUserScript, init, initComponents, installHints, locate, setUserScript, toString

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

Constructor Details

KeyEventScriptEditor

public KeyEventScriptEditor()

Method Details

buildDescriptor

protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor buildDescriptor()

Specified by:

buildDescriptor in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

isReconfigureActionPresent

protected boolean isReconfigureActionPresent()

Description copied from class: AbstractMultiExtensionFunctionScriptEditor

Should item's keys be reconfigurable?

Specified by:

isReconfigureActionPresent in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

configureListCell

protected void configureListCell(JLabel cell,
 KeyEvent key,
 boolean selected)

Overrides:

configureListCell in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

getNoun

protected String getNoun()

Description copied from class: AbstractMultiExtensionFunctionScriptEditor

Return of name of the thing being configured, "timer" for "timer scripts", etc."

Specified by:

getNoun in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

getNewIcon

protected Icon getNewIcon()

Specified by:

getNewIcon in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

getDeleteIcon

protected Icon getDeleteIcon()

Specified by:

getDeleteIcon in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

getReconfigureIcon

protected Icon getReconfigureIcon()

Specified by:

getReconfigureIcon in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

chooseNewKey

protected KeyEvent chooseNewKey()

Specified by:

chooseNewKey in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

reconfigureKey

protected KeyEvent reconfigureKey(KeyEvent key)

Specified by:

reconfigureKey in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

getConfigPanel

protected JPanel getConfigPanel(KeyEvent key)

getScripts

protected Map<KeyEvent,String> getScripts(ScriptConfig sc)

Specified by:

getScripts in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

storeScripts

protected void storeScripts(ScriptConfig sc,
 Map<KeyEvent,String> keyEventScripts)

Specified by:

storeScripts in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>

getTitleKey

public String getTitleKey()

Description copied from class: GlobalScriptEditor.ScriptConfigPanel

A resource key that will be used for the title and description as follows: titleKey + ".Title" and titleKey + ".Desc"

Specified by:

getTitleKey in class GlobalScriptEditor.ScriptConfigPanel

getIcon

public Icon getIcon()

Specified by:

getIcon in class GlobalScriptEditor.ScriptConfigPanel

getFunctionValue

public String getFunctionValue()

Description copied from class: GlobalScriptEditor.ScriptConfigPanel

The identifier stored in the TagReferenceLocation.FUNCTION_KEY when this type of script is executed. Additional disambiguation should be stored in TagReferenceLocation.SCRIPT_KEY

Specified by:

getFunctionValue in class GlobalScriptEditor.ScriptConfigPanel

See Also:

• ScriptConfig.STARTUP_LOCATION_VALUE
• ScriptConfig.TIMER_SCRIPT_VALUE

toLocatableValue

protected String toLocatableValue(KeyEvent key)

Specified by:

toLocatableValue in class AbstractMultiExtensionFunctionScriptEditor<KeyEvent>