Skip to main content
Jump to: navigation, search

Difference between revisions of "Roster Menus"

Line 1: Line 1:
I've created the ability to create a '''Roster Menu'''...i.e. a dynamically created menu from the ECF contacts list/roster.
+
It's now possible to create a '''Roster Menu'''...i.e. a dynamically created menu from the ECF contacts list/roster.
  
 
So, for example, here's my current contacts list:
 
So, for example, here's my current contacts list:
Line 9: Line 9:
 
[[Image:contactsmenu.png]]
 
[[Image:contactsmenu.png]]
  
Note that this menu can be added to '''any''' existing menu using the platform UI [[Menu Contributions]] mechanisms.
+
Note that this menu can be added to '''any''' existing menu using the platform UI [[Menu Contributions]] mechanisms.  So this roster menu can be used to interact with roster entry items in any appropriate context (e.g. an editor, a view, workbench, etc).
  
The way this works is that a plugin can add markup like the following to specify a new roster menu contribution:
+
The way this works is that a plugin can add markup similar to the following to specify a new roster menu contribution:
  
 
<pre>
 
<pre>
Line 26: Line 26:
 
</pre>
 
</pre>
  
Notice the class '''org.eclipse.ecf.presence.ui.menu.NoopRosterMenuContributionItem'''.  This is a new class that creates a roster menu contribution that does nothing (performs a noop).  The command handler associated with this contribution item does nothing, so that when the Ted Kubaska menu item is chosen, nothing happens.  
+
Notice the class '''org.eclipse.ecf.presence.ui.menu.NoopRosterMenuContributionItem'''.  This is a new class that creates a roster menu contribution that does nothing (performs a noop).  The way this works is that the command handler associated with this contribution item does nothing, so that when the Ted Kubaska menu item is chosen, nothing happens.  
  
It's possible, and easy, however to create a subclass of
+
It's easy, however to create a subclass of '''[org.eclipse.ecf.presence.ui.menu.AbstractRosterMenuContributionItem''' and customize the roster menu behavior.  The following is the implementation of '''org.eclipse.ecf.presence.ui.menu.NoopRosterMenuContributionItem''':
 +
 
 +
<pre>
 +
public class NoopRosterMenuContributionItem extends AbstractRosterMenuContributionItem {
 +
 
 +
protected AbstractRosterMenuHandler createRosterEntryHandler(IRosterEntry rosterEntry) {
 +
return new AbstractRosterMenuHandler(rosterEntry) {
 +
public Object execute(ExecutionEvent arg0) throws ExecutionException {
 +
System.out.println("execute(" + arg0 + ") on rosterEntry=" + getRosterEntry());
 +
return null;
 +
}
 +
 
 +
};
 +
}
 +
 
 +
}
 +
</pre>

Revision as of 20:50, 30 October 2007

It's now possible to create a Roster Menu...i.e. a dynamically created menu from the ECF contacts list/roster.

So, for example, here's my current contacts list:

Contacts.png

Here's a new roster menu, that shows as a menu the active roster entries (buddies)

Contactsmenu.png

Note that this menu can be added to any existing menu using the platform UI Menu Contributions mechanisms. So this roster menu can be used to interact with roster entry items in any appropriate context (e.g. an editor, a view, workbench, etc).

The way this works is that a plugin can add markup similar to the following to specify a new roster menu contribution:

   <extension
         point="org.eclipse.ui.menus">
      <menuContribution
            locationURI="popup:org.eclipse.ecf.presence.ui.MultiRosterView?before=additions">
         <dynamic
               class="org.eclipse.ecf.presence.ui.menu.NoopRosterMenuContributionItem"
               id="org.eclipse.ecf.presence.collab.ui.dynamic5">
         </dynamic>
      </menuContribution>
   </extension>

Notice the class org.eclipse.ecf.presence.ui.menu.NoopRosterMenuContributionItem. This is a new class that creates a roster menu contribution that does nothing (performs a noop). The way this works is that the command handler associated with this contribution item does nothing, so that when the Ted Kubaska menu item is chosen, nothing happens.

It's easy, however to create a subclass of [org.eclipse.ecf.presence.ui.menu.AbstractRosterMenuContributionItem and customize the roster menu behavior. The following is the implementation of org.eclipse.ecf.presence.ui.menu.NoopRosterMenuContributionItem:

public class NoopRosterMenuContributionItem extends AbstractRosterMenuContributionItem {

	protected AbstractRosterMenuHandler createRosterEntryHandler(IRosterEntry rosterEntry) {
		return new AbstractRosterMenuHandler(rosterEntry) {
			public Object execute(ExecutionEvent arg0) throws ExecutionException {
				System.out.println("execute(" + arg0 + ") on rosterEntry=" + getRosterEntry()); 
				return null;
			}

		};
	}

}

Back to the top