Package com.inductiveautomation.sfc.designer.api

Class ElementEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.sfc.designer.api.ElementEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

AbstractStepEditor, ChartPropsEditor, JumpEditor, NoteEditor, ParallelEditor, TransitionEditor

public abstract class ElementEditor
extends JPanel

UI element used to configure a selected chart element.

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 DelegatingEditActionHandler	editActionHandler	The DelegatingEditActionHandler used to delegate to EditActionHandlers of children of this component.
protected static final int	SCRIPT_WIDTH

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	ElementEditor(LayoutManager layoutManager)

Method Summary

Modifier and Type	Method	Description
abstract void	commitEdit()	Gives the editor a change to flush its changes out to the element it is representing
protected CodeEditorEditActionHandler	createCodeEditorEditActionHandler(com.jidesoft.editor.CodeEditor editor)	Internal factory method for creating new CodeEditorEditActionHandlers injected with the given CodeEditor
protected DelegatingEditActionHandlerFocusAdapter	createDelegatingEditActionHandlerFocusAdapter(EditActionHandler delegate)	Internal factory method for creating new DelegatingEditActionHandlerFocusAdapters injected with the given EditActionHandler delegate.
protected DelegatingEditActionHandlerFocusAdapter	createDelegatingEditActionHandlerFocusAdapter(Component parent, DelegatingEditActionHandler delegator, EditActionHandler delegate)	Internal factory method for creating new DelegatingEditActionHandlerFocusAdapters injected with the given parent Component which owns the delegator, DelegatingEditActionHandler delegator used to delegate handling of the Designer's edit actions to EditActionHandlers of children of the given parent component, and EditActionHandler delegate which will be delegated the handling of the edit actions of the Designer when its component is focused
protected JTextComponentEditActionHandler	createJTextComponentEditActionHandler(JTextComponent jTextComponent)	Internal factory method for creating new JTextComponentEditActionHandlers injected with the given JTextComponent
protected PythonTextAreaEditActionHandler	createPythonTextAreaEditActionHandler(com.inductiveautomation.ignition.designer.gui.tools.PythonTextArea editor)
EditActionHandler	getEditActionHandler()	Getter for the EditActionHandler for this ElementEditor which can be used to hook into the Designer's edit menu and toolbar.
static Icon	icon(String path)

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

SCRIPT_WIDTH

protected static final int SCRIPT_WIDTH

See Also:

• Constant Field Values

editActionHandler

protected DelegatingEditActionHandler editActionHandler

The DelegatingEditActionHandler used to delegate to EditActionHandlers of children of this component.

Constructor Details

ElementEditor

protected ElementEditor(LayoutManager layoutManager)

Method Details

commitEdit

public abstract void commitEdit()

Gives the editor a change to flush its changes out to the element it is representing

icon

public static Icon icon(String path)

getEditActionHandler

public EditActionHandler getEditActionHandler()

Getter for the EditActionHandler for this ElementEditor which can be used to hook into the Designer's edit menu and toolbar.

Returns:

The EditActionHandler for this ElementEditor

createDelegatingEditActionHandlerFocusAdapter

protected DelegatingEditActionHandlerFocusAdapter createDelegatingEditActionHandlerFocusAdapter(Component parent,
 DelegatingEditActionHandler delegator,
 EditActionHandler delegate)

Internal factory method for creating new DelegatingEditActionHandlerFocusAdapters injected with the given parent Component which owns the delegator, DelegatingEditActionHandler delegator used to delegate handling of the Designer's edit actions to EditActionHandlers of children of the given parent component, and EditActionHandler delegate which will be delegated the handling of the edit actions of the Designer when its component is focused

Parameters:

parent - The parent Component which owns the delegator

delegator - The DelegatingEditActionHandler to inject

delegate - The EditActionHandler to inject

Returns:

The new DelegatingEditActionHandlerFocusAdapter instance

See Also:

• createDelegatingEditActionHandlerFocusAdapter(EditActionHandler)

createJTextComponentEditActionHandler

protected JTextComponentEditActionHandler createJTextComponentEditActionHandler(JTextComponent jTextComponent)

Internal factory method for creating new JTextComponentEditActionHandlers injected with the given JTextComponent

Parameters:

jTextComponent - The JTextComponent to inject

Returns:

The new instance of JTextComponentEditActionHandler

createCodeEditorEditActionHandler

protected CodeEditorEditActionHandler createCodeEditorEditActionHandler(com.jidesoft.editor.CodeEditor editor)

Internal factory method for creating new CodeEditorEditActionHandlers injected with the given CodeEditor

Parameters:

editor - The CodeEditor to inject

Returns:

The new instance of CodeEditorEditActionHandler

createPythonTextAreaEditActionHandler

protected PythonTextAreaEditActionHandler createPythonTextAreaEditActionHandler(com.inductiveautomation.ignition.designer.gui.tools.PythonTextArea editor)

createDelegatingEditActionHandlerFocusAdapter

protected DelegatingEditActionHandlerFocusAdapter createDelegatingEditActionHandlerFocusAdapter(EditActionHandler delegate)

Internal factory method for creating new DelegatingEditActionHandlerFocusAdapters injected with the given EditActionHandler delegate. In this case, the parent will be this and the delegator will be editActionHandler

Parameters:

delegate - The EditActionHandler to inject

Returns:

The new DelegatingEditActionHandlerFocusAdapter instance

See Also:

• createDelegatingEditActionHandlerFocusAdapter(Component, DelegatingEditActionHandler, EditActionHandler)