Eclipse Platform
Release 3.2

org.eclipse.team.ui.history
Class HistoryPage

java.lang.Object
  extended byorg.eclipse.ui.part.Page
      extended byorg.eclipse.team.ui.history.HistoryPage
All Implemented Interfaces:
IAdaptable, IHistoryPage, IPage, IPageBookViewPage

public abstract class HistoryPage
extends Page
implements IHistoryPage, IAdaptable

Abstract HistoryPage class that keeps track of the history page site.

Clients may subclass this class.

Since:
3.2
See Also:
IHistoryPage

Constructor Summary
HistoryPage()
           
 
Method Summary
 IHistoryPageSite getHistoryPageSite()
          Returns the IHistoryPageSite set for this page.
 Object getInput()
          Returns the object whose history is currently being displayed in the history page.
abstract  boolean inputSet()
          Called by HistoryPage after setInput(Object).
 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.
 
Methods inherited from class org.eclipse.ui.part.Page
createControl, dispose, getControl, getSite, init, makeContributions, setActionBars, setFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.team.ui.history.IHistoryPage
getDescription, getName, isValidInput, refresh
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Constructor Detail

HistoryPage

public HistoryPage()
Method Detail

setSite

public void setSite(IHistoryPageSite site)
Description copied from interface: IHistoryPage
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.

Specified by:
setSite in interface IHistoryPage
Parameters:
site - the history page site

getHistoryPageSite

public IHistoryPageSite getHistoryPageSite()
Description copied from interface: IHistoryPage
Returns the IHistoryPageSite set for this page.

Specified by:
getHistoryPageSite in interface IHistoryPage
Returns:
the history page site for this page

getInput

public Object getInput()
Description copied from interface: IHistoryPage
Returns the object whose history is currently being displayed in the history page.

Specified by:
getInput in interface IHistoryPage
Returns:
object the object being displayed in the history page or null if no input has been set;

setInput

public boolean setInput(Object object)
Description copied from interface: IHistoryPage
Fetches and populates the history page for the given Object. Clients should provide an implementation for their individual pages.

Specified by:
setInput in interface IHistoryPage
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

inputSet

public abstract boolean inputSet()
Called by HistoryPage after setInput(Object). Clients can gain access to the input by using getInput().

Returns:
true if the page was able to display the contents, false otherwise

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

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