com.inductiveautomation.ignition.designer.navtree.model

Class ProjectBrowserRoot

java.lang.Object

com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode

com.inductiveautomation.ignition.designer.navtree.model.MutableNavTreeNode

com.inductiveautomation.ignition.designer.navtree.model.ProjectBrowserRoot

All Implemented Interfaces:

java.lang.Iterable<AbstractNavTreeNode>, javax.swing.tree.TreeNode

public class ProjectBrowserRoot
extends MutableNavTreeNode

The root node of the designer's project browser tree. Designer hook classes may add their own children to the subfolders getGlobalFolder() and getProjectFolder()

See Also:

MutableNavTreeNode.addChild(AbstractNavTreeNode)

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode

AbstractNavTreeNode.DeleteReason, AbstractNavTreeNode.PopupAction, AbstractNavTreeNode.ResourceChangeListener

Field Summary

Fields inherited from class com.inductiveautomation.ignition.designer.navtree.model.MutableNavTreeNode

BY_NAME, BY_SORT_ORDER

Fields inherited from class com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode

bold, children, childrenLoaded, copyAction, cutAction, deleteAction, depth, icon, italic, log, model, name, NAME_PATTERN, parent, pasteAction, protectedAction, protectedMenuItem, renameAction, selectionModel, text, thumbnail, tooltip

Constructor Summary

Constructors

Constructor and Description
ProjectBrowserRoot(Project project, NavTreePanel.EditableTreeModel model, javax.swing.tree.TreeSelectionModel selectionModel, DesignerContext context)

Method Summary

Modifier and Type	Method and Description
MutableNavTreeNode	getConfigFolder() Deprecated. As of Ignition 7.7, this has been replaced by getProjectFolder()
MutableNavTreeNode	getGlobalFolder() Returns the "Global" folder.
ProjectFolder	getProjectFolder() Returns the "Project" folder.
void	notifyGlobalFolderRequired() Call this before you request the global folder.
void	showPopupMenu(java.awt.Component source, int x, int y, int modifiers, javax.swing.tree.TreePath[] paths, java.util.List<AbstractNavTreeNode> selection) Called when a popup triggering event (right click) occurs over this node.

Methods inherited from class com.inductiveautomation.ignition.designer.navtree.model.MutableNavTreeNode

addChild, isChildrenSorted, newComparator

Methods inherited from class com.inductiveautomation.ignition.designer.navtree.model.AbstractNavTreeNode

addBadges, addEditActions, canCopy, canDelete, canDrag, canDrop, canPaste, checkChildren, children, confirmDelete, createProjectCopy, debug, debug, dispatchSelectionEvent, doCopy, doCut, doDelete, doPaste, expand, findChild, findCommonEditActionHandler, findDropHandler, findEditActionHandler, forceChildrenReload, getAllowsChildren, getChildAt, getChildCount, getClipboard, getCommonEditActionHandler, getDepth, getExpandedIcon, getIcon, getIndex, getModel, getName, getParent, getSelectionModel, getSortOrder, getText, getThumbnail, getTooltip, getWorkspaceName, initPopupMenu, install, isBold, isEditable, isEditActionHandler, isItalic, isLeaf, isProtected, isProtectedEnabled, isSelected, isValidName, iterator, loadChildren, newLogger, notifyChildNameChanged, onChildrenSelected, onDoubleClick, onEdit, onSelected, pathToRoot, recreate, refresh, reload, select, select, setBold, setChildren, setIcon, setItalic, setName, setProtected, setText, setThumbnail, setTooltip, setupEditActions, showPopup, toString, uninstall, uninstallChildren, useThumbnailTooltip

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ProjectBrowserRoot

public ProjectBrowserRoot(Project project,
                          NavTreePanel.EditableTreeModel model,
                          javax.swing.tree.TreeSelectionModel selectionModel,
                          DesignerContext context)

Method Detail

getConfigFolder

@Deprecated
public MutableNavTreeNode getConfigFolder()

Deprecated. As of Ignition 7.7, this has been replaced by getProjectFolder()

getProjectFolder

public ProjectFolder getProjectFolder()

Returns the "Project" folder. You may add your own children to this if they represent something stored in the (non-global) project

getGlobalFolder

public MutableNavTreeNode getGlobalFolder()

Returns the "Global" folder. Note that you must call notifyGlobalFolderRequired() before attempting to use the global folder

notifyGlobalFolderRequired

public void notifyGlobalFolderRequired()

Call this before you request the global folder. It is created on-demand, so that if nobody needs it it won't show up.

See Also:

getGlobalFolder()

showPopupMenu

public void showPopupMenu(java.awt.Component source,
                          int x,
                          int y,
                          int modifiers,
                          javax.swing.tree.TreePath[] paths,
                          java.util.List<AbstractNavTreeNode> selection)

Description copied from class: AbstractNavTreeNode

Called when a popup triggering event (right click) occurs over this node.

Overrides:

showPopupMenu in class AbstractNavTreeNode

Parameters:

source - The component to use as the invoker for the popup menu.

x - popup location x value

y - popup location y value

modifiers - extended modifier mask for this event, e.g. this which end with the _DOWN_MASK suffix, such as ALT_DOWN_MASK, BUTTON1_DOWN_MASK, and others, as defined in InputEvent.getModifiers() )}

selection - The list of currently selected nodes.