org.eclipse.rse.ui.view
Class SystemView

java.lang.Object
  org.eclipse.jface.viewers.Viewer
      org.eclipse.jface.viewers.ContentViewer
          org.eclipse.jface.viewers.StructuredViewer
              org.eclipse.jface.viewers.AbstractTreeViewer
                  org.eclipse.jface.viewers.TreeViewer
                      org.eclipse.rse.ui.view.SystemView

All Implemented Interfaces:

EventListener, IInputProvider, IInputSelectionProvider, IMenuListener, IPostSelectionProvider, ISelectionChangedListener, ISelectionProvider, ISystemDeleteTarget, ISystemRemoteChangeListener, ISystemRenameTarget, ISystemResourceChangeEvents, ISystemResourceChangeListener, ISystemSelectAllTarget, ISystemTree, ITreeViewerListener

public class SystemView

extends TreeViewer

implements ISystemTree, ISystemResourceChangeListener, ISystemRemoteChangeListener, IMenuListener, ISelectionChangedListener, ISelectionProvider, ITreeViewerListener, ISystemResourceChangeEvents, ISystemDeleteTarget, ISystemRenameTarget, ISystemSelectAllTarget

This subclass of the standard JFace tree viewer is used to show a tree view of connections to remote systems, which can be manipulated and expanded to access remote objects in the remote system.

Nested Class Summary

protected class	SystemView.FilterMatch Inner class to ensapsulate what is put in the vector for the recursiveFindAllRemoteItemFilterReferences() method.
class	SystemView.ResourceChangedJob Inner class which extends UIJob to connect this connection on the UI Thread when no Shell is available from the caller

Nested classes inherited from class org.eclipse.jface.viewers.StructuredViewer

StructuredViewer.ColorAndFontCollector, StructuredViewer.ColorAndFontCollectorWithProviders

Field Summary

protected List	_setList
protected boolean	areAnyRemote
protected Cursor	busyCursor
protected SystemCollapseAction	collapseAction
boolean	debug
boolean	debugProperties
boolean	debugRemote
protected SystemCommonDeleteAction	deleteAction
boolean	doTimings
SystemElapsedTimer	elapsedTime
protected boolean	enabledMode
protected SystemExpandAction	expandAction
protected boolean	expandingTreeOnly
protected Hashtable	expandToFiltersByObject
protected Hashtable	expandToFiltersByTreePath
protected boolean	fromSystemViewPart
protected GoIntoAction	goIntoAction
protected SystemCascadingGoToAction	gotoActions
protected boolean	hardCodedConnectionSelected
protected ViewerFilter[]	initViewerFilters
protected ISystemViewInputProvider	inputProvider
protected TreeItem	inputTreeItem
protected static int	LEFT_BUTTON
protected boolean	menuListenerAdded
protected MenuManager	menuMgr
protected ISystemMessageLine	messageLine
protected boolean	mixedSelection
protected int	mouseButtonPressed
protected SystemNewConnectionAction	newConnectionAction
protected SystemOpenExplorerPerspectiveAction	openToPerspectiveAction
protected Object	previousInput
protected IHost	previousInputConnection
protected ISystemViewInputProvider	previousInputProvider
protected Widget	previousItem
protected PropertyDialogAction	propertyDialogAction
protected SystemRefreshAction	refreshAction
protected SystemRemotePropertiesAction	remotePropertyDialogAction
protected SystemCommonRenameAction	renameAction
protected static int	SEARCH_INFINITE
protected int	searchDepth
protected SystemCommonSelectAllAction	selectAllAction
protected boolean	selectionEnableDeleteAction
protected boolean	selectionEnableRenameAction
protected boolean	selectionFlagsUpdated
protected boolean	selectionHasAncestorRelation
protected boolean	selectionIsRemoteObject
protected boolean	selectionShowDeleteAction
protected boolean	selectionShowGenericShowInTableAction
protected boolean	selectionShowOpenViewActions
protected boolean	selectionShowRefreshAction
protected boolean	selectionShowRenameAction
protected Shell	shell
protected boolean	showActions
protected SystemShowInMonitorAction	showInMonitorAction
protected SystemShowInTableAction	showInTableAction
protected boolean	specialMode

Fields inherited from class org.eclipse.jface.viewers.AbstractTreeViewer

ALL_LEVELS

Fields inherited from class org.eclipse.jface.viewers.Viewer

WIDGET_DATA_KEY

Fields inherited from interface org.eclipse.rse.model.ISystemResourceChangeEvents

EVENT_ADD, EVENT_ADD_FILTER_REFERENCE, EVENT_ADD_FILTERSTRING_REFERENCE, EVENT_ADD_MANY, EVENT_ADD_RELATIVE, EVENT_CHANGE_CHILDREN, EVENT_CHANGE_FILTER_REFERENCE, EVENT_CHANGE_FILTERSTRING_REFERENCE, EVENT_COLLAPSE_ALL, EVENT_COLLAPSE_SELECTED, EVENT_COMMAND_FINISHED, EVENT_COMMAND_HISTORY_UPDATE, EVENT_COMMAND_MESSAGE, EVENT_COMMAND_RUN, EVENT_COMMAND_SHELL_FINISHED, EVENT_COMMAND_SHELL_REMOVED, EVENT_COMPILE_COMMAND_RUN, EVENT_DELETE, EVENT_DELETE_FILTER_REFERENCE, EVENT_DELETE_FILTERSTRING_REFERENCE, EVENT_DELETE_MANY, EVENT_EXPAND_SELECTED, EVENT_ICON_CHANGE, EVENT_MOVE_FILTER_REFERENCES, EVENT_MOVE_FILTERSTRING_REFERENCES, EVENT_MOVE_MANY, EVENT_MUST_COLLAPSE, EVENT_PROPERTY_CHANGE, EVENT_PROPERTYSHEET_UPDATE, EVENT_REFRESH, EVENT_REFRESH_REMOTE, EVENT_REFRESH_SELECTED, EVENT_REFRESH_SELECTED_FILTER, EVENT_REFRESH_SELECTED_PARENT, EVENT_RENAME, EVENT_RENAME_FILTER_REFERENCE, EVENT_REPLACE_CHILDREN, EVENT_REVEAL_AND_SELECT, EVENT_SEARCH_FINISHED, EVENT_SELECT, EVENT_SELECT_EXPAND, EVENT_SELECT_REMOTE, PROPERTYSHEET_UPDATE_EVENT

Constructor Summary

SystemView(Shell shell, Composite parent, int style, ISystemViewInputProvider inputProvider, ISystemMessageLine msgLine)
Constructor to use when you want to specify styles for the tree widget

SystemView(Shell shell, Composite parent, int style, ISystemViewInputProvider inputProvider, ISystemMessageLine msgLine, ViewerFilter[] initViewerFilters)
Constructor to use when you want to specify styles for the tree widget

SystemView(Shell shell, Composite parent, ISystemViewInputProvider inputProvider, ISystemMessageLine msgLine)
Constructor

SystemView(Shell shell, Tree tree, ISystemViewInputProvider inputProvider, ISystemMessageLine msgLine)
Constructor to use when you create your own tree widget.

Method Summary

