Package com.inductiveautomation.ignition.designer.sqltags.config.ui

Class TagObjectEditor

  • All Implemented Interfaces:
    TagEditor, com.jidesoft.dialog.ButtonNames, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
    public class TagObjectEditor
extends com.jidesoft.dialog.StandardDialog
implements TagEditor
    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

        javax.swing.JDialog.AccessibleJDialog

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

        java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

        java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

        _propertyChangeListener, _standardDialogPane, RESULT_AFFIRMED, 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addTag​(TagPath parentFolder, TagType type)
      Creates a new tag of the given type.
      void addTag​(TagPath parentFolder, TagDefinition tagDef)
      Edits the new tag definition, and will add it to the gateway under the specified path on commit.
      protected void closeDialog()  
      javax.swing.JComponent createBannerPanel()  
      com.jidesoft.dialog.ButtonPanel createButtonPanel()  
      javax.swing.JComponent createContentPanel()  
      protected void doApply()  
      protected void editTags​(TagObjectEditorPanel.OperationMode mode, java.util.List<TagPath> paths, java.util.List<Tag> objects, TagDiff edit, boolean ensureVisible)  
      void editTags​(java.util.List<TagPath> paths)  
      void editTags​(java.util.List<TagPath> paths, TagDiff edit)
      Edits the specified tags, starting with the current edit diff.
      void editTags​(java.util.List<TagPath> paths, java.util.List<Tag> tags)
      Deprecated because the edit function will no longer use the provided objects, instead it loads them from the gateway on edit.
      void editTags​(java.util.List<TagPath> paths, java.util.List<Tag> tags, TagDiff startingEdit)
      Deprecated because the function will not use the passed in objects any more, it looks them up each time.
      ClientSubManager getTargetManager()  
      protected void loadAndShowTags​(java.util.List<TagPath> paths, TagDiff startingEdit, boolean ensureVisible, TagPath selectedPath)  
      protected void makeVisible()  
      protected void reset()  
      protected void setButtonsEnabled​(boolean value)  
      void tagsSelected​(java.util.List<TagPath> paths)  
      void tagsSelected​(java.util.List<TagPath> paths, java.util.List<Tag> tags)
      Deprecated because the function will not use the passed in objects any more, it looks them up each time.
      protected boolean tryCommit​(boolean isApply)
      Commits the edits and returns whether the edit was successful.

      • 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.sqltags.editor.TagEditor

        isShowing

    • Constructor Detail

    • Method Detail

      • createContentPanel

        public javax.swing.JComponent createContentPanel()
        Specified by:
        createContentPanel in class com.jidesoft.dialog.StandardDialog

      • createButtonPanel

        public com.jidesoft.dialog.ButtonPanel createButtonPanel()
        Specified by:
        createButtonPanel in class com.jidesoft.dialog.StandardDialog

      • makeVisible

        protected void makeVisible()

      • setButtonsEnabled

        protected void setButtonsEnabled​(boolean value)

      • tryCommit

        protected boolean tryCommit​(boolean isApply)
        Commits the edits and returns whether the edit was successful. If isApply is true, "success" is considered no errors and changes made. If false, success is simply no errors.

      • reset

        protected void reset()

      • loadAndShowTags

        protected void loadAndShowTags​(java.util.List<TagPath> paths,
                               TagDiff startingEdit,
                               boolean ensureVisible,
                               TagPath selectedPath)

      • closeDialog

        protected void closeDialog()

      • doApply

        protected void doApply()

      • editTags

        public void editTags​(java.util.List<TagPath> paths,
                     TagDiff edit)
        Description copied from interface: TagEditor
        Edits the specified tags, starting with the current edit diff.
        Specified by:
        editTags in interface TagEditor

      • editTags

        public void editTags​(java.util.List<TagPath> paths,
                     java.util.List<Tag> tags)
        Description copied from interface: TagEditor
        Deprecated because the edit function will no longer use the provided objects, instead it loads them from the gateway on edit.
        Specified by:
        editTags in interface TagEditor

      • editTags

        public void editTags​(java.util.List<TagPath> paths,
                     java.util.List<Tag> tags,
                     TagDiff startingEdit)
        Description copied from interface: TagEditor
        Deprecated because the function will not use the passed in objects any more, it looks them up each time.
        Specified by:
        editTags in interface TagEditor

      • addTag

        public void addTag​(TagPath parentFolder,
                   TagType type)
        Description copied from interface: TagEditor
        Creates a new tag of the given type. The preferred method is to pass in the base definition using the other overload.
        Specified by:
        addTag in interface TagEditor

      • addTag

        public void addTag​(TagPath parentFolder,
                   TagDefinition tagDef)
        Description copied from interface: TagEditor
        Edits the new tag definition, and will add it to the gateway under the specified path on commit.
        Specified by:
        addTag in interface TagEditor

      • tagsSelected

        public void tagsSelected​(java.util.List<TagPath> paths,
                         java.util.List<Tag> tags)
        Description copied from interface: TagEditor
        Deprecated because the function will not use the passed in objects any more, it looks them up each time.
        Specified by:
        tagsSelected in interface TagEditor

      • createBannerPanel

        public javax.swing.JComponent createBannerPanel()
        Specified by:
        createBannerPanel in class com.jidesoft.dialog.StandardDialog