Package com.inductiveautomation.ignition.designer.scripteditor

Class AbstractMultiExtensionFunctionScriptEditor<K extends java.lang.Comparable<K>>

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected class  AbstractMultiExtensionFunctionScriptEditor.SelectionListener  

      • Nested classes/interfaces inherited from class javax.swing.JPanel

        javax.swing.JPanel.AccessibleJPanel

      • Nested classes/interfaces inherited from class javax.swing.JComponent

        javax.swing.JComponent.AccessibleJComponent

      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected K currentEdit  
      protected javax.swing.JList<K> list  
      protected static java.awt.Font LIST_DISABLED  
      protected static java.awt.Font LIST_NORMAL  
      protected MapListModel listModel  
      protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel scriptArea  
      protected java.util.Map<K,​java.lang.String> scripts  
      protected javax.swing.JSplitPane 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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor buildDescriptor()  
      protected abstract K chooseNewKey()  
      protected void configureListCell​(javax.swing.JLabel cell, K item, boolean isSelected)  
      protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel createScriptEditor()  
      protected void doDelete()  
      protected void doNew()  
      protected void doReconfigure()  
      void doSave​(ScriptConfig sc)  
      protected java.lang.String getCappedNoun()  
      protected java.lang.String getCompilableScript​(K key)
      Retrieve a compileable version of the script under key.
      protected java.lang.String getDefaultNewScript()  
      protected abstract javax.swing.Icon getDeleteIcon()  
      protected abstract javax.swing.Icon getNewIcon()  
      protected abstract java.lang.String getNoun()
      Return of name of the thing being configured, "timer" for "timer scripts", etc."
      protected abstract javax.swing.Icon getReconfigureIcon()  
      protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel getScriptEditorPanel()  
      protected abstract java.util.Map<K,​java.lang.String> getScripts​(ScriptConfig sc)  
      protected java.lang.String getUserScript()
      Retrieve the script to actually store into the scripts map.
      boolean init​(ScriptConfig sc)  
      protected void initComponents()  
      void installHints​(java.util.Map<java.lang.String,​java.util.List<ScriptFunctionHint>> hints)  
      protected abstract boolean isReconfigureActionPresent()
      Should item's keys be reconfigurable?
      protected abstract K reconfigureKey​(K key)  
      protected void setUserScript​(K key)
      Apply the script from key to the current script area.
      protected abstract void storeScripts​(ScriptConfig sc, java.util.Map<K,​java.lang.String> scripts)  
      protected java.lang.String toString​(K key)  

      • 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 Detail

      • splitPane

        protected javax.swing.JSplitPane splitPane

      • scriptArea

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

      • list

        protected javax.swing.JList<K extends java.lang.Comparable<K>> list

      • scripts

        protected java.util.Map<K extends java.lang.Comparable<K>,​java.lang.String> scripts

      • currentEdit

        protected K extends java.lang.Comparable<K> currentEdit

      • LIST_NORMAL

        protected static java.awt.Font LIST_NORMAL

      • LIST_DISABLED

        protected static java.awt.Font LIST_DISABLED

    • Constructor Detail

      • AbstractMultiExtensionFunctionScriptEditor

        protected AbstractMultiExtensionFunctionScriptEditor()

    • Method Detail

      • initComponents

        protected void initComponents()

      • getScriptEditorPanel

        protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel getScriptEditorPanel()

      • createScriptEditor

        protected com.inductiveautomation.ignition.designer.gui.tools.ExtensionFunctionPanel createScriptEditor()

      • getUserScript

        protected java.lang.String getUserScript()
        Retrieve the script to actually store into the scripts map.

      • setUserScript

        protected void setUserScript​(K key)
        Apply the script from key to the current script area.

      • getCompilableScript

        protected java.lang.String getCompilableScript​(K key)
        Retrieve a compileable version of the script under key. Used during the save to ensure script isn't obviously wrong.

      • buildDescriptor

        protected abstract com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor buildDescriptor()

      • getDefaultNewScript

        protected java.lang.String getDefaultNewScript()

      • configureListCell

        protected void configureListCell​(javax.swing.JLabel cell,
                                 K item,
                                 boolean isSelected)

      • isReconfigureActionPresent

        protected abstract boolean isReconfigureActionPresent()
        Should item's keys be reconfigurable?

      • getNoun

        protected abstract java.lang.String getNoun()
        Return of name of the thing being configured, "timer" for "timer scripts", etc."

      • getNewIcon

        protected abstract javax.swing.Icon getNewIcon()

      • getDeleteIcon

        protected abstract javax.swing.Icon getDeleteIcon()

      • getReconfigureIcon

        protected abstract javax.swing.Icon getReconfigureIcon()

      • doNew

        protected void doNew()

      • toString

        protected java.lang.String toString​(K key)

      • getCappedNoun

        protected java.lang.String getCappedNoun()

      • chooseNewKey

        protected abstract K chooseNewKey()

      • doDelete

        protected void doDelete()

      • reconfigureKey

        protected abstract K reconfigureKey​(K key)

      • doReconfigure

        protected void doReconfigure()

      • getScripts

        protected abstract java.util.Map<K,​java.lang.String> getScripts​(ScriptConfig sc)

      • storeScripts

        protected abstract void storeScripts​(ScriptConfig sc,
                                     java.util.Map<K,​java.lang.String> scripts)