void	add(Object parentElementOrTreePath, Object[] childElements)
protected void	addObjectActions(SystemMenuManager menu) Contributes popup menu actions and submenus registered for the object type(s) in the current selection.
protected boolean	affectsInput(Object element) Test if the given input is our view's input object.
protected boolean	affectsInput(Object[] elements) Test if the given input is our view's input object.
boolean	areAnySelectedItemsExpandable() Returns true if any of the selected items are expandable but not yet expanded
boolean	areAnySelectedItemsExpanded() Returns true if any of the selected items are currently expanded
protected boolean	areSelectionsRemote() Decides whether all the selected objects are remote objects or not Assumes scanSelections() has already been called
boolean	canDelete() Required method from ISystemDeleteTarget Decides whether to enable the delete menu item.
boolean	canRename() Required method from ISystemRenameTarget Decides whether to enable the rename menu item.
void	clearMessage() Clear message/status shown on the message/status line
protected void	clearSelection() Clear current selection.
protected void	close() Close us!
void	collapseNode(Object element, boolean forceRefresh) Helper method to collapse a node in the tree.
void	collapseSelected() Handles a collapse-selected request
static IMenuManager	createStandardGroups(IMenuManager menu) Creates the Systems plugin standard groups in a context menu.
protected void	deleteRemoteObject(Object deleteObject, ISubSystem subsystem) Delete all occurrences of a given remote object
void	displayMessage(String msg) Display a message/status on the message/status line
boolean	doDelete(IProgressMonitor monitor) Required method from ISystemDeleteTarget
protected Widget	doFindItem(Object element)
protected void	doOurInternalRefresh(Widget widget, Object element, boolean doStruct, boolean doTimings, boolean firstCall)
boolean	doRename(String[] newNames) Required method from ISystemRenameTarget
void	doSelectAll(IStructuredSelection selection) When this action is run via Edit->Select All or via Ctrl+A, perform the select all action.
boolean	enableSelectAll(IStructuredSelection selection) Return true if select all should be enabled for the given object.
Item	expandRemoteObject(Object remoteObject, ISubSystem subsystem, Object parentObject) Expand a remote object within the tree.
void	expandSelected() Handles an expand-selected request
void	expandTo(String filterString) Called when user selects an Expand To action to expand the selected remote object with a quick filter
void	fillContextMenu(IMenuManager menu) This is method is called to populate the popup menu
protected Vector	findAllRemoteItemFilterReferences(String elementName, ISubSystem subsystem, Vector matches) Recursively tries to find all filters affected by a given remote object.
protected Vector	findAllRemoteItemReferences(Object element, Object elementObject, Vector matches) Recursively tries to find a given remote object.
protected Vector	findAllRemoteItemReferences(String searchString, Object elementObject, ISubSystem subsystem, Vector matches) Recursively tries to find all occurrences of a given remote object, starting at the tree root.
protected void	findAndUpdateFilter(ISystemResourceChangeEvent event, int type) We don't show actual filters, only filter references that are unique generated for each subtree of each subsystem.
protected void	findAndUpdateFilterParent(ISystemResourceChangeEvent event, int type) We don't show actual filters, only filter references that are unique generated for each subtree of each subsystem.
protected void	findAndUpdateFilterString(ISystemResourceChangeEvent event, int type)
Item	findFirstRemoteItemReference(Object remoteObject, Item parentItem) Find the first binary-match or name-match of a remote object, given its binary object.
Item	findFirstRemoteItemReference(String remoteObjectName, ISubSystem subsystem, Item parentItem) Find the first binary-match or name-match of remote object, given its absolute name.
protected void	gatherExpandedChildren(TreeItem parentItem, TreeItem startingItem, ArrayList listToPopulate) Gather up all expanded children of the given tree item into a list that can be used later to reexpand.
protected ISystemViewElementAdapter	getAdapter(Object o) Returns the implementation of ISystemViewElement for the given object.
int	getChildCount(Object element) Return the number of immediate children in the tree, for the given tree node
IAction	getCollapseAction()
Menu	getContextMenu() Return the popup menu for the tree
MenuManager	getContextMenuManager() Return the popup menu for the tree
IAction	getDeleteAction() Rather than pre-defined this common action we wait until it is first needed, for performance reasons.
Object[]	getElementNodes(Object element) This returns an array containing each element in the tree, up to but not including the root.
Object[]	getElementNodes(TreeItem item) This returns an array containing each element in the tree, up to but not including the root.
protected Object	getElementParent(Object inputObj)
IAction	getExpandAction()
String	getExpandToFilter(Object element) Callback from the input provider to test if the given node has expand-to filtering criteria
Hashtable	getExpandToFilterTable() To support restoring state we need to write out to disk out current table that maps tree items to their current expand-to filter.
protected Object	getFirstRemoteObject(Vector matches) Given the result of findAllRemoteItemReferences, scan for first non-filter object
protected TreeItem	getFirstSelectedTreeItem() Return the tree item of the first selected object
protected String	getFirstSelectionName(ISelection s)
GoIntoAction	getGoIntoAction() Get the common "Go Into" action for drilling down in the Remote System Explorer view, scoped to the currently selected object.
SystemCascadingGoToAction	getGoToActions() Get the common "Go To->" cascading menu action for navigating the frame list.
protected IHost	getInputConnection(Object inputObj)
ISystemViewInputProvider	getInputProvider() Return the input provider
protected int	getItemIndex(Widget parent, Object element) Get index of item given its data element
protected String	getItemNodeID(TreeItem item) Return the string identifying this node in the tree
TreeItem[]	getItemNodes(TreeItem item) This returns an array containing each element in the tree, up to but not including the root.
protected String	getItemPath(TreeItem item) Return the fully-qualified path up to the given item, expressible as a string
IAction	getNewConnectionAction() Rather than pre-defining this common action we wait until it is first needed, for performance reasons.
Object	getNextElement() This returns the element immediately after the last selected element in this tree level Often needed for enablement decisions for move down actions.
SystemOpenExplorerPerspectiveAction	getOpenToPerspectiveAction() Get the common "Open to->" action for opening a new Remote System Explorer view, scoped to the currently selected object.
Object	getPreviousElement() This returns the element immediately before the first selected element in this tree level.
PropertyDialogAction	getPropertyDialogAction() Rather than pre-defining this common action we wait until it is first needed, for performance reasons.
protected Object[]	getRawChildren(Widget w)
protected Object	getReferencedObject(Object inputObj)
IAction	getRefreshAction() Return the refresh action
protected ISystemRemoteElementAdapter	getRemoteAdapter(Object o) Returns the implementation of ISystemRemoteElement for the given object.
protected ISystemRemoteElementAdapter	getRemoteData(Item item, Object rawData)
SystemRemotePropertiesAction	getRemotePropertyDialogAction() Rather than pre-defining this common action we wait until it is first needed, for performance reasons.
protected String	getRemoteResourceAbsoluteName(Object remoteResource) Turn a given remote object reference into a fully qualified absolute name
protected Vector	getRemoteSelection() Turn selection into an array of remote object names
IAction	getRenameAction() Rather than pre-defined this common action we wait until it is first needed, for performance reasons.
Object	getRootParent() This is called to walk the tree back up to the roots and return the visible root node for the first selected object.
IAction	getSelectAllAction() Return the select All action
IHost	getSelectedConnection() Return the connection of the selected object, whatever it is.
Object	getSelectedParent() This is called to accurately get the parent object for the current selection for this viewer.
TreeItem	getSelectedParentItem() Return the TreeItem of the parent of the selected node.
protected Item[]	getSelection(Control widget) We override getSelection(Control) so that a list of items under the same parent always gets returned in the order in which they appear in the tree view.
protected SystemRemoteElementResourceSet	getSetFor(ISubSystem subSystem, ISystemViewElementAdapter adapter)
Shell	getShell() Convenience method for returning the shell of this viewer.
SystemShowInMonitorAction	getShowInMonitorAction()
SystemShowInTableAction	getShowInTableAction()
protected ISubSystem	getSubSystem(ISystemRemoteChangeEvent event, Object remoteResource, Object remoteParent) Deduce the subsystem from the event or remote object
SystemViewPart	getSystemViewPart() Get the SystemViewPart that encapsulates us.
protected int	getTreeItemPosition(Item childItem, Item[] children) Get the position of a tree item within its parent
Item	getViewerItem() Returns the tree item of the first selected object.
protected IWorkbenchPart	getWorkbenchPart() Get the workbench part containing this view.
protected IWorkbenchWindow	getWorkbenchWindow() Get the workbench window containing this view part.
void	handleDispose(DisposeEvent event)
protected void	handleDoubleClick(DoubleClickEvent event) Handles double clicks in viewer.
protected void	handleTreeCollapse(TreeEvent event)
protected void	handleTreeExpand(TreeEvent event)
protected boolean	hasAncestorRelationSelection() Determines whether the view has an ancestor relation selection so that actions can be enable/disabled appropriately.
protected boolean	hasSelectedAncestor(TreeItem[] items)
protected void	init()
protected void	initDragAndDrop() Initialize drag and drop support for this view.
protected void	initRefreshKey() Create the KeyListener for doing the refresh on the viewer.
protected Item	internalFindFirstRemoteItemReference(String searchString, Object elementObject, ISubSystem subsystem) Recursively tries to find the first occurrence of a given remote object, starting at the tree root.
protected Widget	internalFindReferencedItem(Widget parent, Object element, int searchLimit) Recursively tries to find a reference to the given referenced item
protected Widget	internalFindRelativeItem(Widget parent, Object element, int searchLimit) Recursively tries to find an item starting at the given item.
protected boolean	isAncestorOf(TreeItem container, TreeItem[] items)
protected boolean	isSelected(Object element) Helper method to determine if a given object is currently selected.
protected boolean	isSelected(Object[] elementArray) Helper method to determine if any of a given array of objects is currently selected Does not consider if a child node of the given object is currently selected.
protected boolean	isSelected(Object[] elementArray, IStructuredSelection selection) Helper method to determine if any of a given array of objects is in given selection Does not consider if a child node of the given object is currently selected.
protected boolean	isSelected(Object element, IStructuredSelection selection) Helper method to determine if a given object is in given selection Does not consider if a child node of the given object is currently selected.
boolean	isSelectedOrChildSelected(Object parentElement) Helper method to determine if a given object is currently selected.
protected boolean	isSelectedOrChildSelected(Object[] parentElements) Helper method to determine if a given object is currently selected.
protected boolean	isSelectionRemote()
protected boolean	isTreeItemSelected(Widget w) Helper method to determine if a given tree item is currently selected.
boolean	isTreeItemSelectedOrChildSelected(Widget w) Override that takes a widget.
protected boolean	itemsShareParent(Widget parentItem, Item[] items)
protected void	logDebugMsg(String msg)
protected void	logMyDebugMessage(String prefix, String msg)
void	menuAboutToShow(IMenuManager menu) Called when the context menu is about to open.
protected void	menuAdd(MenuManager menu, IAction action) protected helper method to add an Action to a given menu.
protected void	moveReferencedTreeItems(Widget parentItem, Object[] masterSrc, int delta) Move existing items a given number of positions within the same node.
protected void	moveTreeItem(Widget parentItem, Item item, Object src, int newPosition) Move one tree item to a new location
protected void	moveTreeItems(Widget parentItem, Object[] src, int delta) Move existing items a given number of positions within the same node.
protected void	ourInternalRefresh(Widget widget, Object element, boolean doStruct, boolean forceRemote, boolean doTimings) Refreshes the tree starting at the given widget.
protected String	printTreeItem(Item item) Handy debug method to print a tree item
protected Vector	recursiveFindAllRemoteItemFilterReferences(Item parent, String elementName, ISubSystem subsystem, Vector occurrences) Recursively tries to find all filters which are affected by a given remote object, such that we can subsequently refresh that filter after a remote resource change.
protected Vector	recursiveFindAllRemoteItemReferences(Item parent, String elementName, Object elementObject, ISubSystem subsystem, Vector occurrences) Recursively tries to find all references to a remote object.
protected Item	recursiveFindFirstRemoteItemReference(Item parent, String elementName, Object elementObject, ISubSystem subsystem) Recursively tries to find the first references to a remote object.
protected Widget	recursiveInternalFindReferencedItem(Widget parent, Object element, int searchLimit) Recursively tries to find a reference the given filtercontainer Limits search depth to when we find an item that is not a connection, subsystem, filter pool, filter or filter string.
protected Widget	recursiveInternalFindRelativeItem(Widget parent, Object element, int searchLimit) Recursively tries to find an item starting at the given item.
void	refreshAll() Refresh the whole tree.
protected boolean	refreshRemoteObject(Object remoteObject, Object toSelect, boolean originatedHere) Refresh contents of remote container.
protected void	refreshTreeItem(TreeItem item) Refresh the given tree item node
protected Item	removeFirstItem(Item[] items, Item[] children)
protected void	renameRemoteObject(Object renameObject, String oldElementName, ISubSystem subsystem) Rename a remote object.
ISystemFilterReference	revealAndExpand(ISubSystem parentSubSystem, ISystemFilter filter) Expand a given filter, given a subsystem that contains a reference to the filter's pool.
boolean	sameParent() This is called to ensure all elements in a multiple-selection have the same parent in the tree viewer.
protected void	scanSelections(String whereFrom) -------------------------------------------------------------------------------- For many actions we have to walk the selection list and examine each selected object to decide if a given common action is supported or not.
protected boolean	searchToRoot(TreeItem selectedItem, TreeItem searchItem)
void	select(Object element, boolean expand) Called to select an object within the tree, and optionally expand it
void	selectionChanged(SelectionChangedEvent event) Handles selection changed in viewer.
protected boolean	selectionHasAncestryRelationship()
protected boolean	selectRemoteObjects(Object src, ISubSystem subsystem, Item parentItem) Select a remote object or objects given the parent remote object (can be null) and subsystem (can be null) and parent TreeItem to start the search at (can be null)
boolean	selectRemoteObjects(Object src, ISubSystem subsystem, Object parentObject) Select a remote object or objects given the parent remote object (can be null) and subsystem (can be null)
void	setEnabled(boolean enabled) Disable/Enable the viewer.
void	setExpandToFilterTable(Hashtable ht) To support restoring state we need to write out to disk out current table that maps tree items to their current expand-to filter.
void	setInputProvider(ISystemViewInputProvider inputProvider) Set the input provider.
void	setLabelAndContentProvider(SystemViewLabelAndContentProvider lcProvider) Sets the label and content provider for the system view.
void	setShowActions(boolean show) Turn off right-click actions
boolean	showDelete() Required method from ISystemDeleteTarget.
protected boolean	showGenericShowInTableAction() Decides whether to even show the generic "show in table" menu item.
protected boolean	showOpenViewActions() Decides whether to even show the "open in new perspective" menu item.
protected boolean	showRefresh() Decides whether to even show the refresh menu item.
boolean	showRename() Required method from ISystemRenameTarget.
protected void	smartRefresh(Object element, boolean forceRemote) Do an intelligent refresh of the given element.
protected void	smartRefresh(TreeItem[] itemsToRefresh) Do an intelligent refresh of an expanded item.
protected void	smartRefresh(TreeItem[] itemsToRefresh, ArrayList expandedChildren, boolean forceRemote)
protected Item[]	sortSelection(Widget parentItem, Item[] oldResult)
void	systemRemoteResourceChanged(ISystemRemoteChangeEvent event) This is the method in your class that will be called when a remote resource changes.
void	systemResourceChanged(ISystemResourceChangeEvent event) Called when something changes in the model
void	treeCollapsed(TreeExpansionEvent event) Called after tree item collapsed.
void	treeExpanded(TreeExpansionEvent event) Called after tree item expanded.
void	updatePropertySheet() Called when a property is updated and we need to inform the Property Sheet viewer.
protected void	updateRemoteObjectProperties(Object remoteObject) Update properties of remote object.
protected boolean	usingElementMap()

