|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.part.Page
org.eclipse.team.ui.history.HistoryPage
Abstract HistoryPage class that keeps track of the history page site.
Clients may subclass this class.
IHistoryPage
Field Summary |
---|
Fields inherited from interface org.eclipse.team.ui.history.IHistoryPage |
---|
P_DESCRIPTION, P_NAME |
Constructor Summary | |
---|---|
HistoryPage()
|
Method Summary | |
---|---|
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a listener for changes to properties of this page. |
protected void |
firePropertyChange(Object source,
String property,
Object oldValue,
Object newValue)
Notify all listeners that the given property has changed. |
IHistoryPageSite |
getHistoryPageSite()
Returns the IHistoryPageSite set for this page. |
IHistoryView |
getHistoryView()
Returns the IHistoryView instance that contains this history page or null if
the history view instance cannot be determined. |
Object |
getInput()
Returns the object whose history is currently being displayed in the history page. |
abstract boolean |
inputSet()
Called by HistoryPage after setInput(Object) . |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given property listener from this page. |
void |
setHistoryView(IHistoryView historyView)
|
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 |
---|
dispose, getDescription, getName, isValidInput, refresh |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Constructor Detail |
public HistoryPage()
Method Detail |
public void setSite(IHistoryPageSite site)
IHistoryPage
IHistoryPageSite
in order to allow history pages to be displayed in
both views and dialogs.
setSite
in interface IHistoryPage
site
- the history page sitepublic IHistoryPageSite getHistoryPageSite()
IHistoryPage
IHistoryPageSite
set for this page.
getHistoryPageSite
in interface IHistoryPage
public Object getInput()
IHistoryPage
getInput
in interface IHistoryPage
null
if no input has been set;public boolean setInput(Object object)
IHistoryPage
setInput
in interface IHistoryPage
object
- the object for which history is being requested for
public abstract boolean inputSet()
setInput(Object)
. Clients can
gain access to the input by using getInput()
.
true
if the page was able to display the contents, false
otherwisepublic void setHistoryView(IHistoryView historyView)
public IHistoryView getHistoryView()
IHistoryPage
IHistoryView
instance that contains this history page or null if
the history view instance cannot be determined.
getHistoryView
in interface IHistoryPage
public void addPropertyChangeListener(IPropertyChangeListener listener)
IHistoryPage
The changes supported by the page are as follows:
P_NAME
- indicates the name
of the page has changedP_DESCRIPTION
- indicates the
description of the page has changedClients may define additional properties as required.
addPropertyChangeListener
in interface IHistoryPage
listener
- a property change listenerpublic void removePropertyChangeListener(IPropertyChangeListener listener)
IHistoryPage
removePropertyChangeListener
in interface IHistoryPage
listener
- a property listenerprotected void firePropertyChange(Object source, String property, Object oldValue, Object newValue)
source
- the object on which a property has changedproperty
- identifier of the property that has changedoldValue
- the old value of the property, or null
newValue
- the new value of the property, or null
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.