Contributing to the Team Artifacts view

Summary

This article explains how to contribute to the Team Artifacts view.

By Jazz Process Component Team
Created August 28, 2008
Build basis: RTC 1.0 (Jazz 0.6)

• What is a Domain?
• How To Create a Domain
  • Implementing Different Types of Domains
  • Content Provider
  • Label Provider
  • Sorter
  • Comparer
  • Model Element Conversion
  • Contribute to Context Menu
  • Participate in Drag and Drop

Introduction

The Team Artifacts view is an Eclipse view within Jazz that presents a hierarchy of heterogeneous elements that are provided from contributed domains. Domains can also be presented within the Team Artifacts part of a Team Area editor.

What is a Domain?

A domain is an extension mechanism for different components to contribute context specific elements of a given type to a domain navigator such as the Team Artifacts view or the Team Area editor.

How To Create a Domain

You will need to add the following required plug-in as a prerequisite:

Domain implementations must extend the abstract class

After you have coded your domain, you can contribute it by extending the

The

• com.ibm.unlicensed.* – Domain will work without being included in the license
• * – Domain will work without being included in the license
• com.ibm.* – Domain needs to be licensed

For example, the declaration of the Plans domain from the

...  <extension point="com.ibm.team.process.rcp.ui.teamArtifactsNavigatorDomain">     <teamArtifactsNovigatorDomain      	class="com.ibm.team.apt.internal.ide.ui.navigator.PlanningDomain"     	icon="$nl$/icons/obj16/planning_domain.gif"     	id="com.ibm.team.process.deliver.requireWorkItem"      	name="%PlanningDomainName"/>  </extension>  ...  

Within the Team Artifacts view, all calls that concern domain elements are delegated to the corresponding domain. Therefore, domain represents a factory for the standard JFace notions of content provider, label provider, sorter, and comparer. In addition, there are opportunities to convert model elements for presentation within the UI, contribute to the view context menu, and participate in drag and drop.

Implementing Different Types of Domains

There are two kinds of domains within Jazz: standard domains, which pertain to a specific process area, and top-level domains, which don’t have a process area scope. The type of the domain is determined by the implementation details of specific methods.

Within the Team Artifacts view, standard domains are shown under each project area. They need to return true for

For domains to be included within the

Top-level domains appear outside the context of any Project Area in the Team Artifacts view. Such domains typically present information that is global to the user’s Eclipse workspace, such as the

Content Provider

The domain implementation contributes its elements by providing an

Label Provider

A label provider is needed to render the domain elements. The label provider must implement

Sorter

A domain can provide an

Comparer

A domain can provide an

Model Element Conversion

A domain can choose not to expose its model objects but use representation objects within the UI. The

Selections in the domain navigator are always of type

Contribute to Context Menu

If a selection consists only of elements of one domain (

Participate in Drag and Drop

To enable drag and drop for its elements a domain has to overwrite all these methods:

• #validateDrop(Object, ISelection, int)
• #getSupportedOperationsForSelection(ISelection)
• #performDrop(Object, ISelection, int)

© Copyright 2008 IBM