Package com.inductiveautomation.ignition.designer.scripteditor

Class MessageHandlerEditor

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

com.inductiveautomation.ignition.designer.scripteditor.MessageHandlerEditor

All Implemented Interfaces:

Locatable, ImageObserver, MenuContainer, Serializable, Accessible

public class MessageHandlerEditor
extends AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

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

Modifier and Type	Field	Description
static final Font	HEADER_FONT	Deprecated.

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
MessageHandlerEditor(boolean isClient)
MessageHandlerEditor(String titleKey, boolean isClient)

Method Summary

Modifier and Type	Method	Description
protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	buildDescriptor()
protected MessageHandlerKey	chooseNewKey()
protected void	configureListCell(JLabel cell, MessageHandlerKey item, boolean selected)
protected String	getCompilableScript(MessageHandlerKey key)	Retrieve a compileable version of the script under key.
protected JPanel	getConfigPanel(MessageHandlerKey key, boolean isClient)
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<MessageHandlerKey,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 String	getUserScript()	Retrieve the script to actually store into the scripts map.
protected boolean	isReconfigureActionPresent()	Should item's keys be reconfigurable?
protected MessageHandlerKey	reconfigureKey(MessageHandlerKey key)
protected void	setUserScript(MessageHandlerKey key)	Apply the script from key to the current script area.
protected void	storeScripts(ScriptConfig sc, Map<MessageHandlerKey,String> scripts)
protected String	toLocatableValue(MessageHandlerKey key)

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

createScriptEditor, doDelete, doNew, doReconfigure, doSave, getCappedNoun, getDefaultNewScript, getScriptEditorPanel, init, initComponents, installHints, locate, 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

Field Details

HEADER_FONT

@Deprecated
public static final Font HEADER_FONT

Deprecated.

Constructor Details

MessageHandlerEditor

public MessageHandlerEditor(boolean isClient)

MessageHandlerEditor

public MessageHandlerEditor(String titleKey,
 boolean isClient)

Method Details

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

buildDescriptor

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

Specified by:

buildDescriptor in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

getUserScript

protected String getUserScript()

Description copied from class: AbstractMultiExtensionFunctionScriptEditor

Retrieve the script to actually store into the scripts map.

Overrides:

getUserScript in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

setUserScript

protected void setUserScript(MessageHandlerKey key)

Description copied from class: AbstractMultiExtensionFunctionScriptEditor

Apply the script from key to the current script area.

Overrides:

setUserScript in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

getCompilableScript

protected String getCompilableScript(MessageHandlerKey key)

Description copied from class: AbstractMultiExtensionFunctionScriptEditor

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

Overrides:

getCompilableScript in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

isReconfigureActionPresent

protected boolean isReconfigureActionPresent()

Description copied from class: AbstractMultiExtensionFunctionScriptEditor

Should item's keys be reconfigurable?

Specified by:

isReconfigureActionPresent in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

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

getNewIcon

protected Icon getNewIcon()

Specified by:

getNewIcon in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

getDeleteIcon

protected Icon getDeleteIcon()

Specified by:

getDeleteIcon in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

getReconfigureIcon

protected Icon getReconfigureIcon()

Specified by:

getReconfigureIcon in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

chooseNewKey

protected MessageHandlerKey chooseNewKey()

Specified by:

chooseNewKey in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

reconfigureKey

protected MessageHandlerKey reconfigureKey(MessageHandlerKey key)

Specified by:

reconfigureKey in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

getConfigPanel

protected JPanel getConfigPanel(MessageHandlerKey key,
 boolean isClient)

getScripts

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

Specified by:

getScripts in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

storeScripts

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

Specified by:

storeScripts in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

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

toLocatableValue

protected String toLocatableValue(MessageHandlerKey key)

Specified by:

toLocatableValue in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>

configureListCell

protected void configureListCell(JLabel cell,
 MessageHandlerKey item,
 boolean selected)

Overrides:

configureListCell in class AbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>