Methods inherited from class org.eclipse.jface.viewers.TreeViewer

addTreeListener, assertContentProviderType, buildLabel, cancelEditing, createChildren, doUpdateItem, editElement, getCellEditors, getCellModifier, getChild, getChildren, getColumnProperties, getControl, getExpanded, getItem, getItemCount, getItemCount, getItems, getLabelProvider, getParentElement, getParentItem, getRawChildren, getTree, hookControl, internalAdd, internalRefreshStruct, isCellEditorActive, isExpandable, isSameSelection, mapElement, newItem, removeAll, replace, setCellEditors, setCellModifier, setChildCount, setColumnProperties, setExpanded, setLabelProvider, setSelection, showItem

Methods inherited from class org.eclipse.jface.viewers.AbstractTreeViewer

add, addSelectionListener, addTreeListener, associate, collapseAll, collapseToLevel, createTreeItem, disassociate, doFindInputItem, doUpdateItem, expandAll, expandToLevel, expandToLevel, fireTreeCollapsed, fireTreeExpanded, getAutoExpandLevel, getExpandedElements, getExpandedState, getExpandedTreePaths, getFilteredChildren, getNextItem, getPreviousItem, getSelection, getSelectionFromWidget, getSortedChildren, getTreePathFromItem, getVisibleExpandedElements, handleDoubleSelect, indexForElement, inputChanged, insert, internalCollapseToLevel, internalExpand, internalExpandToLevel, internalGetWidgetToSelect, internalRefresh, internalRefresh, internalRefresh, internalRemove, internalRemove, labelProviderChanged, remove, remove, remove, removeTreeListener, reveal, scrollDown, scrollUp, setAutoExpandLevel, setContentProvider, setExpandedElements, setExpandedState, setExpandedTreePaths, setSelectionToWidget, setSelectionToWidget, updateChildren, updatePlus

