Package 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

    • 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