Package org.eclipse.ltk.ui.refactoring

Class RefactoringUI

java.lang.Object

org.eclipse.ltk.ui.refactoring.RefactoringUI

public class RefactoringUI
extends Object

Central access point to access resources managed by the refactoring UI plug-in.

Note: this class is not intended to be extended by clients.

Since:

3.0

Restriction:

This class is not intended to be subclassed by clients.

Method Summary

Modifier and Type	Method	Description
static Dialog	createLightWeightStatusDialog(RefactoringStatus status, Shell parent, String windowTitle)	Creates a light-weight dialog to present a RefactoringStatus to the user.
static Composite	createRefactoringHistoryControl(Composite parent, RefactoringHistoryControlConfiguration configuration)	Creates a control capable of presenting a refactoring history.
static Dialog	createRefactoringStatusDialog(RefactoringStatus status, Shell parent, String windowTitle, boolean backButton)	Creates a dialog to present a RefactoringStatus to the user.
static Composite	createSortableRefactoringHistoryControl(Composite parent, RefactoringHistoryControlConfiguration configuration)	Creates a control capable of presenting a refactoring history.
static PerformChangeOperation	createUIAwareChangeOperation(Change change)	Deprecated. use PerformChangeOperation(Change).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createLightWeightStatusDialog

public static Dialog createLightWeightStatusDialog(RefactoringStatus status,
                                                   Shell parent,
                                                   String windowTitle)

Creates a light-weight dialog to present a RefactoringStatus to the user. The following values are returned from the dialogs open method:

• IDialogConstants#OK_ID: if the user has pressed the continue button.
• IDialogConstants#CANCEL_ID: if the user has pressed the cancel button.
• IDialogConstants#BACK_ID: if the user has pressed the back button.

Parameters:

status - the status to present

parent - the parent shell of the dialog. May be null if the dialog is a top-level dialog

windowTitle - the dialog's window title

Returns:

a dialog to present a refactoring status.

Since:

3.2

createRefactoringHistoryControl

public static Composite createRefactoringHistoryControl(Composite parent,
                                                        RefactoringHistoryControlConfiguration configuration)

Creates a control capable of presenting a refactoring history. Clients of this method can assume that the returned composite is an instance of IRefactoringHistoryControl.

Parameters:

parent - the parent control

configuration - the refactoring history control configuration

Returns:

the refactoring history control

Since:

3.2

createRefactoringStatusDialog

public static Dialog createRefactoringStatusDialog(RefactoringStatus status,
                                                   Shell parent,
                                                   String windowTitle,
                                                   boolean backButton)

Creates a dialog to present a RefactoringStatus to the user. The following values are returned from the dialogs open method:

• IDialogConstants#OK_ID: if the user has pressed the continue button.
• IDialogConstants#CANCEL_ID: if the user has pressed the cancel button.
• IDialogConstants#BACK_ID: if the user has pressed the back button.

Parameters:

status - the status to present

parent - the parent shell of the dialog. May be null if the dialog is a top-level dialog

windowTitle - the dialog's window title

backButton - if true the dialog will contain a back button; otherwise no back button will be present.

Returns:

a dialog to present a refactoring status.

createSortableRefactoringHistoryControl

public static Composite createSortableRefactoringHistoryControl(Composite parent,
                                                                RefactoringHistoryControlConfiguration configuration)

Creates a control capable of presenting a refactoring history. Clients of this method can assume that the returned composite is an instance of ISortableRefactoringHistoryControl.

Parameters:

parent - the parent control

configuration - the refactoring history control configuration

Returns:

the refactoring history control

Since:

3.3

createUIAwareChangeOperation

@Deprecated
public static PerformChangeOperation createUIAwareChangeOperation(Change change)

Deprecated.

use PerformChangeOperation(Change). Since 3.1, undo batching is implemented in TextChange.

Creates a special perform change operations that knows how to batch undo operations in open editors into one undo object. The operation batches the undo operations for those editors that implement the interface IRewriteTarget.

Parameters:

change - the change to perform

Returns:

a special perform change operation that knows how to batch undo operations for open editors if they implement IRewriteTarget