|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Control which is capable of displaying parts of a refactoring history.
Clients of this interface should call createControl
before
calling setInput
.
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
Method Summary | |
---|---|
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. |
Method Detail |
public 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 registerpublic void addSelectionChangedListener(ISelectionChangedListener listener)
If the listener is already registered with the control or has not yet been created, nothing happens.
listener
- the listener to registerpublic void 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()
public 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()
public Control getControl()
null
if the control's widget
hierarchy has not yet been createdpublic RefactoringDescriptorProxy[] getSelectedDescriptors()
public void removeCheckStateListener(ICheckStateListener listener)
If the listener is not registered with this control, nothing happens.
listener
- the listener to unregisterpublic void removeSelectionChangedListener(ISelectionChangedListener listener)
If the listener is not registered with this control, nothing happens.
listener
- the listener to unregisterpublic void 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()
public void setInput(RefactoringHistory history)
history
- the refactoring history, or null
to clear the
viewer inputpublic void setSelectedDescriptors(RefactoringDescriptorProxy[] descriptors)
descriptors
- the refactoring descriptors to select, or an empty array
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.