Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.team.ui.history
Interface IHistoryView


public interface IHistoryView

This interface provides a way for clients to request the History View to display the history for a given object.

This interface is not intended to be implemented by clients.

Since:
3.2
See Also:
IFileHistory, IHistoryPage

Field Summary
static  String VIEW_ID
          The id for this view.
 
Method Summary
  IHistoryPage getHistoryPage ()
          Returns the history page that is currently being displayed by the history view.
  IHistoryPage showHistoryFor ( Object object)
          Shows the history for the passed in object.
  IHistoryPage showHistoryFor ( Object object, boolean force)
          Shows the history for the given object.
 

Field Detail

VIEW_ID

static final 
String VIEW_ID
The id for this view.

Since:
3.3
See Also:
Constant Field Values
Method Detail

getHistoryPage

IHistoryPage getHistoryPage()
Returns the history page that is currently being displayed by the history view. TODO: Need to explain what page this is. Is it the visible page?

Returns:
the history page

showHistoryFor

IHistoryPage showHistoryFor(
Object object)
Shows the history for the passed in object. This method is equivalent to showHistoryFor(Object, boolean) with force set to false.

Parameters:
object - the input whose history is to be displayed
Returns:
returns the history page that the passed in object is being shown in or null if no appropriate page can be found.

showHistoryFor

IHistoryPage showHistoryFor(
Object object,
                            boolean force)
Shows the history for the given object. If force is false, the history may be displayed in another instance of IHistoryView. For example, if the target view is pinned, the history will be shown in another view instance. If force is true, the history will be shown in this view instance regardless of the view state.

Parameters:
object - the input whose history is to be displayed
force - whether this view should show the input even if it is pinned
Returns:
returns the history page that the passed in object is being shown in or null if no appropriate page can be found.
Since:
3.3

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire