Package com.inductiveautomation.ignition.designer.gui.tools

Class CodeEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.ignition.designer.gui.tools.CodeEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class CodeEditor
extends JPanel

CodeEditor is a panel that includes a syntax highlighting text area that wraps RSyntaxTextArea. This should be used for e.g. SQL based editing inside the designer, or anywhere else you might need an editor that's able to easily handle multiple different syntaxes.

For Python editing, prefer PythonTextArea or ExtensionFunctionPanel.

For the Jide-based CodeEditor, see CodeEditorFactory, but it is generally not recommended due to issues with high DPI displays.

Since:

7.8.1

See Also:

• CodeEditorFactory
• PythonTextArea
• ExtensionFunctionPanel
• 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 org.fife.rsta.ui.CollapsibleSectionPanel	collapsingSectionPanel
protected org.fife.ui.rtextarea.RTextScrollPane	rTextScrollPane
protected com.inductiveautomation.ignition.designer.gui.tools.DisplayTrackingSyntaxTextArea	textArea

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
CodeEditor()
CodeEditor(DesignerContext context)
CodeEditor(JFrame parent, DesignerContext context)	This constructor will instantiate a CodeEditor and use the context's script manager to populate and initialize the auto completion hints using default color theme and Python syntax highlighting.

Method Summary

Modifier and Type	Method	Description
static void	fixCommentAction(org.fife.ui.rsyntaxtextarea.RSyntaxTextArea textArea)	Remove the pre-seeded 'close tag' action from KeyEvent.VK_SLASH and replace it with RSyntaxTextAreaEditorKit.rstaToggleCommentAction
org.fife.rsta.ui.CollapsibleSectionPanel	getCollapsingSectionPanel()
NamedTheme	getCurrentTheme()
org.fife.ui.rsyntaxtextarea.ErrorStrip	getErrorStrip()
org.fife.ui.rtextarea.RTextScrollPane	getrTextScrollPane()
String	getText()	Returns the text held by the internal RSyntaxText area.
org.fife.ui.rsyntaxtextarea.RSyntaxTextArea	getTextArea()
void	setCurrentTheme(NamedTheme namedTheme)
void	setFont(Font font)

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

textArea

protected com.inductiveautomation.ignition.designer.gui.tools.DisplayTrackingSyntaxTextArea textArea

rTextScrollPane

protected org.fife.ui.rtextarea.RTextScrollPane rTextScrollPane

collapsingSectionPanel

protected org.fife.rsta.ui.CollapsibleSectionPanel collapsingSectionPanel

Constructor Details

CodeEditor

public CodeEditor()

CodeEditor

public CodeEditor(JFrame parent,
 DesignerContext context)

This constructor will instantiate a CodeEditor and use the context's script manager to populate and initialize the auto completion hints using default color theme and Python syntax highlighting.

CodeEditor

public CodeEditor(DesignerContext context)

Method Details

fixCommentAction

public static void fixCommentAction(org.fife.ui.rsyntaxtextarea.RSyntaxTextArea textArea)

Remove the pre-seeded 'close tag' action from KeyEvent.VK_SLASH and replace it with RSyntaxTextAreaEditorKit.rstaToggleCommentAction

Parameters:

textArea - the text area to modify the input map of

getCurrentTheme

public NamedTheme getCurrentTheme()

setCurrentTheme

public void setCurrentTheme(NamedTheme namedTheme)

getCollapsingSectionPanel

public org.fife.rsta.ui.CollapsibleSectionPanel getCollapsingSectionPanel()

getrTextScrollPane

public org.fife.ui.rtextarea.RTextScrollPane getrTextScrollPane()

getErrorStrip

public org.fife.ui.rsyntaxtextarea.ErrorStrip getErrorStrip()

getTextArea

public org.fife.ui.rsyntaxtextarea.RSyntaxTextArea getTextArea()

getText

public String getText()

Returns the text held by the internal RSyntaxText area. If the text area is null, an empty string is returned.

Returns:

the contents of the code editor, or an empty String

setFont

public void setFont(Font font)

Overrides:

setFont in class JComponent