Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.contribution.visualiser.interfaces
Interface IContentProvider

All Known Implementing Classes:
  JDTContentProvider, SimpleContentProvider

public interface IContentProvider

The implementation of this interface is responsible for returning information about the bars that appear in the visualiser view. The related implementation of IMarkupProvider provides the information about the colored stripes on the bars. A simple implementation is provided in SimpleContentProvider - this contains basic implementations of some of the common features of a content provider In particular, it manages groups/members automatically. Important: The lists returned from the various get methods should either be lists of classes implementing IGroup or classes implementing IMember. Simple implementations of IGroup and IMember are SimpleGroup and SimpleMember.

Method Summary
`java.util.List` | `getAllGroups()` Return a list of all groups that the provider knows about.
`java.util.List` | `getAllMembers()` Return a list of all members in all groups the provider knows about.
`java.util.List` | `getAllMembers(IGroup group)` Return a list of all members in a group.
`java.lang.String` | `getEmptyMessage()` This string returned here is displayed by the visualiser when the content provider has nothing to display.
`void` | `initialise()` Called on visualiser startup, to get the provider ready.
`boolean` | `processMouseclick(IMember member, boolean markupWasClicked, int buttonClicked)` Called when the user clicks on a member in the visualiser - the information passed is - The full name of the member, e.g.

Method Detail

### getAllGroups

    public java.util.List getAllGroups()

  Return a list of all groups that the provider knows about.

### getAllMembers

    public java.util.List getAllMembers(IGroup group)

  Return a list of all members in a group.

### getAllMembers

    public java.util.List getAllMembers()

  Return a list of all members in all groups the provider knows about.

### initialise

    public void initialise()

  Called on visualiser startup, to get the provider ready.

### processMouseclick

    public boolean processMouseclick(IMember member,
                                     boolean markupWasClicked,
                                     int buttonClicked)

  Called when the user clicks on a member in the visualiser - the information passed is - The full name of the member, e.g. "ABC.B" - Whether the click was actually on a colored area (stripe) in the member - The buttons pressed (1 is LH button, 3 is RH button) The return value is whether the visualiser should take its normal action on this click. The normal action is that on a left hand mouse click, the visualiser subselects the clicked member (if in the group view, it swaps to a member view of the members in that group). If the right hand mouse button is clicked, it returns to the previous visualisation. Remember: The markup provider is called with a similar method 'processMouseClick()' if the boolean markupWasClicked is true. This call to the markup provider will occur regardless of whether true or false is returned here.

### getEmptyMessage

    public java.lang.String getEmptyMessage()

  This 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.

  Returns:
    the message to display the user when the visualiser is empty

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD