Interface IRefactoringHistoryControl
- All Known Subinterfaces:
ISortableRefactoringHistoryControl
Clients of this interface should call createControl() before calling
setInput(RefactoringHistory).
An instanceof of a refactoring history control may be obtained by calling
RefactoringUI.createRefactoringHistoryControl(org.eclipse.swt.widgets.Composite, RefactoringHistoryControlConfiguration)
.
Note: this interface is not intended to be implemented by clients.
- Since:
- 3.2
- See Also:
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddCheckStateListener(ICheckStateListener listener) Registers the specified check state listener with this control.voidRegisters the specified selection changed listener with this control.voidCreates the refactoring history control.Returns the checked refactoring descriptors.Returns the SWT control of this refactoring history control.Returns the selected refactoring descriptors.voidremoveCheckStateListener(ICheckStateListener listener) Unregisters the specified check state listener with this control.voidUnregisters the specified selection changed listener with this control.voidsetCheckedDescriptors(RefactoringDescriptorProxy[] descriptors) Sets the checked refactoring descriptors.voidsetInput(RefactoringHistory history) Sets the refactoring history of this control.voidsetSelectedDescriptors(RefactoringDescriptorProxy[] descriptors) Sets the selected refactoring descriptors.
-
Method Details
-
addCheckStateListener
Registers the specified check state listener with this control.If the listener is already registered with the control, or the control has no checkable viewer or has not yet been created, nothing happens.
- Parameters:
listener- the listener to register
-
addSelectionChangedListener
Registers the specified selection changed listener with this control.If the listener is already registered with the control or has not yet been created, nothing happens.
- Parameters:
listener- the listener to register
-
createControl
void createControl()Creates the refactoring history control.This method creates the necessary widgets and initializes the refactoring history control. It is called only once. Method
getControl()should be used to retrieve the widget hierarchy.- See Also:
-
getCheckedDescriptors
RefactoringDescriptorProxy[] getCheckedDescriptors()Returns the checked refactoring descriptors.In case the refactoring history control is created with a non-checkable tree viewer, this method is equivalent to
getSelectedDescriptors().- Returns:
- the selected refactoring descriptors, or an empty array.
- See Also:
-
getControl
Control getControl()Returns the SWT control of this refactoring history control.- Returns:
- the SWT control, or
nullif the control's widget hierarchy has not yet been created
-
getSelectedDescriptors
RefactoringDescriptorProxy[] getSelectedDescriptors()Returns the selected refactoring descriptors.- Returns:
- the selected refactoring descriptors, or an empty array.
-
removeCheckStateListener
Unregisters the specified check state listener with this control.If the listener is not registered with this control, nothing happens.
- Parameters:
listener- the listener to unregister
-
removeSelectionChangedListener
Unregisters the specified selection changed listener with this control.If the listener is not registered with this control, nothing happens.
- Parameters:
listener- the listener to unregister
-
setCheckedDescriptors
Sets the checked refactoring descriptors.In case the refactoring history control is created with a non-checkable tree viewer, this method is equivalent to
setSelectedDescriptors(RefactoringDescriptorProxy[]).- Parameters:
descriptors- the refactoring descriptors to check, or an empty array- See Also:
-
setInput
Sets the refactoring history of this control.- Parameters:
history- the refactoring history, ornullto clear the viewer input
-
setSelectedDescriptors
Sets the selected refactoring descriptors.- Parameters:
descriptors- the refactoring descriptors to select, or an empty array
-