KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ltk > ui > refactoring > history > ISortableRefactoringHistoryControl


1 /*******************************************************************************
2  * Copyright (c) 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ltk.ui.refactoring.history;
12
13 import org.eclipse.ltk.ui.refactoring.RefactoringUI;
14
15 /**
16  * Extension interface to {@link IRefactoringHistoryControl} which provides
17  * facilities to set the sort mode of a refactoring history control.
18  * <p>
19  * Clients of this interface should call <code>createControl</code> before
20  * calling <code>setInput</code>.
21  * </p>
22  * <p>
23  * An instanceof of a sortable refactoring history control may be obtained by
24  * calling
25  * {@link RefactoringUI#createSortableRefactoringHistoryControl(org.eclipse.swt.widgets.Composite, RefactoringHistoryControlConfiguration)}.
26  * </p>
27  * <p>
28  * Note: this interface is not intended to be implemented by clients.
29  * </p>
30  *
31  * @see RefactoringHistoryControlConfiguration
32  * @see RefactoringHistoryContentProvider
33  * @see RefactoringHistoryLabelProvider
34  *
35  * @since 3.3
36  */
37 public interface ISortableRefactoringHistoryControl extends IRefactoringHistoryControl {
38
39     /**
40      * Is sorting by date enabled?
41      *
42      * @return <code>true</code> if it is enabled, <code>false</code>
43      * otherwise
44      */
45     public boolean isSortByDate();
46
47     /**
48      * Is sorting by projects enabled?
49      *
50      * @return <code>true</code> if it is enabled, <code>false</code>
51      * otherwise
52      */
53     public boolean isSortByProjects();
54
55     /**
56      * Sorts the refactorings by date.
57      */
58     public void sortByDate();
59
60     /**
61      * Sorts the refactorings by projects.
62      */
63     public void sortByProjects();
64 }
Popular Tags