RSE
Release 1.0

org.eclipse.rse.ui.view.team
Class SystemTeamView

java.lang.Object
  extended byorg.eclipse.jface.viewers.Viewer
      extended byorg.eclipse.jface.viewers.ContentViewer
          extended byorg.eclipse.jface.viewers.StructuredViewer
              extended byorg.eclipse.jface.viewers.AbstractTreeViewer
                  extended byorg.eclipse.jface.viewers.TreeViewer
                      extended byorg.eclipse.rse.ui.view.team.SystemTeamView
All Implemented Interfaces:
EventListener, IInputProvider, IInputSelectionProvider, IPostSelectionProvider, ISelectionProvider, ISystemResourceChangeListener, ISystemSelectAllTarget

public class SystemTeamView
extends TreeViewer
implements ISystemSelectAllTarget, ISystemResourceChangeListener

We specialize tree viewer for the Team view, so we know when we are dealing with the team view in common code.


Nested Class Summary
 
Nested classes inherited from class org.eclipse.jface.viewers.StructuredViewer
StructuredViewer.ColorAndFontCollector, StructuredViewer.ColorAndFontCollectorWithProviders
 
Field Summary
 
Fields inherited from class org.eclipse.jface.viewers.AbstractTreeViewer
ALL_LEVELS
 
Fields inherited from class org.eclipse.jface.viewers.Viewer
WIDGET_DATA_KEY
 
Constructor Summary
SystemTeamView(Composite parent, int style, SystemTeamViewPart teamViewPart)
           
SystemTeamView(Composite parent, SystemTeamViewPart teamViewPart)
           
SystemTeamView(Tree tree, SystemTeamViewPart teamViewPart)
           
 
Method Summary
 void collapseSelected()
          Handles a collapse-selected request
 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.
 void expandSelected()
          Handles an expand-selected request
 TreeItem findChildTreeItem(TreeItem parentItem, Object dataObject)
          Given a tree item, search the immediate children for an item representing the given object.
 TreeItem findTreeItem(Object dataObject)
          Use findItem to find a tree item given its data object, or null if given object not in tree.
 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.
 Shell getShell()
          Return the shell
 SystemTeamViewPart getTeamViewPart()
          Return the part view part of this tree view
 void systemResourceChanged(ISystemResourceChangeEvent event)
          Called when something changes in the model
 void updatePropertySheet()
          Called when a property is updated and we need to inform the Property Sheet viewer.
 
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, getSelection, 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, add, addSelectionListener, addTreeListener, associate, collapseAll, collapseToLevel, createTreeItem, disassociate, doFindInputItem, doFindItem, doUpdateItem, expandAll, expandToLevel, expandToLevel, fireTreeCollapsed, fireTreeExpanded, getAutoExpandLevel, getExpandedElements, getExpandedState, getExpandedTreePaths, getFilteredChildren, getNextItem, getPreviousItem, getSelection, getSelectionFromWidget, getSortedChildren, getTreePathFromItem, getVisibleExpandedElements, handleDoubleSelect, handleTreeCollapse, handleTreeExpand, 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, usingElementMap
 
Methods inherited from class org.eclipse.jface.viewers.ContentViewer
getContentProvider, getInput, handleDispose
 
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, removeSelectionChangedListener, setSelection
 

Constructor Detail

SystemTeamView

public SystemTeamView(Composite parent,
                      SystemTeamViewPart teamViewPart)
Parameters:
parent -

SystemTeamView

public SystemTeamView(Composite parent,
                      int style,
                      SystemTeamViewPart teamViewPart)
Parameters:
parent -
style -

SystemTeamView

public SystemTeamView(Tree tree,
                      SystemTeamViewPart teamViewPart)
Parameters:
tree -
Method Detail

getTeamViewPart

public SystemTeamViewPart getTeamViewPart()
Return the part view part of this tree view


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.


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.


findTreeItem

public TreeItem findTreeItem(Object dataObject)
Use findItem to find a tree item given its data object, or null if given object not in tree.


findChildTreeItem

public TreeItem findChildTreeItem(TreeItem parentItem,
                                  Object dataObject)
Given a tree item, search the immediate children for an item representing the given object.


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.


systemResourceChanged

public void systemResourceChanged(ISystemResourceChangeEvent event)
Called when something changes in the model

Specified by:
systemResourceChanged in interface ISystemResourceChangeListener
See Also:
ISystemResourceChangeEvent

getShell

public Shell getShell()
Return the shell

Specified by:
getShell in interface ISystemResourceChangeListener

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

collapseSelected

public void collapseSelected()
Handles a collapse-selected request


expandSelected

public void expandSelected()
Handles an expand-selected request


RSE
Release 1.0

Copyright (c) IBM Corporation and others 2000, 2006. All Rights Reserved.