Methods inherited from class org.eclipse.jface.viewers.StructuredViewer

addDoubleClickListener, addDragSupport, addDropSupport, addFilter, addOpenListener, addPostSelectionChangedListener, assertElementsNotNull, equals, filter, findItem, findItems, fireDoubleClick, fireOpen, firePostSelectionChanged, getColorAndFontCollector, getComparator, getComparer, getFilters, getRoot, getSorter, handleInvalidSelection, handleLabelProviderChanged, handleOpen, handlePostSelect, handleSelect, hasFilters, internalUpdate, needsRefilter, preservingSelection, refresh, refresh, refresh, refresh, refreshItem, removeDoubleClickListener, removeFilter, removeOpenListener, removePostSelectionChangedListener, resetFilters, setComparator, setComparer, setInput, setSelection, setSorter, setUseHashlookup, testFindItem, testFindItems, unmapAllElements, unmapElement, unmapElement, update, update, updateItem, updateSelection

Methods inherited from class org.eclipse.jface.viewers.ContentViewer

getContentProvider, getInput

Methods inherited from class org.eclipse.jface.viewers.Viewer

addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, setData, setSelection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider

addSelectionChangedListener, getSelection, removeSelectionChangedListener, setSelection

Field Detail

shell

protected Shell shell

inputProvider

protected ISystemViewInputProvider inputProvider

previousInputProvider

protected ISystemViewInputProvider previousInputProvider

previousInput

protected Object previousInput

previousInputConnection

protected IHost previousInputConnection

newConnectionAction

protected SystemNewConnectionAction newConnectionAction

refreshAction

protected SystemRefreshAction refreshAction

propertyDialogAction

protected PropertyDialogAction propertyDialogAction

remotePropertyDialogAction

protected SystemRemotePropertiesAction remotePropertyDialogAction

collapseAction

protected SystemCollapseAction collapseAction

expandAction

protected SystemExpandAction expandAction

openToPerspectiveAction

protected SystemOpenExplorerPerspectiveAction openToPerspectiveAction

showInTableAction

protected SystemShowInTableAction showInTableAction

showInMonitorAction

protected SystemShowInMonitorAction showInMonitorAction

goIntoAction

protected GoIntoAction goIntoAction

gotoActions

protected SystemCascadingGoToAction gotoActions

deleteAction

protected SystemCommonDeleteAction deleteAction

renameAction

protected SystemCommonRenameAction renameAction

selectAllAction

protected SystemCommonSelectAllAction selectAllAction

selectionShowRefreshAction

protected boolean selectionShowRefreshAction

selectionShowOpenViewActions

protected boolean selectionShowOpenViewActions

selectionShowGenericShowInTableAction

protected boolean selectionShowGenericShowInTableAction

selectionShowDeleteAction

protected boolean selectionShowDeleteAction

selectionShowRenameAction

protected boolean selectionShowRenameAction

selectionEnableDeleteAction

protected boolean selectionEnableDeleteAction

selectionEnableRenameAction

protected boolean selectionEnableRenameAction

selectionIsRemoteObject

protected boolean selectionIsRemoteObject

selectionHasAncestorRelation

protected boolean selectionHasAncestorRelation

selectionFlagsUpdated

protected boolean selectionFlagsUpdated

menuMgr

protected MenuManager menuMgr

showActions

protected boolean showActions

hardCodedConnectionSelected

protected boolean hardCodedConnectionSelected

mixedSelection

protected boolean mixedSelection

specialMode

protected boolean specialMode

menuListenerAdded

protected boolean menuListenerAdded

fromSystemViewPart

protected boolean fromSystemViewPart

areAnyRemote

protected boolean areAnyRemote

enabledMode

protected boolean enabledMode

previousItem

protected Widget previousItem

searchDepth

protected int searchDepth

busyCursor

protected Cursor busyCursor

inputTreeItem

protected TreeItem inputTreeItem

SEARCH_INFINITE

protected static final int SEARCH_INFINITE

See Also:

Constant Field Values

debug

public boolean debug

debugRemote

public boolean debugRemote

debugProperties

public boolean debugProperties

doTimings

public boolean doTimings

elapsedTime

public SystemElapsedTimer elapsedTime

expandToFiltersByObject

protected Hashtable expandToFiltersByObject

expandToFiltersByTreePath

protected Hashtable expandToFiltersByTreePath

messageLine

protected ISystemMessageLine messageLine

LEFT_BUTTON

protected static final int LEFT_BUTTON

See Also:

Constant Field Values

mouseButtonPressed

protected int mouseButtonPressed

expandingTreeOnly

protected boolean expandingTreeOnly

initViewerFilters

protected ViewerFilter[] initViewerFilters

_setList

protected List _setList

Constructor Detail

SystemView

public SystemView(Shell shell,
                  Composite parent,
                  ISystemViewInputProvider inputProvider,
                  ISystemMessageLine msgLine)

Constructor

Parameters:

shell - The shell hosting this tree viewer widget

parent - The composite widget into which to place this widget

inputProvider - The input object which will supply the initial root objects in the tree. Can be null initially, but be sure to call #setInputProvider(ISystemViewInputProvider) later.

msgLine - Where to display messages and tooltip text

SystemView

public SystemView(Shell shell,
                  Composite parent,
                  int style,
                  ISystemViewInputProvider inputProvider,
                  ISystemMessageLine msgLine)

Constructor to use when you want to specify styles for the tree widget

Parameters:

shell - The shell hosting this tree viewer widget

parent - The composite widget into which to place this widget

style - The style to give the tree widget

inputProvider - The input object which will supply the initial root objects in the tree. Can be null initially, but be sure to call #setInputProvider(ISystemViewInputProvider) later.

msgLine - Where to display messages and tooltip text

SystemView

public SystemView(Shell shell,
                  Composite parent,
                  int style,
                  ISystemViewInputProvider inputProvider,
                  ISystemMessageLine msgLine,
                  ViewerFilter[] initViewerFilters)

Constructor to use when you want to specify styles for the tree widget

Parameters:

shell - The shell hosting this tree viewer widget

parent - The composite widget into which to place this widget

style - The style to give the tree widget

inputProvider - The input object which will supply the initial root objects in the tree. Can be null initially, but be sure to call #setInputProvider(ISystemViewInputProvider) later.

msgLine - Where to display messages and tooltip text

initViewerFilters - the initial viewer filters to apply.

SystemView

public SystemView(Shell shell,
                  Tree tree,
                  ISystemViewInputProvider inputProvider,
                  ISystemMessageLine msgLine)

Constructor to use when you create your own tree widget.

Parameters:

shell - The shell hosting this tree viewer widget

tree - The Tree widget you created.

inputProvider - The input object which will supply the initial root objects in the tree. Can be null initially, but be sure to call #setInputProvider(ISystemViewInputProvider) later.

msgLine - Where to display messages and tooltip text

Method Detail

setInputProvider

public void setInputProvider(ISystemViewInputProvider inputProvider)

Set the input provider. Sometimes this is delayed, or can change.

Parameters:

inputProvider - the input provider for this view.

getSystemViewPart

public SystemViewPart getSystemViewPart()

Get the SystemViewPart that encapsulates us. Will be null unless fromSystemViewPart is true.

getWorkbenchWindow

protected IWorkbenchWindow getWorkbenchWindow()

Get the workbench window containing this view part. Will only be non-null for the explorer view part, not when used within, say, a dialog

getWorkbenchPart

protected IWorkbenchPart getWorkbenchPart()

Get the workbench part containing this view. Will only be non-null for the explorer view part, not when used within, say, a dialog

setEnabled

public void setEnabled(boolean enabled)

Disable/Enable the viewer. We do this by blocking keystrokes without visually greying out

setLabelAndContentProvider

public void setLabelAndContentProvider(SystemViewLabelAndContentProvider lcProvider)

Sets the label and content provider for the system view. This can be called externally if a custom RSE label and content provider is desired

Parameters:

lcProvider - the provider

init

protected void init()

initRefreshKey

protected void initRefreshKey()

Create the KeyListener for doing the refresh on the viewer.

handleDoubleClick

protected void handleDoubleClick(DoubleClickEvent event)

Handles double clicks in viewer. Opens editor if file double-clicked.

