com.inductiveautomation.ignition.designer.scripteditor

Class MessageHandlerEditor

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<MessageHandlerKey>

com.inductiveautomation.ignition.designer.scripteditor.MessageHandlerEditor

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class MessageHandlerEditor
extends AbstractMultiScriptEditor<MessageHandlerKey>

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

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 and Description
static java.awt.Font	HEADER_FONT Deprecated.

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 and Description
MessageHandlerEditor(DesignerContext context, boolean isClient)
MessageHandlerEditor(DesignerContext context, java.lang.String titleKey, boolean isClient)

Method Summary

Modifier and Type	Method and Description
protected MessageHandlerKey	chooseNewKey()
protected void	configureListCell(javax.swing.JLabel cell, MessageHandlerKey item)
protected com.jidesoft.editor.CodeEditor	createScriptEditor()
protected java.lang.String	getDefaultNewScript()
protected javax.swing.Icon	getDeleteIcon()
javax.swing.Icon	getIcon()
protected java.lang.String	getListTitle() Return the title for the list
protected javax.swing.Icon	getNewIcon()
protected java.lang.String	getNoun() Return of name of the thing being configured, "timer" for "timer scripts", etc."
protected javax.swing.Icon	getReconfigureIcon()
protected javax.swing.JComponent	getScriptEditorPanel()
protected java.util.Map<MessageHandlerKey,java.lang.String>	getScripts(ScriptConfig sc)
java.lang.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 MessageHandlerKey	reconfigureKey(MessageHandlerKey key)
protected void	setScript(java.lang.String script)
protected void	storeScripts(ScriptConfig sc, java.util.Map<MessageHandlerKey,java.lang.String> scripts)

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

doDelete, doNew, doReconfigure, doSave, getCappedNoun, getScript, init, initComponents, installHints, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

HEADER_FONT

@Deprecated
public static final java.awt.Font HEADER_FONT

Deprecated.

Constructor Detail

MessageHandlerEditor

public MessageHandlerEditor(DesignerContext context,
                            boolean isClient)

MessageHandlerEditor

public MessageHandlerEditor(DesignerContext context,
                            java.lang.String titleKey,
                            boolean isClient)

Method Detail

createScriptEditor

protected com.jidesoft.editor.CodeEditor createScriptEditor()

Overrides:

createScriptEditor in class AbstractMultiScriptEditor<MessageHandlerKey>

getScriptEditorPanel

protected javax.swing.JComponent getScriptEditorPanel()

Overrides:

getScriptEditorPanel in class AbstractMultiScriptEditor<MessageHandlerKey>

setScript

protected void setScript(java.lang.String script)

Overrides:

setScript in class AbstractMultiScriptEditor<MessageHandlerKey>

getDefaultNewScript

protected java.lang.String getDefaultNewScript()

Overrides:

getDefaultNewScript in class AbstractMultiScriptEditor<MessageHandlerKey>

isReconfigureActionPresent

protected boolean isReconfigureActionPresent()

Description copied from class: AbstractMultiScriptEditor

Should item's keys be reconfigurable?

Specified by:

isReconfigureActionPresent in class AbstractMultiScriptEditor<MessageHandlerKey>

getNoun

protected java.lang.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<MessageHandlerKey>

getListTitle

protected java.lang.String getListTitle()

Description copied from class: AbstractMultiScriptEditor

Return the title for the list

Specified by:

getListTitle in class AbstractMultiScriptEditor<MessageHandlerKey>

getNewIcon

protected javax.swing.Icon getNewIcon()

Specified by:

getNewIcon in class AbstractMultiScriptEditor<MessageHandlerKey>

getDeleteIcon

protected javax.swing.Icon getDeleteIcon()

Specified by:

getDeleteIcon in class AbstractMultiScriptEditor<MessageHandlerKey>

getReconfigureIcon

protected javax.swing.Icon getReconfigureIcon()

Specified by:

getReconfigureIcon in class AbstractMultiScriptEditor<MessageHandlerKey>

chooseNewKey

protected MessageHandlerKey chooseNewKey()

Specified by:

chooseNewKey in class AbstractMultiScriptEditor<MessageHandlerKey>

reconfigureKey

protected MessageHandlerKey reconfigureKey(MessageHandlerKey key)

Specified by:

reconfigureKey in class AbstractMultiScriptEditor<MessageHandlerKey>

getScripts

protected java.util.Map<MessageHandlerKey,java.lang.String> getScripts(ScriptConfig sc)

Specified by:

getScripts in class AbstractMultiScriptEditor<MessageHandlerKey>

storeScripts

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

Specified by:

storeScripts in class AbstractMultiScriptEditor<MessageHandlerKey>

getTitleKey

public java.lang.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

getIcon

public javax.swing.Icon getIcon()

Specified by:

getIcon in class GlobalScriptEditor.ScriptConfigPanel

configureListCell

protected void configureListCell(javax.swing.JLabel cell,
                                 MessageHandlerKey item)

Overrides:

configureListCell in class AbstractMultiScriptEditor<MessageHandlerKey>