Class EventScriptTab<T>
- Type Parameters:
T- the type of the resource
- All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible
- Direct Known Subclasses:
AccelerometerScriptTab, AuthChallengeScriptTab, BarcodeScriptTab, BluetoothScriptTab, FormSubmissionScriptTab, KeyEventScriptTab, KeystrokeScriptTab, MenubarScriptTab, MessageHandlerScriptTab, NfcScanScriptTab, PageStartupScriptTab, ScheduledScriptTab, ShutdownInterceptScriptTab, ShutdownScriptTab, StartupScriptTab, TagChangeScriptTab, TimerScriptTab, UpdateScriptTab
- See Also:
-
Nested Class Summary
Nested 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
FieldsModifier and TypeFieldDescriptionprotected JPanelprotected JCheckBoxprotected intprotected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanelprotected StringFields 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
ConstructorsModifierConstructorDescriptionprotectedEventScriptTab(ResourceWorkspace workspace, ResourcePath resourcePath, String titleKey) -
Method Summary
Modifier and TypeMethodDescriptionprotected final voidAddsgetAssistButton()toscriptEditor's toolbar when it is non-null.protected voidcustomizeAssistant(DesignerAiContext ai, EmbeddedAssistantBuilder assistant) Adjusts the assistant behindgetAssistButton()before its button is built.voiddispose()Provides a default implementation to shut down the python editor.protected @Nullable AbstractButtonThe "Ask AI" toolbar button, ornull— when the gateway has not enabled the AI agent module, or from an override opting the tab out of assist entirely.protected StringNatural-language framing describing what this event script is and how it runs, handed to the assist agent once per session.protected abstract 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.@Nullable Stringprotected voidInitializes the editor panel with a script editor and enabled checkbox.protected ResourceDescriptorReturns the resource descriptor for the workspace.protected @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 ResourceEditor
commit, createLogger, deserialize, deserialize, getObjectForSave, getResource, getResourcePath, getTabIcon, init, isOptimizeCommits, loadResource, onCommitFailed, serialize, serializeResource, 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
-
Field Details
-
scriptEditor
protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel scriptEditor -
scope
protected int scope -
editorPanel
-
enabledCheckbox
-
titleKey
-
-
Constructor Details
-
EventScriptTab
-
-
Method Details
-
getTabTitle
- Overrides:
getTabTitlein classResourceEditor<T>
-
initEditorPanel
protected void initEditorPanel()Initializes the editor panel with a script editor and enabled checkbox. This is the default behavior for setting up the editor panel. Subclasses can override the `init` method if they require custom initialization and do not wish to call this default setup. -
addScriptAssistButton
protected final void addScriptAssistButton()AddsgetAssistButton()toscriptEditor's toolbar when it is non-null. Subclasses that bypassinitEditorPanel()must call this themselves oncescriptEditorhas been constructed and given a descriptor. -
getAssistButton
The "Ask AI" toolbar button, ornull— when the gateway has not enabled the AI agent module, or from an override opting the tab out of assist entirely.Called from
ResourceEditor.init(T)during theResourceEditorconstructor, so an override cannot read the subclass's own fields. To change what the stock assistant is told, overridegetAssistContext()ortriggerConfigSupport(), which are read when the popup opens; to change anything else about the assistant, overridecustomizeAssistant(DesignerAiContext, EmbeddedAssistantBuilder). -
customizeAssistant
Adjusts the assistant behindgetAssistButton()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.- Parameters:
ai- the resolved Designer AI context the button is being built against.assistant- the configured builder; call its setters, not its terminal methods.
-
getAssistContext
Natural-language framing describing what this event script is and how it runs, handed to the assist agent once per session. -
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.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. -
resourceDescriptor
Description copied from class:ResourceEditorReturns the resource descriptor for the workspace.By default, this implementation supports
TabbedResourceWorkspace. Subclasses should override this method to provide a specific resource descriptor for the type of resource they are working with.- Overrides:
resourceDescriptorin classResourceEditor<T>
-
dispose
public void dispose()Provides a default implementation to shut down the python editor. Unregisters the completion provider from the ScriptIndexer to avoid memory leaks or dangling references.- Overrides:
disposein classResourceEditor<T>
-
getScriptHints
Defaults to Gateway hints. -
getFunctionDescriptor
protected abstract com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor getFunctionDescriptor()Returns the descriptor for the extension function associated with this script editor.
-