collapseSelected

public void collapseSelected()

Handles a collapse-selected request

expandSelected

public void expandSelected()

Handles an expand-selected request

displayMessage

public void displayMessage(String msg)

Display a message/status on the message/status line

clearMessage

public void clearMessage()

Clear message/status shown on the message/status line

setShowActions

public void setShowActions(boolean show)

Turn off right-click actions

getInputProvider

public ISystemViewInputProvider getInputProvider()

Return the input provider

getContextMenu

public Menu getContextMenu()

Return the popup menu for the tree

getContextMenuManager

public MenuManager getContextMenuManager()

Return the popup menu for the tree

getNewConnectionAction

public IAction getNewConnectionAction()

Rather than pre-defining this common action we wait until it is first needed, for performance reasons.

getRefreshAction

public IAction getRefreshAction()

Return the refresh action

getCollapseAction

public IAction getCollapseAction()

Returns:

the collapse action. Lazily creates it.

getExpandAction

public IAction getExpandAction()

Returns:

the expand action. Lazily creates it.

getPropertyDialogAction

public PropertyDialogAction getPropertyDialogAction()

Rather than pre-defining this common action we wait until it is first needed, for performance reasons.

getRemotePropertyDialogAction

public SystemRemotePropertiesAction getRemotePropertyDialogAction()

Rather than pre-defining this common action we wait until it is first needed, for performance reasons.

getSelectAllAction

public IAction getSelectAllAction()

Return the select All action

getRenameAction

public IAction getRenameAction()

Rather than pre-defined this common action we wait until it is first needed, for performance reasons.

getDeleteAction

public IAction getDeleteAction()

Rather than pre-defined this common action we wait until it is first needed, for performance reasons.

getOpenToPerspectiveAction

public SystemOpenExplorerPerspectiveAction getOpenToPerspectiveAction()

Get the common "Open to->" action for opening a new Remote System Explorer view, scoped to the currently selected object.

getShowInTableAction

public SystemShowInTableAction getShowInTableAction()

getShowInMonitorAction

public SystemShowInMonitorAction getShowInMonitorAction()

getGoIntoAction

public GoIntoAction getGoIntoAction()

Get the common "Go Into" action for drilling down in the Remote System Explorer view, scoped to the currently selected object.

getGoToActions

public SystemCascadingGoToAction getGoToActions()

Get the common "Go To->" cascading menu action for navigating the frame list.

collapseNode

public void collapseNode(Object element,
                         boolean forceRefresh)

Helper method to collapse a node in the tree. Called when a currently expanded subsystem is disconnected.

Parameters:

forceRefresh - true if children should be deleted from memory so re-expand forces refresh.

fillContextMenu

public void fillContextMenu(IMenuManager menu)

This is method is called to populate the popup menu

addObjectActions

protected void addObjectActions(SystemMenuManager menu)

Contributes popup menu actions and submenus registered for the object type(s) in the current selection. Patterned after addObjectActions in PopupMenuExtender class supplied by Eclipse.

menuAboutToShow

public void menuAboutToShow(IMenuManager menu)

Called when the context menu is about to open. Calls fillContextMenu(IMenuManager)

Specified by:

menuAboutToShow in interface IMenuListener

createStandardGroups

public static IMenuManager createStandardGroups(IMenuManager menu)

Creates the Systems plugin standard groups in a context menu.

menuAdd

protected void menuAdd(MenuManager menu,
                       IAction action)

protected helper method to add an Action to a given menu. To give the action the opportunity to grey out, we call selectionChanged, but only if the action implements ISelectionChangedListener

hasAncestorRelationSelection

protected boolean hasAncestorRelationSelection()

Determines whether the view has an ancestor relation selection so that actions can be enable/disabled appropriately. For example, delete needs to be disabled when a parent and it's child are both selected.

Returns:

true if the selection has one or more ancestor relations

selectionChanged

public void selectionChanged(SelectionChangedEvent event)

Handles selection changed in viewer. Updates global actions. Links to editor (if option enabled)

Specified by:

selectionChanged in interface ISelectionChangedListener

logMyDebugMessage

protected void logMyDebugMessage(String prefix,
                                 String msg)

getShell

public Shell getShell()

Convenience method for returning the shell of this viewer.

Specified by:

getShell in interface ISystemResourceChangeListener

isSelected

protected boolean isSelected(Object element)

Helper method to determine if a given object is currently selected. Does not consider if a child node of the given object is currently selected.

isTreeItemSelected

protected boolean isTreeItemSelected(Widget w)

Helper method to determine if a given tree item is currently selected. Does not consider if a child node of the given object is currently selected.

isSelected

protected boolean isSelected(Object[] elementArray)

Helper method to determine if any of a given array of objects is currently selected Does not consider if a child node of the given object is currently selected.

isSelected

protected boolean isSelected(Object element,
                             IStructuredSelection selection)

Helper method to determine if a given object is in given selection Does not consider if a child node of the given object is currently selected.

isSelected

protected boolean isSelected(Object[] elementArray,
                             IStructuredSelection selection)

Helper method to determine if any of a given array of objects is in given selection Does not consider if a child node of the given object is currently selected.

isSelectedOrChildSelected

protected boolean isSelectedOrChildSelected(Object[] parentElements)

Helper method to determine if a given object is currently selected. Does consider if a child node of the given object is currently selected.

searchToRoot

protected boolean searchToRoot(TreeItem selectedItem,
                               TreeItem searchItem)

treeCollapsed

public void treeCollapsed(TreeExpansionEvent event)

Called after tree item collapsed. Updates the children of the tree item being collapsed by removing the widgets associated with any transient message objects that were in the tree.

Specified by:

treeCollapsed in interface ITreeViewerListener

Parameters:

event - the event that caused the collapse. The event data will include the tree element being collapsed.

treeExpanded

public void treeExpanded(TreeExpansionEvent event)

Called after tree item expanded. We need this hook to potentially undo user expand request.

Specified by:

treeExpanded in interface ITreeViewerListener

Parameters:

event - the SWT TreeExpansionEvent that caused the expansion.

handleTreeCollapse

protected void handleTreeCollapse(TreeEvent event)

handleTreeExpand

protected void handleTreeExpand(TreeEvent event)

clearSelection

protected void clearSelection()

Clear current selection. Ignore widget disposed message.

getAdapter

protected ISystemViewElementAdapter getAdapter(Object o)

Returns the implementation of ISystemViewElement for the given object. Returns null if the adapter is not defined or the object is not adaptable.

getRemoteAdapter

protected ISystemRemoteElementAdapter getRemoteAdapter(Object o)

Returns the implementation of ISystemRemoteElement for the given object. Returns null if this object does not adaptable to this.

handleDispose

public void handleDispose(DisposeEvent event)

getSelectedConnection

public IHost getSelectedConnection()

Return the connection of the selected object, whatever it is.

getSelection

protected Item[] getSelection(Control widget)

We override getSelection(Control) so that a list of items under the same parent always gets returned in the order in which they appear in the tree view. Otherwise, after a "move up" or "move down", the order of selection can come back wrong.

itemsShareParent

protected boolean itemsShareParent(Widget parentItem,
                                   Item[] items)

sortSelection

protected Item[] sortSelection(Widget parentItem,
                               Item[] oldResult)

removeFirstItem

protected Item removeFirstItem(Item[] items,
                               Item[] children)

moveTreeItem

protected void moveTreeItem(Widget parentItem,
                            Item item,
                            Object src,
                            int newPosition)

Move one tree item to a new location

moveTreeItems

protected void moveTreeItems(Widget parentItem,
                             Object[] src,
                             int delta)

Move existing items a given number of positions within the same node. If the delta is negative, they are all moved up by the given amount. If positive, they are all moved down by the given amount.

getTreeItemPosition

protected int getTreeItemPosition(Item childItem,
                                  Item[] children)

Get the position of a tree item within its parent

revealAndExpand

public ISystemFilterReference revealAndExpand(ISubSystem parentSubSystem,
                                              ISystemFilter filter)

Expand a given filter, given a subsystem that contains a reference to the filter's pool. This will expand down to the filter if needed

Parameters:

parentSubSystem - - the subsystem containing a reference to the filter's parent pool

filter - - the filter to find, reveal, and expand within the subsystem context

Returns:

