Class ClientMessageHandlerScriptTab
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceEditor<ScriptConfig.MessageHandlerScript>
com.inductiveautomation.ignition.designer.scripteditor.workspace.EventScriptTab<ScriptConfig.MessageHandlerScript>
com.inductiveautomation.ignition.designer.scripteditor.workspace.MessageHandlerScriptTab
com.inductiveautomation.factorypmi.designer.workspace.ClientMessageHandlerScriptTab
- All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class MessageHandlerScriptTab
MessageHandlerScriptTab.MessageConfigPanel, MessageHandlerScriptTab.MessageHandlerKeyModelNested classes/interfaces inherited from class JPanel
JPanel.AccessibleJPanelNested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
Fields inherited from class MessageHandlerScriptTab
messageConfigPanelFields inherited from class EventScriptTab
editorPanel, enabledCheckbox, scope, scriptEditor, titleKeyFields inherited from class ResourceEditor
context, log, resourcePath, workspaceFields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionClientMessageHandlerScriptTab(WindowWorkspace workspace, ResourcePath resourcePath) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcustomizeAssistant(DesignerAiContext ai, EmbeddedAssistantBuilder assistant) Adjusts the assistant behindEventScriptTab.getAssistButton()before its button is built.protected StringAdds the facts the trigger-config record has no member for: which handler this is, and — for a gateway-scoped handler — the zones and roles that actually exist on this gateway.protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptorReturns the descriptor for the extension function associated with this script editor.protected Supplier<PackageTreeNode> Defaults to Gateway hints.protected voidprotected @Nullable TriggerConfigSupport<?> This tab's trigger-configuration contract with the assistant, ornull— the default, for tabs that have no trigger — to leave the assistant rewriting the script only.Methods inherited from class MessageHandlerScriptTab
deserialize, getObjectForSave, getTabIcon, serializeResourceMethods inherited from class EventScriptTab
addScriptAssistButton, dispose, getAssistButton, getTabTitle, initEditorPanel, resourceDescriptorMethods inherited from class ResourceEditor
commit, createLogger, deserialize, getResource, getResourcePath, isOptimizeCommits, loadResource, onCommitFailed, serialize, updateResourceMethods inherited from class JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class 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, updateMethods inherited from class 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, validateTreeMethods inherited from class 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
-
Constructor Details
-
ClientMessageHandlerScriptTab
-
-
Method Details
-
getFunctionDescriptor
protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor getFunctionDescriptor()Description copied from class:EventScriptTabReturns the descriptor for the extension function associated with this script editor.- Overrides:
getFunctionDescriptorin classMessageHandlerScriptTab
-
getScriptHints
Description copied from class:EventScriptTabDefaults to Gateway hints.- Overrides:
getScriptHintsin classEventScriptTab<ScriptConfig.MessageHandlerScript>
-
getAssistContext
Description copied from class:MessageHandlerScriptTabAdds the facts the trigger-config record has no member for: which handler this is, and — for a gateway-scoped handler — the zones and roles that actually exist on this gateway. Session context is their home because all three are fixed for the life of the assist popup.- Overrides:
getAssistContextin classMessageHandlerScriptTab
-
customizeAssistant
Description copied from class:EventScriptTabAdjusts the assistant behindEventScriptTab.getAssistButton()before its button is built.assistantarrives fully configured with this tab's agent, host, and the default tag and file@-reference browsers; the default implementation leaves it unchanged. Each builder setter replaces its slot wholesale, so an override that changes the@-browsers supplies the complete list.Called during the
ResourceEditorconstructor, before subclass constructor bodies run, so an override must not readscopeor any subclass field. The configuration is fixed for the life of the button.- Overrides:
customizeAssistantin classEventScriptTab<ScriptConfig.MessageHandlerScript>- Parameters:
ai- the resolved Designer AI context the button is being built against.assistant- the configured builder; call its setters, not its terminal methods.
-
triggerConfigSupport
Description copied from class:EventScriptTabThis tab's trigger-configuration contract with the assistant, ornull— the default, for tabs that have no trigger — to leave the assistant rewriting the script only.Called when the assist popup opens and again on every submit, never during
ResourceEditor.init(T), so an override may safely readscopeand the tab's config panels. Return a freshTriggerConfigSupporteach time rather than a cached field.- Overrides:
triggerConfigSupportin classMessageHandlerScriptTab
-
init
- Overrides:
initin classMessageHandlerScriptTab
-