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.FontHEADER_FONTDeprecated.-
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.ExtensionFunctionDescriptorbuildDescriptor()protected MessageHandlerKeychooseNewKey()protected voidconfigureListCell(javax.swing.JLabel cell, MessageHandlerKey item, boolean selected)protected java.lang.StringgetCompilableScript(MessageHandlerKey key)Retrieve a compileable version of the script underkey.protected javax.swing.JPanelgetConfigPanel(MessageHandlerKey key, boolean isClient)protected javax.swing.IcongetDeleteIcon()javax.swing.IcongetIcon()protected javax.swing.IcongetNewIcon()protected java.lang.StringgetNoun()Return of name of the thing being configured, "timer" for "timer scripts", etc."protected javax.swing.IcongetReconfigureIcon()protected java.util.Map<MessageHandlerKey,java.lang.String>getScripts(ScriptConfig sc)java.lang.StringgetTitleKey()A resource key that will be used for the title and description as follows: titleKey + ".Title" and titleKey + ".Desc"protected java.lang.StringgetUserScript()Retrieve the script to actually store into thescriptsmap.protected booleanisReconfigureActionPresent()Should item's keys be reconfigurable?protected MessageHandlerKeyreconfigureKey(MessageHandlerKey key)protected voidsetUserScript(MessageHandlerKey key)Apply the script fromkeyto the current script area.protected voidstoreScripts(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:
buildDescriptorin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getUserScript
protected java.lang.String getUserScript()
Description copied from class:AbstractMultiExtensionFunctionScriptEditorRetrieve the script to actually store into thescriptsmap.- Overrides:
getUserScriptin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
setUserScript
protected void setUserScript(MessageHandlerKey key)
Description copied from class:AbstractMultiExtensionFunctionScriptEditorApply the script fromkeyto the current script area.- Overrides:
setUserScriptin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getCompilableScript
protected java.lang.String getCompilableScript(MessageHandlerKey key)
Description copied from class:AbstractMultiExtensionFunctionScriptEditorRetrieve a compileable version of the script underkey. Used during the save to ensure script isn't obviously wrong.- Overrides:
getCompilableScriptin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
isReconfigureActionPresent
protected boolean isReconfigureActionPresent()
Description copied from class:AbstractMultiExtensionFunctionScriptEditorShould item's keys be reconfigurable?- Specified by:
isReconfigureActionPresentin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getNoun
protected java.lang.String getNoun()
Description copied from class:AbstractMultiExtensionFunctionScriptEditorReturn of name of the thing being configured, "timer" for "timer scripts", etc."- Specified by:
getNounin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getNewIcon
protected javax.swing.Icon getNewIcon()
- Specified by:
getNewIconin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getDeleteIcon
protected javax.swing.Icon getDeleteIcon()
- Specified by:
getDeleteIconin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getReconfigureIcon
protected javax.swing.Icon getReconfigureIcon()
- Specified by:
getReconfigureIconin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
chooseNewKey
protected MessageHandlerKey chooseNewKey()
- Specified by:
chooseNewKeyin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
reconfigureKey
protected MessageHandlerKey reconfigureKey(MessageHandlerKey key)
- Specified by:
reconfigureKeyin 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:
getScriptsin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
storeScripts
protected void storeScripts(ScriptConfig sc, java.util.Map<MessageHandlerKey,java.lang.String> scripts)
- Specified by:
storeScriptsin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
getTitleKey
public java.lang.String getTitleKey()
Description copied from class:GlobalScriptEditor.ScriptConfigPanelA resource key that will be used for the title and description as follows: titleKey + ".Title" and titleKey + ".Desc"- Specified by:
getTitleKeyin classGlobalScriptEditor.ScriptConfigPanel
-
getIcon
public javax.swing.Icon getIcon()
- Specified by:
getIconin classGlobalScriptEditor.ScriptConfigPanel
-
configureListCell
protected void configureListCell(javax.swing.JLabel cell, MessageHandlerKey item, boolean selected)- Overrides:
configureListCellin classAbstractMultiExtensionFunctionScriptEditor<MessageHandlerKey>
-
-