the filter reference to the filter if found and expanded. This is a unique binary address within the object's in this tree, so can be used in the viewer methods to affect this particular node.

systemResourceChanged

public void systemResourceChanged(ISystemResourceChangeEvent event)

Called when something changes in the model

Specified by:

systemResourceChanged in interface ISystemResourceChangeListener

See Also:

ISystemResourceChangeEvent

systemRemoteResourceChanged

public void systemRemoteResourceChanged(ISystemRemoteChangeEvent event)

This is the method in your class that will be called when a remote resource changes. You will be called after the resource is changed.

Specified by:

systemRemoteResourceChanged in interface ISystemRemoteChangeListener

See Also:

ISystemRemoteChangeEvent

getRemoteSelection

protected Vector getRemoteSelection()

Turn selection into an array of remote object names

getRemoteResourceAbsoluteName

protected String getRemoteResourceAbsoluteName(Object remoteResource)

Turn a given remote object reference into a fully qualified absolute name

getSubSystem

protected ISubSystem getSubSystem(ISystemRemoteChangeEvent event,
                                  Object remoteResource,
                                  Object remoteParent)

Deduce the subsystem from the event or remote object

close

protected void close()

Close us!

affectsInput

protected boolean affectsInput(Object[] elements)

Test if the given input is our view's input object. This is designed to only consider instances of ourself in non-primary perspectives.

affectsInput

protected boolean affectsInput(Object element)

Test if the given input is our view's input object. This is designed to only consider instances of ourself in non-primary perspectives.

getReferencedObject

protected Object getReferencedObject(Object inputObj)

getElementParent

protected Object getElementParent(Object inputObj)

getInputConnection

protected IHost getInputConnection(Object inputObj)

printTreeItem

protected String printTreeItem(Item item)

Handy debug method to print a tree item

deleteRemoteObject

protected void deleteRemoteObject(Object deleteObject,
                                  ISubSystem subsystem)

Delete all occurrences of a given remote object

renameRemoteObject

protected void renameRemoteObject(Object renameObject,
                                  String oldElementName,
                                  ISubSystem subsystem)

Rename a remote object. Renames all references to it currently displayed in this tree.

updateRemoteObjectProperties

protected void updateRemoteObjectProperties(Object remoteObject)

Update properties of remote object. Update all references to this object

refreshRemoteObject

protected boolean refreshRemoteObject(Object remoteObject,
                                      Object toSelect,
                                      boolean originatedHere)

Refresh contents of remote container. Refreshes all references to this container including filters that display the contents of this container.

Parameters:

remoteObject - - either an actual remote object, or the absolute name of a remote object

toSelect - - the child object to select after refreshing the given object. This will force the object to be expanded, and then select this object which can be a remote object or absolute name of a remote object. To simply force an expand of the remote object, without bothering to select a child, pass an instance of SystemViewDummyObject.

Returns:

true if a refresh done, false if given a non-remote object.

getFirstRemoteObject

protected Object getFirstRemoteObject(Vector matches)

Given the result of findAllRemoteItemReferences, scan for first non-filter object

ourInternalRefresh

protected void ourInternalRefresh(Widget widget,
                                  Object element,
                                  boolean doStruct,
                                  boolean forceRemote,
                                  boolean doTimings)

Refreshes the tree starting at the given widget.

Parameters:

widget - the widget

element - the element

doStruct - true if structural changes are to be picked up, and false if only label provider changes are of interest

isSelectionRemote

protected boolean isSelectionRemote()

doOurInternalRefresh

protected void doOurInternalRefresh(Widget widget,
                                    Object element,
                                    boolean doStruct,
                                    boolean doTimings,
                                    boolean firstCall)

getRawChildren

protected Object[] getRawChildren(Widget w)

getFirstSelectionName

protected String getFirstSelectionName(ISelection s)

expandRemoteObject

public Item expandRemoteObject(Object remoteObject,
                               ISubSystem subsystem,
                               Object parentObject)

Expand a remote object within the tree. Must be given its parent element within the tree, in order to uniquely find it. If not given this, we expand the first occurrence we find!

Parameters:

remoteObject - - either a remote object or a remote object absolute name

subsystem - - the subsystem that owns the remote objects, to optimize searches.

parentObject - - the parent that owns the remote objects, to optimize searches. Can be an object or the absolute name of a remote object.

Returns:

the tree item of the remote object if found and expanded, else null

selectRemoteObjects

public boolean selectRemoteObjects(Object src,
                                   ISubSystem subsystem,
                                   Object parentObject)

Select a remote object or objects given the parent remote object (can be null) and subsystem (can be null)

Parameters:

src - - either a remote object, a remote object absolute name, or a vector of remote objects or remote object absolute names

subsystem - - the subsystem that owns the remote objects, to optimize searches.

parentObject - - the parent that owns the remote objects, to optimize searches.

Returns:

true if found and selected

selectRemoteObjects

protected boolean selectRemoteObjects(Object src,
                                      ISubSystem subsystem,
                                      Item parentItem)

Select a remote object or objects given the parent remote object (can be null) and subsystem (can be null) and parent TreeItem to start the search at (can be null)

Parameters:

src - - either a remote object, a remote object absolute name, or a vector of remote objects or remote object absolute names

subsystem - - the subsystem that owns the remote objects, to optimize searches.

parentItem - - the parent at which to start the search to find the remote objects. Else, starts at the roots.

Returns:

true if found and selected

refreshAll

public void refreshAll()

Refresh the whole tree. We have special code to reselect remote objects after the refresh

smartRefresh

protected void smartRefresh(TreeItem[] itemsToRefresh)

Do an intelligent refresh of an expanded item. The inherited algorithm for refresh is stupid, in that it reexpands children based on their original ordinal position which can change after a refresh, resulting in the wrong children being expanded. Currently this only truly comes to light for remote objects, where refresh really can change the resulting list and hence each child's ordinal position. So, to be safe we only override the inherited algorithm if any nested child is a remote object

smartRefresh

protected void smartRefresh(TreeItem[] itemsToRefresh,
                            ArrayList expandedChildren,
                            boolean forceRemote)

smartRefresh

protected void smartRefresh(Object element,
                            boolean forceRemote)

Do an intelligent refresh of the given element. Can be null for full refresh

gatherExpandedChildren

protected void gatherExpandedChildren(TreeItem parentItem,
                                      TreeItem startingItem,
                                      ArrayList listToPopulate)

Gather up all expanded children of the given tree item into a list that can be used later to reexpand.

Parameters:

parentItem - The root parent which will not be refreshed itself (only its kids) and hence will remain valid after refresh. In a full refresh this will be null.

startingItem - The starting item for this search. Usually same as parentItem, but changes via recursion

listToPopulate - An array list that will be populated with instances of our inner class ExpandedItem

getItemIndex

protected int getItemIndex(Widget parent,
                           Object element)

Get index of item given its data element

findAndUpdateFilter

protected void findAndUpdateFilter(ISystemResourceChangeEvent event,
                                   int type)

We don't show actual filters, only filter references that are unique generated for each subtree of each subsystem. Yet, each event is relative to the filter, not our special filter references. Hence, all this code!!

Special case handling for updates to filters which affect the filter but not the filter parent: 1. Existing filter renamed (RENAME) 2. Existing filter's filter strings changed (CHANGE)

Assumption: 1. event.getGrandParent() == subsystem (one event fired per affected subsystem) 2. event.getSource() == filter or filter string (not the reference, the real filter or string) 3. event.getParent() == parent of filter or filter string. One of: a. filterPool reference or filter reference (nested) b. filterPool for non-nested filters when showing filter pools c. subsystem for non-nested filters when not showing filter pools d. filter for nested filters

Our job here: 1. Determine if we are even showing the given subsystem 2. Find the reference to the updated filter in that subsystem's subtree 3. Ask that parent to either update its name or collapse and refresh its children 4. Forget selecting something ... the original item remains selected!

findAndUpdateFilterString

protected void findAndUpdateFilterString(ISystemResourceChangeEvent event,
                                         int type)

findAndUpdateFilterParent

protected void findAndUpdateFilterParent(ISystemResourceChangeEvent event,
                                         int type)

We don't show actual filters, only filter references that are unique generated for each subtree of each subsystem. Yet, each event is relative to the filter, not our special filter references. Hence, all this code!!

