Package com.inductiveautomation.ignition.designer.scripteditor

Class AbstractMultiExtensionFunctionScriptEditor<K extends Comparable<K>>

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

Type Parameters:

K - The key to store the scripts under.

All Implemented Interfaces:

Locatable, ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

KeyEventScriptEditor, MessageHandlerEditor

public abstract class AbstractMultiExtensionFunctionScriptEditor<K extends Comparable<K>>
extends GlobalScriptEditor.ScriptConfigPanel
implements Locatable

An alternative to AbstractMultiScriptEditor, which embeds a 'modern' ExtensionFunctionPanel instead.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	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

Modifier and Type	Field	Description
protected K	currentEdit
protected JList<K>	list
protected static Font	LIST_DISABLED
protected static Font	LIST_NORMAL
protected MapListModel	listModel
protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel	scriptArea
protected Map<K,String>	scripts
protected JSplitPane	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

Modifier	Constructor	Description
protected	AbstractMultiExtensionFunctionScriptEditor()

Method Summary

Modifier and Type	Method	Description
protected abstract com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	buildDescriptor()
protected abstract K	chooseNewKey()
protected void	configureListCell(JLabel cell, K item, boolean isSelected)
protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel	createScriptEditor()
protected void	doDelete()
protected void	doNew()
protected void	doReconfigure()
void	doSave(ScriptConfig sc)
protected String	getCappedNoun()
protected String	getCompilableScript(K key)	Retrieve a compileable version of the script under key.
protected String	getDefaultNewScript()
protected abstract Icon	getDeleteIcon()
protected abstract Icon	getNewIcon()
protected abstract String	getNoun()	Return of name of the thing being configured, "timer" for "timer scripts", etc."
protected abstract Icon	getReconfigureIcon()
protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel	getScriptEditorPanel()
protected abstract Map<K,String>	getScripts(ScriptConfig sc)
protected String	getUserScript()	Retrieve the script to actually store into the scripts map.
boolean	init(ScriptConfig sc)
protected void	initComponents()
void	installHints(Map<String,List<ScriptFunctionHint>> hints)
protected abstract boolean	isReconfigureActionPresent()	Should item's keys be reconfigurable?
void	locate(Location location)
protected abstract K	reconfigureKey(K key)
protected void	setUserScript(K key)	Apply the script from key to the current script area.
protected abstract void	storeScripts(ScriptConfig sc, Map<K,String> scripts)
protected abstract String	toLocatableValue(K key)
protected String	toString(K key)

Methods inherited from class com.inductiveautomation.ignition.designer.scripteditor.GlobalScriptEditor.ScriptConfigPanel

getFunctionValue, getIcon, getTitleKey

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

splitPane

protected JSplitPane splitPane

scriptArea

protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel scriptArea

list

protected JList<K extends Comparable<K>> list

scripts

protected Map<K extends Comparable<K>,String> scripts

listModel

protected MapListModel listModel

currentEdit

protected K extends Comparable<K> currentEdit

LIST_NORMAL

protected static Font LIST_NORMAL

LIST_DISABLED

protected static Font LIST_DISABLED

Constructor Details

AbstractMultiExtensionFunctionScriptEditor

protected AbstractMultiExtensionFunctionScriptEditor()

Method Details

initComponents

protected void initComponents()

getScriptEditorPanel

protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel getScriptEditorPanel()

createScriptEditor

protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel createScriptEditor()

getUserScript

protected String getUserScript()

Retrieve the script to actually store into the scripts map.

setUserScript

protected void setUserScript(K key)

Apply the script from key to the current script area.

getCompilableScript

protected String getCompilableScript(K key)

Retrieve a compileable version of the script under key. Used during the save to ensure script isn't obviously wrong.

buildDescriptor

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

getDefaultNewScript

protected String getDefaultNewScript()

configureListCell

protected void configureListCell(JLabel cell,
 K item,
 boolean isSelected)

isReconfigureActionPresent

protected abstract boolean isReconfigureActionPresent()

Should item's keys be reconfigurable?

getNoun

protected abstract String getNoun()

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

getNewIcon

protected abstract Icon getNewIcon()

getDeleteIcon

protected abstract Icon getDeleteIcon()

getReconfigureIcon

protected abstract Icon getReconfigureIcon()

doNew

protected void doNew()

toString

protected String toString(K key)

getCappedNoun

protected String getCappedNoun()

chooseNewKey

protected abstract K chooseNewKey()

doDelete

protected void doDelete()

reconfigureKey

protected abstract K reconfigureKey(K key)

doReconfigure

protected void doReconfigure()

getScripts

protected abstract Map<K,String> getScripts(ScriptConfig sc)

storeScripts

protected abstract void storeScripts(ScriptConfig sc,
 Map<K,String> scripts)

init

public boolean init(ScriptConfig sc)

Specified by:

init in class GlobalScriptEditor.ScriptConfigPanel

doSave

public void doSave(ScriptConfig sc)
            throws PropertyVetoException

Specified by:

doSave in class GlobalScriptEditor.ScriptConfigPanel

Throws:

PropertyVetoException

installHints

public void installHints(Map<String,List<ScriptFunctionHint>> hints)

Specified by:

installHints in class GlobalScriptEditor.ScriptConfigPanel

toLocatableValue

protected abstract String toLocatableValue(K key)

locate

public void locate(Location location)

Specified by:

locate in interface Locatable