Package com.inductiveautomation.ignition.client.jsonedit

Class JsonEditor

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.ignition.client.jsonedit.JsonEditor

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

ComponentScopeEditor

public class JsonEditor
extends JPanel

Created by carlg on 5/15/2017.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JsonEditor.AddNodeMenu
static class	JsonEditor.HierarchyIcon
protected class	JsonEditor.NewNodeAction

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
static final Icon	COLLAPSED
static final Icon	EXPANDED
protected DocumentModel	model
static final int	SCROLL_BLOCK_INCREMENT
static final int	SCROLL_UNIT_INCREMENT

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
JsonEditor(DocumentModel model, boolean showRoot)
JsonEditor(String json, boolean showRoot)

Method Summary

Modifier and Type	Method	Description
int	applyFilter(com.jidesoft.filter.Filter<String> filter)
protected final JComponent	centerComponent()
void	clearFilter()
void	collapseAll()
void	commitEdit()
protected void	configureInsertMenu(MenuLike menu, DocumentNode parent, int insertPt)
void	expandAll()
Optional<NodeEditor>	findEditorFor(JsonPath path)
String	getJson()	Get the current state of the edited model as a json document
String	getJson(boolean prettyPrint)
com.inductiveautomation.ignition.common.gson.JsonElement	getJsonElement()	Get the current state of the edited model as a gson object
DocumentModel	getModel()
boolean	insertDefaultItem(DocumentNode parent, int index)	Insert a new node on the parent representing the default value as declared in it's schema.
protected void	insertNewNode(DocumentNode parent, DocumentNode newNode, int insertionPoint)
protected boolean	isScrollable()
protected boolean	isToolbarVisible()
static void	main(String[] args)
protected NodeEditor	newNodeEditor(int depth, NodeEditor parent, DocumentNode node)
protected Object	newValueValue()	The actual value to use for new "Value" nodes.
void	setModel(DocumentModel model)	Sets the model for this editor

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

SCROLL_UNIT_INCREMENT

public static final int SCROLL_UNIT_INCREMENT

See Also:

• Constant Field Values

SCROLL_BLOCK_INCREMENT

public static final int SCROLL_BLOCK_INCREMENT

See Also:

• Constant Field Values

model

protected DocumentModel model

COLLAPSED

public static final Icon COLLAPSED

EXPANDED

public static final Icon EXPANDED

Constructor Details

JsonEditor

public JsonEditor(String json,
 boolean showRoot)

JsonEditor

public JsonEditor(DocumentModel model,
 boolean showRoot)

Method Details

findEditorFor

public Optional<NodeEditor> findEditorFor(JsonPath path)

setModel

public void setModel(DocumentModel model)

Sets the model for this editor

newNodeEditor

protected NodeEditor newNodeEditor(int depth,
 NodeEditor parent,
 DocumentNode node)

insertDefaultItem

public boolean insertDefaultItem(DocumentNode parent,
 int index)

Insert a new node on the parent representing the default value as declared in it's schema.

Parameters:

parent - The parent node to insert new node.

index - The index in which to add the new node.

Returns:

{boolean} Returns true if a new default item node was inserted, false otherwise.

centerComponent

protected final JComponent centerComponent()

applyFilter

public int applyFilter(com.jidesoft.filter.Filter<String> filter)

clearFilter

public void clearFilter()

isToolbarVisible

protected boolean isToolbarVisible()

isScrollable

protected boolean isScrollable()

getModel

public DocumentModel getModel()

expandAll

public void expandAll()

collapseAll

public void collapseAll()

commitEdit

public void commitEdit()

getJsonElement

public com.inductiveautomation.ignition.common.gson.JsonElement getJsonElement()

Get the current state of the edited model as a gson object

getJson

public String getJson()

Get the current state of the edited model as a json document

getJson

public String getJson(boolean prettyPrint)

insertNewNode

protected void insertNewNode(DocumentNode parent,
 DocumentNode newNode,
 int insertionPoint)

configureInsertMenu

protected void configureInsertMenu(MenuLike menu,
 DocumentNode parent,
 int insertPt)

newValueValue

protected Object newValueValue()

The actual value to use for new "Value" nodes.

main

public static void main(String[] args)