Special case handling for updates to filters which affect the parent of the filter, such that the parent's children must be re-generated: 1. New filter created (ADD) 2. Existing filter deleted (DELETE) 3. Existing filters reordered (MOVE)

Assumption: 1. event.getGrandParent() == subsystem (one event fired per affected subsystem) 2. event.getSource() == filter (not the reference, the real filter) 3. event.getParent() == parent of filter. One of: a. filterPool reference or filter reference (nested) b. filterPool for non-nested filters when showing filter pools c. subsystem for non-nested filters when not showing filter pools d. filter for nested filters

Our job here: 1. Determine if we are even showing the given subsystem 2. Find the parent to the given filter: filterPool or subsystem 3. Ask that parent to refresh its children (causes re-gen of filter references) 4. Select something: QUESTION: is this subsystem the origin of this action?? a. For ADD, select the newly created filter reference for the new filter ANSWER: IF PARENT OF NEW FILTER IS WITHIN THIS SUBSYSTEM, AND WAS SELECTED PREVIOUSLY b. For DELETE, select the parent of the filter? ANSWER: IF DELETED FILTER IS WITHING THIS SUBSYSTEM AND WAS SELECTED PREVIOUSLY c. For MOVE, select the moved filters ANSWER: IF MOVED FILTERS ARE WITHIN THIS SUBSYSTEM, AND WERE SELECTED PREVIOUSLY

moveReferencedTreeItems

protected void moveReferencedTreeItems(Widget parentItem,
                                       Object[] masterSrc,
                                       int delta)

Move existing items a given number of positions within the same node. If the delta is negative, they are all moved up by the given amount. If positive, they are all moved down by the given amount.

internalFindReferencedItem

protected Widget internalFindReferencedItem(Widget parent,
                                            Object element,
                                            int searchLimit)

Recursively tries to find a reference to the given referenced item

Parameters:

parent - the parent item at which to start the search.

element - the master element to which we want to find a tree item which references it

searchLimit - how deep to search

recursiveInternalFindReferencedItem

protected Widget recursiveInternalFindReferencedItem(Widget parent,
                                                     Object element,
                                                     int searchLimit)

Recursively tries to find a reference the given filtercontainer Limits search depth to when we find an item that is not a connection, subsystem, filter pool, filter or filter string.

Parameters:

parent - the parent item at which to start the search.

element - the master element to which we want to find a tree item which references it

searchLimit - how deep to search

internalFindRelativeItem

protected Widget internalFindRelativeItem(Widget parent,
                                          Object element,
                                          int searchLimit)

Recursively tries to find an item starting at the given item. (base viewer classes do not offer a relative search!)

Parameters:

parent - the parent item at which to start the search.

element - the element to match on. Matches on "==" versus equals()

recursiveInternalFindRelativeItem

protected Widget recursiveInternalFindRelativeItem(Widget parent,
                                                   Object element,
                                                   int searchLimit)

Recursively tries to find an item starting at the given item. (base viewer classes do not offer a relative search!)

Parameters:

parent - the parent item at which to start the search.

element - the element to match on. Matches on "==" versus equals()

getRemoteData

protected ISystemRemoteElementAdapter getRemoteData(Item item,
                                                    Object rawData)

findFirstRemoteItemReference

public Item findFirstRemoteItemReference(String remoteObjectName,
                                         ISubSystem subsystem,
                                         Item parentItem)

Find the first binary-match or name-match of remote object, given its absolute name.

Parameters:

remoteObjectName - The absolute name of the remote object to find.

subsystem - The subsystem of the remote object to find. Optional.

parentItem - The parent item at which to start the search. Optional.

Returns:

TreeItem hit if found

findFirstRemoteItemReference

public Item findFirstRemoteItemReference(Object remoteObject,
                                         Item parentItem)

Find the first binary-match or name-match of a remote object, given its binary object.

Parameters:

remoteObject - - The remote object to find.

parentItem - - Optionally, the parent item to start the search at

Returns:

TreeItem hit if found

findAllRemoteItemReferences

protected Vector findAllRemoteItemReferences(Object element,
                                             Object elementObject,
                                             Vector matches)

Recursively tries to find a given remote object. Since the object memory object for a remote object is not dependable we call getAbsoluteName() on the adapter to do the comparisons. Note this does not take into account the parent connection or subsystem or filter, hence you must know where to start the search, else you risk finding the wrong one.

Parameters:

element - the remote object to which we want to find a tree item which references it. Can be a string or an object

elementObject - the actual remote element to find, for binary matching, optionally for cases when element is a string

matches - the vector to populate with hits

findAllRemoteItemReferences

protected Vector findAllRemoteItemReferences(String searchString,
                                             Object elementObject,
                                             ISubSystem subsystem,
                                             Vector matches)

Recursively tries to find all occurrences of a given remote object, starting at the tree root. Since the object memory object for a remote object is not dependable we call getAbsoluteName() on the adapter to do the comparisons.

This overload takes a string and a subsystem.

Parameters:

searchString - the absolute name of the remote object to which we want to find a tree item which references it.

elementObject - the actual remote element to find, for binary matching

subsystem - optional subsystem to search within

matches - the vector to populate with hits

internalFindFirstRemoteItemReference

protected Item internalFindFirstRemoteItemReference(String searchString,
                                                    Object elementObject,
                                                    ISubSystem subsystem)

Recursively tries to find the first occurrence of a given remote object, starting at the tree root. Optionally scoped to a specific subsystem. Since the object memory object for a remote object is not dependable we call getAbsoluteName() on the adapter to do the comparisons.

This overload takes a string and a subsystem.

Parameters:

searchString - the absolute name of the remote object to which we want to find a tree item which references it.

elementObject - the actual remote element to find, for binary matching

subsystem - optional subsystem to search within

Returns:

TreeItem hit if found

recursiveFindAllRemoteItemReferences

protected Vector recursiveFindAllRemoteItemReferences(Item parent,
                                                      String elementName,
                                                      Object elementObject,
                                                      ISubSystem subsystem,
                                                      Vector occurrences)

Recursively tries to find all references to a remote object.

Parameters:

parent - the parent item at which to start the search.

elementName - the absolute name of the remote element to find

elementObject - the actual remote element to find, for binary matching

subsystem - optional subsystem to search within

occurrences - the vector to populate with hits

recursiveFindFirstRemoteItemReference

protected Item recursiveFindFirstRemoteItemReference(Item parent,
                                                     String elementName,
                                                     Object elementObject,
                                                     ISubSystem subsystem)

Recursively tries to find the first references to a remote object. This search is restricted to the given subsystem, if given.

Parameters:

parent - the parent item at which to start the search.

elementName - the absolute name of the remote element to find

elementObject - the actual remote element to find, for binary matching

subsystem - optional subsystem to search within

Returns:

TreeItem match if found, null if not found.

findAllRemoteItemFilterReferences

protected Vector findAllRemoteItemFilterReferences(String elementName,
                                                   ISubSystem subsystem,
                                                   Vector matches)

Recursively tries to find all filters affected by a given remote object.

Parameters:

elementName - the absolute name of the remote object to which we want to find a filters which result in it.

subsystem - The subsystem which owns the remote resource. Necessary to scope the search for impacted filters.

matches - the vector to populate with hits. Can be null, in which case a new vector is created.

Returns:

Vector of FilterMatch objects for each affected filter

recursiveFindAllRemoteItemFilterReferences

protected Vector recursiveFindAllRemoteItemFilterReferences(Item parent,
                                                            String elementName,
                                                            ISubSystem subsystem,
                                                            Vector occurrences)

Recursively tries to find all filters which are affected by a given remote object, such that we can subsequently refresh that filter after a remote resource change.

Parameters:

parent - the parent item at which to start the search.

elementName - the absolute name of the remote element that has been created, changed, deleted or renamed.

subsystem - The subsystem which owns the remote resource. Necessary to scope the search for impacted filters.

occurrences - the vector to populate with hits

Returns:

Vector of FilterMatch objects for each affected filter

scanSelections

protected void scanSelections(String whereFrom)

-------------------------------------------------------------------------------- For many actions we have to walk the selection list and examine each selected object to decide if a given common action is supported or not.

Walking this list multiple times while building the popup menu is a performance hit, so we have this common method that does it only once, setting instance variables for all of the decisions we are in interested in. --------------------------------------------------------------------------------

showRefresh

