Package com.inductiveautomation.ignition.designer.scripteditor.workspace

Class EventScriptTab<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceEditor<T>

com.inductiveautomation.ignition.designer.scripteditor.workspace.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

public abstract class EventScriptTab<T>
extends ResourceEditor<T>

Abstract base class for event script tabs. Extends ResourceEditor to provide common functionality for script editing.

See Also:

• Serialized Form

Nested Class Summary

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
protected JPanel	editorPanel
protected JCheckBox	enabledCheckbox
protected int	scope
protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel	scriptEditor
protected String	titleKey

Fields inherited from class com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceEditor

context, log, resourcePath, workspace

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

Modifier	Constructor	Description
protected	EventScriptTab(ResourceWorkspace workspace, ResourcePath resourcePath, String titleKey)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Provides a default implementation to shut down the python editor.
protected abstract com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	getFunctionDescriptor()	Returns the descriptor for the extension function associated with this script editor.
protected Supplier<PackageTreeNode>	getScriptHints()	Defaults to Gateway hints.
String	getTabTitle()
protected void	initEditorPanel()	Initializes the editor panel with a script editor and enabled checkbox.
protected ResourceDescriptor	resourceDescriptor()	Returns the resource descriptor for the workspace.

Methods inherited from class com.inductiveautomation.ignition.designer.tabbedworkspace.ResourceEditor

commit, createLogger, deserialize, deserialize, getObjectForSave, getResource, getResourcePath, getTabIcon, init, isOptimizeCommits, loadResource, onCommitFailed, serialize, serializeResource, updateResource

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

scriptEditor

protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel scriptEditor

scope

protected int scope

editorPanel

protected JPanel editorPanel

enabledCheckbox

protected JCheckBox enabledCheckbox

titleKey

protected String titleKey

Constructor Details

EventScriptTab

protected EventScriptTab(ResourceWorkspace workspace,
 ResourcePath resourcePath,
 String titleKey)

Method Details

getTabTitle

public String getTabTitle()

Overrides:

getTabTitle in class ResourceEditor<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.

resourceDescriptor

protected ResourceDescriptor resourceDescriptor()

Description copied from class: ResourceEditor

Returns 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:

resourceDescriptor in class ResourceEditor<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:

dispose in class ResourceEditor<T>

getScriptHints

protected Supplier<PackageTreeNode> 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.