Interface IHistoryPage

This interface is not intended to be implemented by clients.
Clients can instead subclass HistoryPage.

Lifecycle

Once an Object requests to have its history shown in the History View (through an action or DND), the History View
will first try to see if any of the open History Views (there can be multiple Views if some of them are pinned) currently
show the requested Object's history. It does this by calling HistoryPage.getInput() on each IHistoryPage (which is supposed
to extend HistoryPage and comparing the input with the passed in Object. If a History View is found that already contains the Object,
it is brought to the front and its history is refreshed (by calling refresh()).
If no History View already contains the requested Object an IHistoryPage might need to be created if the current IHistoryPage
being shown in the History View doesn't know how to display the Object or if there are no IHistoryPages being shown in the History View.

The History View uses an IHistoryPageSource.createPage(Object) to create the IHistoryPage. If the History View can
determine what the Repository Provider is for the dropped Object (i.e. the Object is an instance of IResource), then it will try
to get the IFileHistoryProvider for the Repository Provider by calling RepositoryProvider.getFileHistoryProvider(). If no
IFileHistoryProvider is returned, the History View will try to adapt the Repository Provider to a IFileHistoryProvider.
If the Object whose history is being requested is not an IResource, it will not be possible to retrieve the Repository Provider from it.
In these instances the History View will try to adapt the Object to an IHistoryPageSource.

Once the IHistoryPage is created, setInput(Object) is called; this is handled by HistoryPage which clients
should subclass for their own IHistoryPage implementations. HistoryPage will in turn call HistoryPage.inputSet() -
which clients can use for setting up their IHistoryPage. The old page in the History View (along with its SubActionBars is disposed -
Page.dispose() gets called; interested clients can supply a dispose() method in their subclass. Finally, the new page is shown
and its SubActionBars are activated.

getName

getDescription

Returns a one line description of the object whose history is
being displayed. For example, for files, this may be the
workspace path of the file. The description may be displayed to
the user as tooltip text or by some other means.

Returns:

a one line description of the object whose history is
being displayed or null