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:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.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
javax.swing.JPanel.AccessibleJPanel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description static java.awt.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
-
-
Constructor Summary
Constructors Constructor Description MessageHandlerEditor(boolean isClient)
MessageHandlerEditor(java.lang.String titleKey, boolean isClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor
buildDescriptor()
protected MessageHandlerKey
chooseNewKey()
protected void
configureListCell(javax.swing.JLabel cell, MessageHandlerKey item, boolean selected)
protected java.lang.String
getCompilableScript(MessageHandlerKey key)
Retrieve a compileable version of the script underkey
.protected javax.swing.JPanel
getConfigPanel(MessageHandlerKey key, boolean isClient)
protected javax.swing.Icon
getDeleteIcon()
javax.swing.Icon
getIcon()
protected javax.swing.Icon
getNewIcon()
protected java.lang.String
getNoun()
Return of name of the thing being configured, "timer" for "timer scripts", etc."protected javax.swing.Icon
getReconfigureIcon()
protected java.util.Map<MessageHandlerKey,java.lang.String>
getScripts(ScriptConfig sc)
java.lang.String
getTitleKey()
A resource key that will be used for the title and description as follows: titleKey + ".Title" and titleKey + ".Desc"protected java.lang.String
getUserScript()
Retrieve the script to actually store into thescripts
map.protected boolean
isReconfigureActionPresent()
Should item's keys be reconfigurable?protected MessageHandlerKey
reconfigureKey(MessageHandlerKey key)
protected void
setUserScript(MessageHandlerKey key)
Apply the script fromkey
to the current script area.protected void
storeScripts(ScriptConfig sc, java.util.Map<MessageHandlerKey,java.lang.String> scripts)
-
Methods inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractMultiExtensionFunctionScriptEditor
createScriptEditor, doDelete, doNew, doReconfigure, doSave, getCappedNoun, getDefaultNewScript, getScriptEditorPanel, init, initComponents, installHints, 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
-
-
-
-
Method Detail
-
buildDescriptor
protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor buildDescriptor()
- Specified by:
buildDescriptor
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getUserScript
protected java.lang.String getUserScript()
Description copied from class:AbstractMultiExtensionFunctionScriptEditor
Retrieve the script to actually store into thescripts
map.- Overrides:
getUserScript
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
setUserScript
protected void setUserScript(MessageHandlerKey key)
Description copied from class:AbstractMultiExtensionFunctionScriptEditor
Apply the script fromkey
to the current script area.- Overrides:
setUserScript
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getCompilableScript
protected java.lang.String getCompilableScript(MessageHandlerKey key)
Description copied from class:AbstractMultiExtensionFunctionScriptEditor
Retrieve a compileable version of the script underkey
. Used during the save to ensure script isn't obviously wrong.- Overrides:
getCompilableScript
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
isReconfigureActionPresent
protected boolean isReconfigureActionPresent()
Description copied from class:AbstractMultiExtensionFunctionScriptEditor
Should item's keys be reconfigurable?- Specified by:
isReconfigureActionPresent
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getNoun
protected java.lang.String getNoun()
Description copied from class:AbstractMultiExtensionFunctionScriptEditor
Return of name of the thing being configured, "timer" for "timer scripts", etc."- Specified by:
getNoun
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getNewIcon
protected javax.swing.Icon getNewIcon()
- Specified by:
getNewIcon
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getDeleteIcon
protected javax.swing.Icon getDeleteIcon()
- Specified by:
getDeleteIcon
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getReconfigureIcon
protected javax.swing.Icon getReconfigureIcon()
- Specified by:
getReconfigureIcon
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
chooseNewKey
protected MessageHandlerKey chooseNewKey()
- Specified by:
chooseNewKey
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
reconfigureKey
protected MessageHandlerKey reconfigureKey(MessageHandlerKey key)
- Specified by:
reconfigureKey
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getConfigPanel
protected javax.swing.JPanel getConfigPanel(MessageHandlerKey key, boolean isClient)
-
getScripts
protected java.util.Map<MessageHandlerKey,java.lang.String> getScripts(ScriptConfig sc)
- Specified by:
getScripts
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
storeScripts
protected void storeScripts(ScriptConfig sc, java.util.Map<MessageHandlerKey,java.lang.String> scripts)
- Specified by:
storeScripts
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getTitleKey
public java.lang.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 classGlobalScriptEditor.ScriptConfigPanel
-
getIcon
public javax.swing.Icon getIcon()
- Specified by:
getIcon
in classGlobalScriptEditor.ScriptConfigPanel
-
configureListCell
protected void configureListCell(javax.swing.JLabel cell, MessageHandlerKey item, boolean selected)
- Overrides:
configureListCell
in classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
-