Package com.inductiveautomation.ignition.designer.scripteditor

Class TimerScriptEditor

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.AbstractMultiScriptEditor<TimerKey>

com.inductiveautomation.ignition.designer.scripteditor.TimerScriptEditor

All Implemented Interfaces:

Locatable, ImageObserver, MenuContainer, Serializable, Accessible

public class TimerScriptEditor
extends AbstractMultiScriptEditor<TimerKey>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractMultiScriptEditor

AbstractMultiScriptEditor.SelectionListener

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.AbstractMultiScriptEditor

context, currentEdit, list, 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

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
TimerScriptEditor(DesignerContext context)
TimerScriptEditor(DesignerContext context, String titleKey)

Method Summary

Modifier and Type	Method	Description
protected TimerKey	chooseNewKey()
protected void	configureListCell(JLabel cell, TimerKey item, boolean selected)
protected Icon	getDeleteIcon()
String	getFunctionValue()	The identifier stored in the TagReferenceLocation.FUNCTION_KEY when this type of script is executed.
Icon	getIcon()
protected Icon	getNewIcon()
protected String	getNoun()	Return of name of the thing being configured, "timer" for "timer scripts", etc."
protected Icon	getReconfigureIcon()
protected Map<TimerKey,String>	getScripts(ScriptConfig sc)
String	getTitleKey()	A resource key that will be used for the title and description as follows: titleKey + ".Title" and titleKey + ".Desc"
protected boolean	isReconfigureActionPresent()	Should item's keys be reconfigurable?
protected TimerKey	reconfigureKey(TimerKey key)
protected void	storeScripts(ScriptConfig sc, Map<TimerKey,String> scripts)
protected String	toLocatableValue(TimerKey key)

Methods inherited from class com.inductiveautomation.ignition.designer.scripteditor.AbstractMultiScriptEditor

createScriptEditor, doDelete, doNew, doReconfigure, doSave, getCappedNoun, getDefaultNewScript, getListTitle, getScript, getScript, getScriptEditorPanel, init, initComponents, installHints, locate, setScript, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TimerScriptEditor

public TimerScriptEditor(DesignerContext context)

TimerScriptEditor

public TimerScriptEditor(DesignerContext context,
 String titleKey)

Method Details

chooseNewKey

protected TimerKey chooseNewKey()

Specified by:

chooseNewKey in class AbstractMultiScriptEditor<TimerKey>

configureListCell

protected void configureListCell(JLabel cell,
 TimerKey item,
 boolean selected)

Overrides:

configureListCell in class AbstractMultiScriptEditor<TimerKey>

reconfigureKey

protected TimerKey reconfigureKey(TimerKey key)

Specified by:

reconfigureKey in class AbstractMultiScriptEditor<TimerKey>

getDeleteIcon

protected Icon getDeleteIcon()

Specified by:

getDeleteIcon in class AbstractMultiScriptEditor<TimerKey>

getNewIcon

protected Icon getNewIcon()

Specified by:

getNewIcon in class AbstractMultiScriptEditor<TimerKey>

getNoun

protected String getNoun()

Description copied from class: AbstractMultiScriptEditor

Return of name of the thing being configured, "timer" for "timer scripts", etc."

Specified by:

getNoun in class AbstractMultiScriptEditor<TimerKey>

getReconfigureIcon

protected Icon getReconfigureIcon()

Specified by:

getReconfigureIcon in class AbstractMultiScriptEditor<TimerKey>

getScripts

protected Map<TimerKey,String> getScripts(ScriptConfig sc)

Specified by:

getScripts in class AbstractMultiScriptEditor<TimerKey>

isReconfigureActionPresent

protected boolean isReconfigureActionPresent()

Description copied from class: AbstractMultiScriptEditor

Should item's keys be reconfigurable?

Specified by:

isReconfigureActionPresent in class AbstractMultiScriptEditor<TimerKey>

storeScripts

protected void storeScripts(ScriptConfig sc,
 Map<TimerKey,String> scripts)

Specified by:

storeScripts in class AbstractMultiScriptEditor<TimerKey>

getFunctionValue

public String getFunctionValue()

Description copied from class: GlobalScriptEditor.ScriptConfigPanel

The identifier stored in the TagReferenceLocation.FUNCTION_KEY when this type of script is executed. Additional disambiguation should be stored in TagReferenceLocation.SCRIPT_KEY

Specified by:

getFunctionValue in class GlobalScriptEditor.ScriptConfigPanel

See Also:

• ScriptConfig.STARTUP_LOCATION_VALUE
• ScriptConfig.TIMER_SCRIPT_VALUE

toLocatableValue

protected String toLocatableValue(TimerKey key)

Specified by:

toLocatableValue in class AbstractMultiScriptEditor<TimerKey>

getIcon

public Icon getIcon()

Specified by:

getIcon in class GlobalScriptEditor.ScriptConfigPanel

getTitleKey

public String getTitleKey()

Description copied from class: GlobalScriptEditor.ScriptConfigPanel

A resource key that will be used for the title and description as follows: titleKey + ".Title" and titleKey + ".Desc"

Specified by:

getTitleKey in class GlobalScriptEditor.ScriptConfigPanel