Class PreferenceContentProvider
- java.lang.Object
-
- org.eclipse.jface.preference.PreferenceContentProvider
-
- All Implemented Interfaces:
IContentProvider,IStructuredContentProvider,ITreeContentProvider
public class PreferenceContentProvider extends Object implements ITreeContentProvider
Provides a tree model forPreferenceManagercontent.- Since:
- 3.0
-
-
Constructor Summary
Constructors Constructor Description PreferenceContentProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddispose()Disposes of this content provider.Object[]getChildren(Object parentElement)Returns the child elements of the given parent element.Object[]getElements(Object inputElement)Returns the elements to display in the viewer when its input is set to the given element.ObjectgetParent(Object element)Returns the parent for the given element, ornullindicating that the parent can't be computed.booleanhasChildren(Object element)Returns whether the given element has children.voidinputChanged(Viewer viewer, Object oldInput, Object newInput)Notifies this content provider that the given viewer's input has been switched to a different element.protected voidsetManager(PreferenceManager manager)Set the manager for the preferences.
-
-
-
Method Detail
-
dispose
public void dispose()
Description copied from interface:IContentProviderDisposes 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.
The default implementation does nothing.
- Specified by:
disposein interfaceIContentProvider
-
getChildren
public Object[] getChildren(Object parentElement)
Description copied from interface:ITreeContentProviderReturns the child elements of the given parent element.The difference between this method and
The result is not modified by the viewer.IStructuredContentProvider.getElementsis thatgetElementsis called to obtain the tree viewer's root elements, whereasgetChildrenis used to obtain the children of a given parent element in the tree (including a root).- Specified by:
getChildrenin interfaceITreeContentProvider- Parameters:
parentElement- the parent element- Returns:
- an array of child elements
-
getElements
public Object[] getElements(Object inputElement)
Description copied from interface:ITreeContentProviderReturns 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.NOTE: The returned array must not contain the given
inputElement, since this leads to recursion issues inAbstractTreeViewer(see bug 9262).- Specified by:
getElementsin interfaceIStructuredContentProvider- Specified by:
getElementsin interfaceITreeContentProvider- Parameters:
inputElement- the input element- Returns:
- the array of elements to display in the viewer
-
getParent
public Object getParent(Object element)
Description copied from interface:ITreeContentProviderReturns the parent for the given element, ornullindicating that the parent can't be computed. In this case the tree-structured viewer can't expand a given node correctly if requested.- Specified by:
getParentin interfaceITreeContentProvider- Parameters:
element- the element- Returns:
- the parent element, or
nullif it has none or if the parent cannot be computed
-
hasChildren
public boolean hasChildren(Object element)
Description copied from interface:ITreeContentProviderReturns 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
getChildren.- Specified by:
hasChildrenin interfaceITreeContentProvider- Parameters:
element- the element- Returns:
trueif the given element has children, andfalseif it has no children
-
inputChanged
public void inputChanged(Viewer viewer, Object oldInput, Object newInput)
Description copied from interface:IContentProviderNotifies 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.
The default implementation does nothing.
- Specified by:
inputChangedin interfaceIContentProvider- Parameters:
viewer- the vieweroldInput- the old input element, ornullif the viewer did not previously have an inputnewInput- the new input element, ornullif the viewer does not have an input
-
setManager
protected void setManager(PreferenceManager manager)
Set the manager for the preferences.- Parameters:
manager- The manager to set.- Since:
- 3.1
-
-