|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ltk.ui.refactoring.history.RefactoringHistoryContentProvider
Tree content provider to display a refactoring history. This content provider
may be used with RefactoringHistory
elements and returns model
elements suitable to be rendered using
RefactoringHistoryLabelProvider
.
Note: this class is not indented to be subclassed outside the refactoring framework.
IRefactoringHistoryControl
,
RefactoringHistoryControlConfiguration
Constructor Summary | |
---|---|
RefactoringHistoryContentProvider(RefactoringHistoryControlConfiguration configuration)
Creates a new refactoring history content provider. |
Method Summary | |
---|---|
void |
dispose()
Disposes of this content provider. This is called by the viewer when it is disposed. The viewer should not be updated during this call, as it is in the process of being disposed. |
Object[] |
getChildren(Object element)
Returns the child elements of the given parent element.
The difference between this method and |
Object[] |
getElements(Object element)
Returns the elements to display in the viewer when its input is set to the given element. These elements can be presented as rows in a table, items in a list, etc. The result is not modified by the viewer. |
Object |
getParent(Object element)
Returns the parent for the given element, or null
indicating that the parent can't be computed.
In this case the tree-structured viewer can't expand
a given node correctly if requested. |
Object[] |
getRootElements()
Returns the refactoring history root elements. |
boolean |
hasChildren(Object element)
Returns whether the given element has children.
Intended as an optimization for when the viewer does not
need the actual children. Clients may be able to implement
this more efficiently than |
void |
inputChanged(Viewer viewer,
Object predecessor,
Object successor)
Notifies this content provider that the given viewer's input has been switched to a different element. A typical use for this method is registering the content provider as a listener to changes on the new input (using model-specific means), and deregistering the viewer from the old input. In response to these change notifications, the content provider should update the viewer (see the add, remove, update and refresh methods on the viewers). The viewer should not be updated during this call, as it might be in the process of being disposed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RefactoringHistoryContentProvider(RefactoringHistoryControlConfiguration configuration)
configuration
- the refactoring history control configurationMethod Detail |
public void dispose()
The viewer should not be updated during this call, as it is in the process of being disposed.
dispose
in interface IContentProvider
public Object[] getChildren(Object element)
The difference between this method and IStructuredContentProvider.getElements
is that getElements
is called to obtain the
tree viewer's root elements, whereas getChildren
is used
to obtain the children of a given parent element in the tree (including a root).
getChildren
in interface ITreeContentProvider
element
- the parent element
public Object[] getElements(Object element)
getElements
in interface IStructuredContentProvider
element
- the input element
public Object getParent(Object element)
null
indicating that the parent can't be computed.
In this case the tree-structured viewer can't expand
a given node correctly if requested.
getParent
in interface ITreeContentProvider
element
- the element
null
if it
has none or if the parent cannot be computedpublic Object[] getRootElements()
This method must only be called for refactoring histories with associated time information.
public boolean hasChildren(Object element)
Intended as an optimization for when the viewer does not
need the actual children. Clients may be able to implement
this more efficiently than getChildren
.
hasChildren
in interface ITreeContentProvider
element
- the element
true
if the given element has children,
and false
if it has no childrenpublic void inputChanged(Viewer viewer, Object predecessor, Object successor)
A typical use for this method is registering the content provider as a listener to changes on the new input (using model-specific means), and deregistering the viewer from the old input. In response to these change notifications, the content provider should update the viewer (see the add, remove, update and refresh methods on the viewers).
The viewer should not be updated during this call, as it might be in the process of being disposed.
inputChanged
in interface IContentProvider
viewer
- the viewerpredecessor
- the old input element, or null
if the viewer
did not previously have an inputsuccessor
- the new input element, or null
if the viewer
does not have an input
|
Eclipse Platform Release 3.2 |
|||||||||||
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, 2006. All rights reserved.