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

Class StartupScriptTab

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<ScriptConfig.StartupScript>

com.inductiveautomation.ignition.designer.scripteditor.workspace.StartupScriptTab

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

ClientStartupScriptTab, SessionStartupScriptTab

public class StartupScriptTab
extends EventScriptTab<ScriptConfig.StartupScript>

Tab for editing startup event scripts

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StartupScriptTab.StartupScriptNode

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 inherited from class com.inductiveautomation.ignition.designer.scripteditor.workspace.EventScriptTab

editorPanel, enabledCheckbox, scope, scriptEditor, 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

Constructor	Description
StartupScriptTab(ResourceWorkspace workspace, ResourcePath resourcePath, String titleKey)

Method Summary

Modifier and Type	Method	Description
protected ScriptConfig.StartupScript	deserialize(Resource resource)	Deserialize a project resource into the editing object type for this editor.
protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor	getFunctionDescriptor()	Returns the descriptor for the extension function associated with this script editor.
protected ScriptConfig.StartupScript	getObjectForSave()	Return the object that should be saved to represent this resource in the ProjectResource.
Icon	getTabIcon()
protected void	init(ScriptConfig.StartupScript config)
protected void	serializeResource(ResourceBuilder builder, ScriptConfig.StartupScript config)	Serialize the object and put the serialized file(s) and attribute(s) into the project resource builder.

Methods inherited from class com.inductiveautomation.ignition.designer.scripteditor.workspace.EventScriptTab

dispose, getScriptHints, getTabTitle, initEditorPanel, resourceDescriptor

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

commit, createLogger, deserialize, getResource, getResourcePath, isOptimizeCommits, loadResource, onCommitFailed, serialize, 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

Constructor Details

StartupScriptTab

public StartupScriptTab(ResourceWorkspace workspace,
 ResourcePath resourcePath,
 String titleKey)

Method Details

getTabIcon

public Icon getTabIcon()

Overrides:

getTabIcon in class ResourceEditor<ScriptConfig.StartupScript>

deserialize

protected ScriptConfig.StartupScript deserialize(Resource resource)
                                          throws Exception

Description copied from class: ResourceEditor

Deserialize a project resource into the editing object type for this editor. Default implementation simply calls this.deserialize(resource.getData().orElseThrow().getBytes()). Override this method if your resource does not use the default data.bin file.

Overrides:

deserialize in class ResourceEditor<ScriptConfig.StartupScript>

Throws:

Exception

serializeResource

protected void serializeResource(ResourceBuilder builder,
 ScriptConfig.StartupScript config)

Description copied from class: ResourceEditor

Serialize the object and put the serialized file(s) and attribute(s) into the project resource builder. Default implementation is:

builder.putData(serialize(object));

Implementations don't need to bother setting the project's resourcePath, projectName, or applicationScope; those will be set automatically.

Overrides:

serializeResource in class ResourceEditor<ScriptConfig.StartupScript>

getObjectForSave

protected ScriptConfig.StartupScript getObjectForSave()

Description copied from class: ResourceEditor

Return the object that should be saved to represent this resource in the ProjectResource. Will be serialized using an XMLSerializer. Override save() to serialize in a different manner.

Specified by:

getObjectForSave in class ResourceEditor<ScriptConfig.StartupScript>

getFunctionDescriptor

protected com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor getFunctionDescriptor()

Description copied from class: EventScriptTab

Returns the descriptor for the extension function associated with this script editor.

Specified by:

getFunctionDescriptor in class EventScriptTab<ScriptConfig.StartupScript>

init

protected void init(ScriptConfig.StartupScript config)

Specified by:

init in class ResourceEditor<ScriptConfig.StartupScript>