protected boolean showRefresh()

Decides whether to even show the refresh menu item. Assumes scanSelections() has already been called

showOpenViewActions

protected boolean showOpenViewActions()

Decides whether to even show the "open in new perspective" menu item. Assumes scanSelections() has already been called

showGenericShowInTableAction

protected boolean showGenericShowInTableAction()

Decides whether to even show the generic "show in table" menu item. Assumes scanSelections() has already been called

areSelectionsRemote

protected boolean areSelectionsRemote()

Decides whether all the selected objects are remote objects or not Assumes scanSelections() has already been called

showDelete

public boolean showDelete()

Required method from ISystemDeleteTarget. Decides whether to even show the delete menu item. Assumes scanSelections() has already been called

Specified by:

showDelete in interface ISystemDeleteTarget

canDelete

public boolean canDelete()

Required method from ISystemDeleteTarget Decides whether to enable the delete menu item. Assumes scanSelections() has already been called

Specified by:

canDelete in interface ISystemDeleteTarget

doDelete

public boolean doDelete(IProgressMonitor monitor)

Required method from ISystemDeleteTarget

Specified by:

doDelete in interface ISystemDeleteTarget

showRename

public boolean showRename()

Required method from ISystemRenameTarget. Decides whether to even show the rename menu item. Assumes scanSelections() has already been called

Specified by:

showRename in interface ISystemRenameTarget

canRename

public boolean canRename()

Required method from ISystemRenameTarget Decides whether to enable the rename menu item. Assumes scanSelections() has already been called

Specified by:

canRename in interface ISystemRenameTarget

doRename

public boolean doRename(String[] newNames)

Required method from ISystemRenameTarget

Specified by:

doRename in interface ISystemRenameTarget

logDebugMsg

protected void logDebugMsg(String msg)

enableSelectAll

public boolean enableSelectAll(IStructuredSelection selection)

Return true if select all should be enabled for the given object. For a tree view, you should return true if and only if the selected object has children. You can use the passed in selection or ignore it and query your own selection.

Specified by:

enableSelectAll in interface ISystemSelectAllTarget

doSelectAll

public void doSelectAll(IStructuredSelection selection)

When this action is run via Edit->Select All or via Ctrl+A, perform the select all action. For a tree view, this should select all the children of the given selected object. You can use the passed in selected object or ignore it and query the selected object yourself.

Specified by:

doSelectAll in interface ISystemSelectAllTarget

sameParent

public boolean sameParent()

This is called to ensure all elements in a multiple-selection have the same parent in the tree viewer. If they don't we automatically disable all actions.

Designed to be as fast as possible by going directly to the SWT widgets

Specified by:

sameParent in interface ISystemTree

Returns:

true if the elements of the selection in the viewer all have the same parent

selectionHasAncestryRelationship

protected boolean selectionHasAncestryRelationship()

isAncestorOf

protected boolean isAncestorOf(TreeItem container,
                               TreeItem[] items)

hasSelectedAncestor

protected boolean hasSelectedAncestor(TreeItem[] items)

getSelectedParent

public Object getSelectedParent()

This is called to accurately get the parent object for the current selection for this viewer.

The getParent() method in the adapter is very unreliable... adapters can't be sure of the context which can change via filtering and view options.

Specified by:

getSelectedParent in interface ISystemTree

Returns:

the parent of the selection

getSelectedParentItem

public TreeItem getSelectedParentItem()

Return the TreeItem of the parent of the selected node. Or null if a root is selected.

getPreviousElement

public Object getPreviousElement()

This returns the element immediately before the first selected element in this tree level. Often needed for enablement decisions for move up actions.

Specified by:

getPreviousElement in interface ISystemTree

Returns:

the object prior to the selection, null if there is none

getNextElement

public Object getNextElement()

This returns the element immediately after the last selected element in this tree level Often needed for enablement decisions for move down actions.

Specified by:

getNextElement in interface ISystemTree

Returns:

the object after the selection, null if there is none

getRootParent

public Object getRootParent()

This is called to walk the tree back up to the roots and return the visible root node for the first selected object.

Specified by:

getRootParent in interface ISystemTree

Returns:

the root object

getElementNodes

public Object[] getElementNodes(Object element)

This returns an array containing each element in the tree, up to but not including the root. The array is in reverse order, starting at the leaf and going up.

Specified by:

getElementNodes in interface ISystemTree

Parameters:

element - the element from which to begin

Returns:

the array of objects in the path from leaf to root. Excluding the leaf and root.

getElementNodes

public Object[] getElementNodes(TreeItem item)

This returns an array containing each element in the tree, up to but not including the root. The array is in reverse order, starting at the leaf and going up. This flavour is optimized for the case when you have the tree item directly.

getItemNodes

public TreeItem[] getItemNodes(TreeItem item)

This returns an array containing each element in the tree, up to but not including the root. The array is in reverse order, starting at the leaf and going up. This flavour returns a vector of TreeItem objects versus element objects.

isSelectedOrChildSelected

public boolean isSelectedOrChildSelected(Object parentElement)

Helper method to determine if a given object is currently selected. Does consider if a child node of the given object is currently selected.

Specified by:

isSelectedOrChildSelected in interface ISystemTree

Parameters:

parentElement - the element to query

Returns:

true if the element covers any portion of the selection

isTreeItemSelectedOrChildSelected

public boolean isTreeItemSelectedOrChildSelected(Widget w)

Override that takes a widget.

getChildCount

public int getChildCount(Object element)

Return the number of immediate children in the tree, for the given tree node

Specified by:

getChildCount in interface ISystemTree

Parameters:

element - the element in the tree to query

Returns:

the number of immediate children in the tree, for the given tree node

doFindItem

protected Widget doFindItem(Object element)

getFirstSelectedTreeItem

protected TreeItem getFirstSelectedTreeItem()

Return the tree item of the first selected object

refreshTreeItem

protected void refreshTreeItem(TreeItem item)

Refresh the given tree item node

updatePropertySheet

public void updatePropertySheet()

Called when a property is updated and we need to inform the Property Sheet viewer. There is no formal mechanism for this so we simulate a selection changed event as this is the only event the property sheet listens for.

Specified by:

updatePropertySheet in interface ISystemTree

select

public void select(Object element,
                   boolean expand)

Called to select an object within the tree, and optionally expand it

Specified by:

select in interface ISystemTree

Parameters:

element - the element in the tree to select

expand - true if the element is to be expanded

getViewerItem

public Item getViewerItem()

Returns the tree item of the first selected object. Used for setViewerItem in a resource change event.

Specified by:

getViewerItem in interface ISystemTree

Returns:

the item

areAnySelectedItemsExpanded

public boolean areAnySelectedItemsExpanded()

Returns true if any of the selected items are currently expanded

Specified by:

areAnySelectedItemsExpanded in interface ISystemTree

Returns:

true if any of the selected items are currently expanded

areAnySelectedItemsExpandable

public boolean areAnySelectedItemsExpandable()

Returns true if any of the selected items are expandable but not yet expanded

Specified by:

areAnySelectedItemsExpandable in interface ISystemTree

Returns:

true if any of the selected items are expandable but not yet expanded

initDragAndDrop

protected void initDragAndDrop()

Initialize drag and drop support for this view.

expandTo

public void expandTo(String filterString)

Called when user selects an Expand To action to expand the selected remote object with a quick filter

getItemPath

protected String getItemPath(TreeItem item)

Return the fully-qualified path up to the given item, expressible as a string

getItemNodeID

protected String getItemNodeID(TreeItem item)

Return the string identifying this node in the tree

getExpandToFilter

public String getExpandToFilter(Object element)

Callback from the input provider to test if the given node has expand-to filtering criteria

getExpandToFilterTable

public Hashtable getExpandToFilterTable()

To support restoring state we need to write out to disk out current table that maps tree items to their current expand-to filter. That means we need access to the table.

setExpandToFilterTable

public void setExpandToFilterTable(Hashtable ht)

To support restoring state we need to write out to disk out current table that maps tree items to their current expand-to filter. That means we need to be able to set the table.

getSetFor

protected SystemRemoteElementResourceSet getSetFor(ISubSystem subSystem,
                                                   ISystemViewElementAdapter adapter)

usingElementMap

protected boolean usingElementMap()

add

public void add(Object parentElementOrTreePath,
                Object[] childElements)