Package com.inductiveautomation.factorypmi.application.components

Class TagBrowseTree

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JScrollPane
com.inductiveautomation.vision.api.client.components.model.AbstractVisionScrollPane
com.inductiveautomation.factorypmi.application.components.TagBrowseTree
All Implemented Interfaces:
DynamicPropertyProvider, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, ExtensibleComponent, QualityMonitor, VisionComponent, ImageObserver, MenuContainer, Serializable, Accessible, ScrollPaneConstants
public class TagBrowseTree extends AbstractVisionScrollPane implements ExtensibleComponent, LocaleListener
See Also:

  • Field Details

    • MODE_REALTIME

      public static final int MODE_REALTIME
      See Also:

    • MODE_HISTORICAL

      public static final int MODE_HISTORICAL
      See Also:

    • tree

      protected JTree tree

    • treeModel

      protected TreeModel treeModel

    • treeSelectionModel

      protected TreeSelectionModel treeSelectionModel

    • selectionListener

      protected TreeSelectionListener selectionListener

    • tagTransferHandler

      protected TransferHandler tagTransferHandler

    • selectionRunner

      protected Runnable selectionRunner

    • startupWorker

      protected TagBrowseTree.StartupWorker startupWorker

    • rootNodePath

      protected String rootNodePath

    • selectedPaths

      protected Dataset selectedPaths

    • selectionMode

      protected int selectionMode

    • treeMode

      protected int treeMode

    • showHistorical

      protected boolean showHistorical

    • showRealtime

      protected boolean showRealtime

    • showRootNode

      protected boolean showRootNode

    • showRootNodeHandles

      protected boolean showRootNodeHandles

    • font

      protected Font font

  • Constructor Details

    • TagBrowseTree

      public TagBrowseTree()

  • Method Details

    • init

      protected void init()

    • getSelectionModel

      protected TreeSelectionModel getSelectionModel()

    • createTransferHandler

      protected TransferHandler createTransferHandler()

    • setContext

      public void setContext(VisionClientContext context)

    • onStartup

      public void onStartup()
      Description copied from class: AbstractVisionScrollPane
      Subclasses should override this to provide startup logic.
      Overrides:
      onStartup in class AbstractVisionScrollPane

    • startupModel

      protected void startupModel()
      sets model and refreshes the nodes on startup (synchronously from calling thread)

    • createInitialDataset

      protected Dataset createInitialDataset()

    • startupTreeModelRoot

      protected void startupTreeModelRoot()

    • toFullQualifiedPath

      protected QualifiedPath toFullQualifiedPath(QualifiedPath qp)
      Calling QualifiedPathUtils to create a QualifiedPath from a string builds out an abbreviated TagPath without any system information, like so: [local_mysql]mytag

      Call this method to get a QualifiedPath that looks like this: [local_mysql:/agent-ide-8088:default]mytag

      This format is needed to match the format of the tag tree

    • getFont

      public Font getFont()
      Specified by:
      getFont in interface MenuContainer
      Overrides:
      getFont in class Component

    • setFont

      public void setFont(Font font)
      Overrides:
      setFont in class JComponent

    • setPreferredSize

      protected void setPreferredSize()

    • getTree

      public JTree getTree()

    • getContext

      public ClientContext getContext()

    • getTreeModel

      public TreeModel getTreeModel()

    • synchDatasetToTree

      protected void synchDatasetToTree()
      synch the selected paths dataset to selected paths of the JTree

    • showError

      protected void showError(String errorMessage)

    • isSame

      protected boolean isSame(String path1, String path2)

    • getStringFromBundle

      protected String getStringFromBundle(String key)

    • dataSetToTreePathsInternal

      protected TreePath[] dataSetToTreePathsInternal(Dataset dataset)

    • pathsInCorrectFormat

      protected boolean pathsInCorrectFormat(Dataset paths)

    • error

      protected void error(String errorMessage)

    • getExtensionFunctions

      public Map<String,ExtensionFunction> getExtensionFunctions()
      Specified by:
      getExtensionFunctions in interface ExtensibleComponent

    • setExtensionFunctions

      public void setExtensionFunctions(Map<String,ExtensionFunction> map)
      Specified by:
      setExtensionFunctions in interface ExtensibleComponent

    • getLog

      public LoggerEx getLog()

    • refresh

      public void refresh()
      this method is used when setting the filterTag extension function and can be used in scripting to properly refresh the component by reloading tags.

    • setRootNodePath

      public void setRootNodePath(String rootNodePath)

    • getRootNodePath

      public String getRootNodePath()

    • getSelectedPaths

      public Dataset getSelectedPaths()

    • setSelectedPaths

      public void setSelectedPaths(Dataset selectedPaths)

    • setSelectedPaths

      protected void setSelectedPaths(Dataset selectedPaths, boolean notifyTree)

    • getSelectionMode

      public int getSelectionMode()

    • setSelectionMode

      public void setSelectionMode(int selectionMode)

    • getTreeMode

      public int getTreeMode()

    • setTreeMode

      public void setTreeMode(int treeMode)

    • isShowHistorical

      public boolean isShowHistorical()

    • setShowHistorical

      public void setShowHistorical(boolean showHistorical)

    • isShowRealtime

      public boolean isShowRealtime()

    • setShowRealtime

      public void setShowRealtime(boolean showRealtime)

    • isShowRootNode

      public boolean isShowRootNode()

    • setShowRootNode

      public void setShowRootNode(boolean showRootNode)

    • isShowRootNodeHandles

      public boolean isShowRootNodeHandles()

    • setShowRootNodeHandles

      public void setShowRootNodeHandles(boolean showRootNodeHandles)

    • localeChanged

      public void localeChanged(Locale newLocale)
      Specified by:
      localeChanged in interface LocaleListener
      Overrides:
      localeChanged in class AbstractVisionScrollPane