public interface IRefactoringHistoryControl
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.
RefactoringHistoryControlConfiguration
,
RefactoringHistoryContentProvider
,
RefactoringHistoryLabelProvider
Modifier and Type | Method and Description |
---|---|
void |
addCheckStateListener(ICheckStateListener listener)
Registers the specified check state listener with this control.
|
void |
addSelectionChangedListener(ISelectionChangedListener listener)
Registers the specified selection changed listener with this control.
|
void |
createControl()
Creates the refactoring history control.
|
RefactoringDescriptorProxy[] |
getCheckedDescriptors()
Returns the checked refactoring descriptors.
|
Control |
getControl()
Returns the SWT control of this refactoring history control.
|
RefactoringDescriptorProxy[] |
getSelectedDescriptors()
Returns the selected refactoring descriptors.
|
void |
removeCheckStateListener(ICheckStateListener listener)
Unregisters the specified check state listener with this control.
|
void |
removeSelectionChangedListener(ISelectionChangedListener listener)
Unregisters the specified selection changed listener with this control.
|
void |
setCheckedDescriptors(RefactoringDescriptorProxy[] descriptors)
Sets the checked refactoring descriptors.
|
void |
setInput(RefactoringHistory history)
Sets the refactoring history of this control.
|
void |
setSelectedDescriptors(RefactoringDescriptorProxy[] descriptors)
Sets the selected refactoring descriptors.
|
void addCheckStateListener(ICheckStateListener listener)
If the listener is already registered with the control, or the control has no checkable viewer or has not yet been created, nothing happens.
listener
- the listener to registervoid addSelectionChangedListener(ISelectionChangedListener listener)
If the listener is already registered with the control or has not yet been created, nothing happens.
listener
- the listener to registervoid createControl()
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.
getControl()
RefactoringDescriptorProxy[] getCheckedDescriptors()
In case the refactoring history control is created with a non-checkable
tree viewer, this method is equivalent to
getSelectedDescriptors()
.
getSelectedDescriptors()
,
RefactoringHistoryControlConfiguration.isCheckableViewer()
Control getControl()
null
if the control's widget
hierarchy has not yet been createdRefactoringDescriptorProxy[] getSelectedDescriptors()
void removeCheckStateListener(ICheckStateListener listener)
If the listener is not registered with this control, nothing happens.
listener
- the listener to unregistervoid removeSelectionChangedListener(ISelectionChangedListener listener)
If the listener is not registered with this control, nothing happens.
listener
- the listener to unregistervoid setCheckedDescriptors(RefactoringDescriptorProxy[] descriptors)
In case the refactoring history control is created with a non-checkable
tree viewer, this method is equivalent to
setSelectedDescriptors(RefactoringDescriptorProxy[])
.
descriptors
- the refactoring descriptors to check, or an empty arraysetSelectedDescriptors(RefactoringDescriptorProxy[])
,
RefactoringHistoryControlConfiguration.isCheckableViewer()
void setInput(RefactoringHistory history)
history
- the refactoring history, or null
to clear the
viewer inputvoid setSelectedDescriptors(RefactoringDescriptorProxy[] descriptors)
descriptors
- the refactoring descriptors to select, or an empty array
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.