org.eclipse.contribution.visualiser.interfaces.simpleImpl
Class SimpleContentProvider

java.lang.Object
  extended byorg.eclipse.contribution.visualiser.interfaces.simpleImpl.SimpleContentProvider
All Implemented Interfaces:
IContentProvider
Direct Known Subclasses:
FileContentProvider, ResourceContentProvider

public class SimpleContentProvider
extends java.lang.Object
implements IContentProvider

Simple implementation of a content provider


Constructor Summary
SimpleContentProvider()
           
 
Method Summary
 void addGroup(IGroup grp)
          Register a group
 java.util.List getAllGroups()
          Returns all registered groups
 java.util.List getAllMembers()
          Returns the List of all IMembers in all registered groups
 java.util.List getAllMembers(IGroup group)
          Returns all IMembers contained in the given IGroup
 java.lang.String getEmptyMessage()
          The String returned here is displayed by the Visualiser when the content provider has nothing to display.
 org.eclipse.jface.resource.ImageDescriptor getGroupViewIcon()
          Called when switching to this content provider to get the icon used in the Visualiser view for Group view.
 org.eclipse.jface.resource.ImageDescriptor getMemberViewIcon()
          Called when switching to this content provider to get the icon used in the Visualiser view for Member view.
 void initialise()
          Initialise the content provider.
 int numberOfGroupsDefined()
          Get the total number of groups registered
 boolean processMouseclick(IMember member, boolean markupWasClicked, int buttonClicked)
          Process a mouse click on a member belonging to this provider.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleContentProvider

public SimpleContentProvider()
Method Detail

getAllGroups

public java.util.List getAllGroups()
Returns all registered groups

Specified by:
getAllGroups in interface IContentProvider
Returns:
List of IGroups
See Also:
IContentProvider.getAllGroups()

getAllMembers

public java.util.List getAllMembers(IGroup group)
Returns all IMembers contained in the given IGroup

Specified by:
getAllMembers in interface IContentProvider
See Also:
IContentProvider.getAllMembers(IGroup)

getAllMembers

public java.util.List getAllMembers()
Returns the List of all IMembers in all registered groups

Specified by:
getAllMembers in interface IContentProvider

initialise

public void initialise()
Initialise the content provider. This is a default imploementation and so does nothing.

Specified by:
initialise in interface IContentProvider
See Also:
IContentProvider.initialise()

addGroup

public void addGroup(IGroup grp)
Register a group

Parameters:
grp -

numberOfGroupsDefined

public int numberOfGroupsDefined()
Get the total number of groups registered

Returns:

processMouseclick

public boolean processMouseclick(IMember member,
                                 boolean markupWasClicked,
                                 int buttonClicked)
Process a mouse click on a member belonging to this provider. This is a default implementation and so does nothing and returns true to allow the visualiser to perform it's default mouse click operation.

Specified by:
processMouseclick in interface IContentProvider
See Also:
IContentProvider.processMouseclick(IMember, boolean, int)

getEmptyMessage

public java.lang.String getEmptyMessage()
Description copied from interface: IContentProvider
The String returned here is displayed by the Visualiser when the content provider has nothing to display. It should inform the user of the nature of the content provider, and the means by which the user gives input to the provider.

Specified by:
getEmptyMessage in interface IContentProvider
Returns:
the message to display to the user when the Visualiser is empty

getMemberViewIcon

public org.eclipse.jface.resource.ImageDescriptor getMemberViewIcon()
Description copied from interface: IContentProvider
Called when switching to this content provider to get the icon used in the Visualiser view for Member view. If null is returned default icons are used.

Specified by:
getMemberViewIcon in interface IContentProvider
Returns:
image to be used as member view icon
See Also:
IContentProvider.getMemberViewIcon()

getGroupViewIcon

public org.eclipse.jface.resource.ImageDescriptor getGroupViewIcon()
Description copied from interface: IContentProvider
Called when switching to this content provider to get the icon used in the Visualiser view for Group view. If null is returned default icons are used.

Specified by:
getGroupViewIcon in interface IContentProvider
Returns:
image to be used as group view icon
See Also:
IContentProvider.getGroupViewIcon()