Eclipse Platform
Release 3.2

org.eclipse.team.ui.history
Interface IHistoryPage

All Known Implementing Classes:
HistoryPage

public interface IHistoryPage

Interface for pages that appear in the team history view.

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

Since:
3.2
See Also:
TeamUI.getHistoryView()

Method Summary
 String getDescription()
          Returns a one line description of the object whose history is being displayed.
 IHistoryPageSite getHistoryPageSite()
          Returns the IHistoryPageSite set for this page.
 Object getInput()
          Returns the object whose history is currently being displayed in the history page.
 String getName()
          Returns the name of the object whose history the page is showing
 boolean isValidInput(Object object)
          Returns true if this history page can show a history for the given object, false if it cannot
 void refresh()
          Requests a refresh of the information presented by the history page.
 boolean setInput(Object object)
          Fetches and populates the history page for the given Object.
 void setSite(IHistoryPageSite site)
          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.
 

Method Detail

setInput

public boolean setInput(Object object)
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

getInput

public Object getInput()
Returns the object whose history is currently being displayed in the history page.

Returns:
object the object being displayed in the history page or null if no input has been set;

isValidInput

public boolean isValidInput(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

getDescription

public String 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 discription 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

setSite

public void setSite(IHistoryPageSite site)
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:
site - the history page site

getHistoryPageSite

public IHistoryPageSite getHistoryPageSite()
Returns the IHistoryPageSite set for this page.

Returns:
the history page site for this page

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.