org.eclipse.team.ui.history
Interface IHistoryPage

All Known Implementing Classes:

HistoryPage

public interface IHistoryPage

TODO: provide a comment and an abstract class

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

Since:

3.2

Method Summary

boolean	canShowHistoryFor(Object object) Returns true if this history page can show a history for the given object, false if it cannot
IHistoryPageSite	getHistoryPageSite() Returns the IHistoryPageSite set for this page.
String	getName() Returns the name of the object whose history the page is showing
void	refresh() Requests a refresh of the information presented by the history page.
void	setSite(IHistoryPageSite viewSite) Set the site for the page - this needs to be replaced with a proper IHistoryPageSite in order to allow history pages to be displayed in both views and dialogs
boolean	showHistory(Object object, boolean refetch) Fetches and populates the history page for the given Object.

Method Detail

showHistory

public boolean showHistory(Object object,
                           boolean refetch)

Fetches and populates the history page for the given Object. Clients should provide an implementation for their individual pages.

Parameters:

object - the object for which history is being requested for

Returns:

true if the page was able to display the history for the object, false otherwise

canShowHistoryFor

public boolean canShowHistoryFor(Object object)

Returns true if this history page can show a history for the given object, false if it cannot

Parameters:

object - the object that is to have history shown

Returns:

boolean

refresh

public void refresh()

Requests a refresh of the information presented by the history page.

getName

public String getName()

Returns the name of the object whose history the page is showing

Returns:

String containing the name of the object

setSite

public void setSite(IHistoryPageSite viewSite)

Set the site for the page - this needs to be replaced with a proper IHistoryPageSite in order to allow history pages to be displayed in both views and dialogs

Parameters:

viewSite -

getHistoryPageSite

public IHistoryPageSite getHistoryPageSite()

Returns the IHistoryPageSite set for this page.

Returns:

an IHistoryPageSite