Eclipse Plug-in Developer Guide (Galileo) - FileEditorMappingContentProvider (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.dialogs
Class FileEditorMappingContentProvider


java.lang.Object
  
org.eclipse.ui.dialogs.FileEditorMappingContentProvider

All Implemented Interfaces:: IContentProvider, IStructuredContentProvider

public class FileEditorMappingContentProvider
extends Object
implements IStructuredContentProvider
extends Object
implements IStructuredContentProvider

A content provider for displaying of IFileEditorMapping objects in viewers.

This class has a singleton instance, FileEditorMappingContentProvider.INSTANCE, which can be used any place this kind of content provider is needed.

See Also:: IContentProvider

Field Summary

static FileEditorMappingContentProvider INSTANCE
          Singleton instance accessor.

Method Summary

void dispose ()
          Disposes of this content provider.

Object[] getElements ( Object element)
          Returns the elements to display in the viewer when its input is set to the given element.

void inputChanged ( Viewer viewer, Object oldInput, Object newInput)
          Notifies this content provider that the given viewer's input has been switched to a different element.

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final 
FileEditorMappingContentProvider INSTANCE

Singleton instance accessor.

Method Detail

dispose

public void dispose()

Description copied from interface: IContentProvider

Disposes of this content provider. This is called by the viewer when it is disposed.

The viewer should not be updated during this call, as it is in the process of being disposed.

Specified by:: dispose in interface IContentProvider

getElements

public 
Object[] getElements(
Object element)

Description copied from interface: IStructuredContentProvider

Returns the elements to display in the viewer when its input is set to the given element. These elements can be presented as rows in a table, items in a list, etc. The result is not modified by the viewer.

NOTE: For instances where the viewer is displaying a tree containing a single 'root' element it is still necessary that the 'input' does not return itself from this method. This leads to recursion issues (see bug 9262).

Specified by:: getElements in interface IStructuredContentProvider

Parameters:: element - the input element
Returns:: the array of elements to display in the viewer

inputChanged

public void inputChanged(
Viewer viewer,
                         
Object oldInput,
                         
Object newInput)

Description copied from interface: IContentProvider

Notifies this content provider that the given viewer's input has been switched to a different element.

A typical use for this method is registering the content provider as a listener to changes on the new input (using model-specific means), and deregistering the viewer from the old input. In response to these change notifications, the content provider should update the viewer (see the add, remove, update and refresh methods on the viewers).

The viewer should not be updated during this call, as it might be in the process of being disposed.

Specified by:: inputChanged in interface IContentProvider

Parameters:: viewer - the viewer; oldInput - the old input element, or null if the viewer did not previously have an input; newInput - the new input element, or null if the viewer does not have an input