Package com.inductiveautomation.ignition.designer.tags.editing.dialog

Class TagEditorDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.jidesoft.dialog.StandardDialog

com.inductiveautomation.ignition.designer.tags.editing.dialog.TagEditorDialog

All Implemented Interfaces:

ConfigModificationListener, TagEditor, TagEditParent, com.jidesoft.dialog.ButtonNames, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class TagEditorDialog
extends com.jidesoft.dialog.StandardDialog
implements TagEditor, TagEditParent, ConfigModificationListener

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jidesoft.dialog.StandardDialog

com.jidesoft.dialog.StandardDialog.DefaultStandardDialogPane

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

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 inherited from class com.jidesoft.dialog.StandardDialog

_propertyChangeListener, _standardDialogPane, RESULT_AFFIRMED, RESULT_CANCELED, RESULT_CANCELLED

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.jidesoft.dialog.ButtonNames

APPLY, BACK, BROWSE, CANCEL, CLEAR, CLOSE, DETAILS, EDIT, EXIT, FIND, FIND_NEXT, FINISH, FORWARD, HELP, NEW, NEXT, NO, OK, OPEN, PRINT, REPLACE, RESET, RETRY, RUN, SAVE, SAVE_AS, STOP, YES

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
TagEditorDialog(DesignerContext context)

Method Summary

Modifier and Type	Method	Description
protected void	applyButtonClicked()
protected void	commitEdits()
protected void	configureButton(AbstractButton button)
JComponent	createBannerPanel()
com.jidesoft.dialog.ButtonPanel	createButtonPanel()
JComponent	createContentPanel()
void	createTag(TagConfiguration base)
void	editTags(List<TagPath> paths)
void	fireEvent(com.inductiveautomation.ignition.designer.tags.editing.event.TagEditorEvent event)
TagEditController	getController()
DesignerContext	getDesignerContext()
Optional<com.inductiveautomation.ignition.designer.tags.editing.dialog.DetailSplitPanel>	getDetailSplitPanel()	A split pane showing property editing and additional meta info about those properties.
Component	getFrame()	The frame used to center additional child windows
Optional<TagStructurePanel>	getTagStructurePanel()	The current UDT structure shown in tree form
BoundPropertySet	getTarget()	The current tag config
protected TagPath	getUdtRootPath(TagPath path)	IF the given path is somewhere inside of a complex tag, returns the path to the top level object.
protected void	initEditor()	This ensures the primary display is shown (heirarchy+props or props+info, depending on mode/situation)
void	markModified()	Notify the parent that something has been modified in the current target property set, in case they care.
void	onConfigModified()
protected void	prepUI(String provider, boolean isNew, TagObjectType tagType)
protected void	refreshConfigModel(String provider)
protected void	refreshName(List<TagConfigurationModel> selected)
protected void	selectedModelsChanged(List<TagConfigurationModel> models, Set<String> bindingModel)	Takes the TagConfigurationModels, creates an edit controller, and inits the edit UI.
protected void	setButtonsEnabled(boolean enabled)
void	updateLoadingMessage(String value)
QualityCode	validateTypePath(String dataTypePath, boolean isUdtInstance)	Optionally hand over control of UDT type path validation to the parent

Methods inherited from class com.jidesoft.dialog.StandardDialog

createOKCancelButtonPanel, createStandardDialogPane, getBannerPanel, getButtonPanel, getContentPanel, getDefaultAction, getDefaultCancelAction, getDialogResult, getInitFocusedComponent, getStandardDialogPane, initComponents, initialize, pack, setDefaultAction, setDefaultCancelAction, setDialogResult, setInitFocusedComponent, show

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.designer.tags.editing.TagEditor

editTag, isShowing

Methods inherited from interface com.inductiveautomation.ignition.designer.tags.editing.TagEditParent

getEditValidator, isMutable

Constructor Details

TagEditorDialog

public TagEditorDialog(DesignerContext context)

Method Details

setButtonsEnabled

protected void setButtonsEnabled(boolean enabled)

createButtonPanel

public com.jidesoft.dialog.ButtonPanel createButtonPanel()

Specified by:

createButtonPanel in class com.jidesoft.dialog.StandardDialog

initEditor

protected void initEditor()

This ensures the primary display is shown (heirarchy+props or props+info, depending on mode/situation)

createBannerPanel

public JComponent createBannerPanel()

Specified by:

createBannerPanel in class com.jidesoft.dialog.StandardDialog

createContentPanel

public JComponent createContentPanel()

Specified by:

createContentPanel in class com.jidesoft.dialog.StandardDialog

configureButton

protected void configureButton(AbstractButton button)

commitEdits

protected void commitEdits()

applyButtonClicked

protected void applyButtonClicked()

updateLoadingMessage

public void updateLoadingMessage(String value)

prepUI

protected void prepUI(String provider,
 boolean isNew,
 TagObjectType tagType)

getUdtRootPath

protected TagPath getUdtRootPath(TagPath path)

IF the given path is somewhere inside of a complex tag, returns the path to the top level object. Returns null if the path is not in a UDT.

createTag

public void createTag(TagConfiguration base)

Specified by:

createTag in interface TagEditor

editTags

public void editTags(List<TagPath> paths)

Specified by:

editTags in interface TagEditor

refreshName

protected void refreshName(List<TagConfigurationModel> selected)

selectedModelsChanged

protected void selectedModelsChanged(List<TagConfigurationModel> models,
 Set<String> bindingModel)

Takes the TagConfigurationModels, creates an edit controller, and inits the edit UI. Also stops the loading UI.

refreshConfigModel

protected void refreshConfigModel(String provider)

validateTypePath

public QualityCode validateTypePath(String dataTypePath,
 boolean isUdtInstance)

Description copied from interface: TagEditParent

Optionally hand over control of UDT type path validation to the parent

Specified by:

validateTypePath in interface TagEditParent

getController

public TagEditController getController()

Specified by:

getController in interface TagEditParent

getTarget

public BoundPropertySet getTarget()

Description copied from interface: TagEditParent

The current tag config

Specified by:

getTarget in interface TagEditParent

getTagStructurePanel

public Optional<TagStructurePanel> getTagStructurePanel()

Description copied from interface: TagEditParent

The current UDT structure shown in tree form

Specified by:

getTagStructurePanel in interface TagEditParent

getDetailSplitPanel

public Optional<com.inductiveautomation.ignition.designer.tags.editing.dialog.DetailSplitPanel> getDetailSplitPanel()

Description copied from interface: TagEditParent

A split pane showing property editing and additional meta info about those properties.

Specified by:

getDetailSplitPanel in interface TagEditParent

markModified

public void markModified()

Description copied from interface: TagEditParent

Notify the parent that something has been modified in the current target property set, in case they care.

Specified by:

markModified in interface TagEditParent

fireEvent

public void fireEvent(com.inductiveautomation.ignition.designer.tags.editing.event.TagEditorEvent event)

Specified by:

fireEvent in interface TagEditParent

getFrame

public Component getFrame()

Description copied from interface: TagEditParent

The frame used to center additional child windows

Specified by:

getFrame in interface TagEditParent

getDesignerContext

public DesignerContext getDesignerContext()

Specified by:

getDesignerContext in interface TagEditParent

onConfigModified

public void onConfigModified()

Specified by:

onConfigModified in interface ConfigModificationListener