Package org.eclipse.ui.views.navigator

Class ResourceNavigator

    • Constructor Detail

      • ResourceNavigator

        public ResourceNavigator()
        Deprecated.
        Constructs a new resource navigator view.

    • Method Detail

      • createPartControl

        public void createPartControl​(Composite parent)
        Deprecated.
        Description copied from interface: IWorkbenchPart
        Creates the SWT controls for this workbench part.

        Clients should not call this method (the workbench calls this method when it needs to, which may be never).

        For implementors this is a multi-step process:

        1. Create one or more controls within the parent.
        2. Set the parent layout as needed.
        3. Register any global actions with the site's IActionBars.
        4. Register any context menus with the site.
        5. Register a selection provider with the site, to make it available to the workbench's ISelectionService (optional).
        Specified by:
        createPartControl in interface IWorkbenchPart
        Specified by:
        createPartControl in class WorkbenchPart
        Parameters:
        parent - the parent control

      • getHelpContextId

        protected String getHelpContextId()
        Deprecated.
        Returns the help context id to use for this view.
        Since:
        2.0

      • initContextMenu

        protected void initContextMenu()
        Deprecated.
        Initializes and registers the context menu.
        Since:
        2.0

      • createViewer

        protected TreeViewer createViewer​(Composite parent)
        Deprecated.
        Creates the viewer.
        Parameters:
        parent - the parent composite
        Since:
        2.0

      • initContentProvider

        protected void initContentProvider​(TreeViewer viewer)
        Deprecated.
        Sets the content provider for the viewer.
        Parameters:
        viewer - the viewer
        Since:
        2.0

      • initLabelProvider

        protected void initLabelProvider​(TreeViewer viewer)
        Deprecated.
        Sets the label provider for the viewer.
        Parameters:
        viewer - the viewer
        Since:
        2.0

      • initFilters

        protected void initFilters​(TreeViewer viewer)
        Deprecated.
        Adds the filters to the viewer.
        Parameters:
        viewer - the viewer
        Since:
        2.0

      • initListeners

        protected void initListeners​(TreeViewer viewer)
        Deprecated.
        Adds the listeners to the viewer.
        Parameters:
        viewer - the viewer
        Since:
        2.0

      • dispose

        public void dispose()
        Deprecated.
        Description copied from class: WorkbenchPart
        The WorkbenchPart implementation of this IWorkbenchPart method disposes the title image loaded by setInitializationData. Subclasses may extend.
        Specified by:
        dispose in interface IWorkbenchPart
        Overrides:
        dispose in class WorkbenchPart

      • editorActivated

        protected void editorActivated​(IEditorPart editor)
        Deprecated.
        An editor has been activated. Sets the selection in this navigator to be the editor's input, if linking is enabled.
        Parameters:
        editor - the active editor
        Since:
        2.0

      • fillContextMenu

        protected void fillContextMenu​(IMenuManager menu)
        Deprecated.
        Called when the context menu is about to open. Delegates to the action group using the viewer's selection as the action context.
        Since:
        2.0

      • getInitialInput

        protected IAdaptable getInitialInput()
        Deprecated.
        Returns the initial input for the viewer. Tries to convert the page input to a resource, either directly or via IAdaptable. If the resource is a container, it uses that. If the resource is a file, it uses its parent folder. If a resource could not be obtained, it uses the workspace root.
        Since:
        2.0

      • getPlugin

        public AbstractUIPlugin getPlugin()
        Deprecated.
        Returns the navigator's plugin.
        Returns:
        the UI plugin for this bundle

      • getViewer

        public TreeViewer getViewer()
        Deprecated.
        Returns the resource viewer which shows the resource hierarchy.
        Specified by:
        getViewer in interface IResourceNavigator
        Returns:
        the resource navigator's tree viewer
        Since:
        2.0

      • getTreeViewer

        public TreeViewer getTreeViewer()
        Deprecated.
        Returns the tree viewer which shows the resource hierarchy.
        Returns:
        the tree viewer
        Since:
        2.0

      • getShell

        @Deprecated
public Shell getShell()
        Deprecated.
        use getViewSite().getShell()
        Returns the shell to use for opening dialogs. Used in this class, and in the actions.
        Returns:
        the shell

      • getStatusLineMessage

        protected String getStatusLineMessage​(IStructuredSelection selection)
        Deprecated.
        Returns the message to show in the status line.
        Parameters:
        selection - the current selection
        Returns:
        the status line message
        Since:
        2.0

      • handleOpen

        @Deprecated
protected void handleOpen​(OpenEvent event)
        Deprecated.
        As of 3.5, replaced by handleOpen(ISelection)
        Handles an open event from the viewer. Opens an editor on the selected file.
        Parameters:
        event - the open event
        Since:
        2.0

      • handleOpen

        protected void handleOpen​(ISelection selection)
        Deprecated.
        Handles an open event from the viewer. Opens an editor on the selected file.
        Parameters:
        selection - the selection
        Since:
        3.5

      • handleDoubleClick

        protected void handleDoubleClick​(DoubleClickEvent event)
        Deprecated.
        Handles a double-click event from the viewer. Expands or collapses a folder when double-clicked.
        Parameters:
        event - the double-click event
        Since:
        2.0

      • handleSelectionChanged

        protected void handleSelectionChanged​(SelectionChangedEvent event)
        Deprecated.
        Handles a selection changed event from the viewer. Updates the status line and the action bars, and links to editor (if option enabled).
        Parameters:
        event - the selection event
        Since:
        2.0

      • handleKeyPressed

        protected void handleKeyPressed​(KeyEvent event)
        Deprecated.
        Handles a key press event from the viewer. Delegates to the action group.
        Parameters:
        event - the key event
        Since:
        2.0

      • handleKeyReleased

        protected void handleKeyReleased​(KeyEvent event)
        Deprecated.
        Handles a key release in the viewer. Does nothing by default.
        Parameters:
        event - the key event
        Since:
        2.0

      • init

        public void init​(IViewSite site,
                 IMemento memento)
          throws PartInitException
        Deprecated.
        Description copied from interface: IViewPart
        Initializes this view with the given view site. A memento is passed to the view which contains a snapshot of the views state from a previous session. Where possible, the view should try to recreate that state within the part controls.

        This method is automatically called by the workbench shortly after the part is instantiated. It marks the start of the views's lifecycle. Clients must not call this method.

        Specified by:
        init in interface IViewPart
        Overrides:
        init in class ViewPart
        Parameters:
        site - the view site
        memento - the IViewPart state or null if there is no previous saved state
        Throws:
        PartInitException - if this view was not initialized successfully

      • initDragAndDrop

        protected void initDragAndDrop()
        Deprecated.
        Adds drag and drop support to the navigator.
        Since:
        2.0

      • createFrameList

        protected FrameList createFrameList()
        Deprecated.
        Creates the frame source and frame list, and connects them.
        Since:
        2.0

      • initResourceComparator

        protected void initResourceComparator()
        Deprecated.
        Initializes the comparator.
        Since:
        3.3

      • initWorkingSetFilter

        protected void initWorkingSetFilter()
        Deprecated.
        Restores the working set filter from the persistence store.

      • isLinkingEnabled

        public boolean isLinkingEnabled()
        Deprecated.
        Returns whether the navigator selection automatically tracks the active editor.
        Specified by:
        isLinkingEnabled in interface IResourceNavigator
        Returns:
        true if linking is enabled, false if not
        Since:
        2.0 (this was protected in 2.0, but was made public in 2.1)

      • linkToEditor

        protected void linkToEditor​(ISelection selection)
        Deprecated.
        Brings the corresponding editor to top if the selected resource is open.
        Since:
        3.5

      • makeActions

        protected void makeActions()
        Deprecated.
        Creates the action group, which encapsulates all actions for the view.

      • restoreState

        protected void restoreState​(IMemento memento)
        Deprecated.
        Restores the state of the receiver to the state described in the specified memento.
        Parameters:
        memento - the memento
        Since:
        2.0

      • selectReveal

        public void selectReveal​(ISelection selection)
        Deprecated.
        Selects and reveals the specified elements.
        Specified by:
        selectReveal in interface ISetSelectionTarget
        Parameters:
        selection - the new element to select

      • setFiltersPreference

        public void setFiltersPreference​(String[] patterns)
        Deprecated.
        Saves the filters defined as strings in patterns in the preference store.
        Specified by:
        setFiltersPreference in interface IResourceNavigator
        Parameters:
        patterns - filter patterns to use on contents of the resource navigator

      • setFocus

        public void setFocus()
        Deprecated.
        Description copied from interface: IWorkbenchPart
        Asks this part to take focus within the workbench. Parts must assign focus to one of the controls contained in the part's parent composite.

        Clients should not call this method (the workbench calls this method at appropriate times). To have the workbench activate a part, use IWorkbenchPage.activate(IWorkbenchPart) instead.

        Specified by:
        setFocus in interface IWorkbenchPart
        Specified by:
        setFocus in class WorkbenchPart
        See Also:
        IWorkbenchPart.setFocus()

      • setLabelDecorator

        @Deprecated
public void setLabelDecorator​(ILabelDecorator decorator)
        Deprecated.
        use the decorators extension point instead; see IWorkbench.getDecoratorManager()
        Note: For experimental use only. Sets the decorator for the navigator.

        As of 2.0, this method no longer has any effect.

        Parameters:
        decorator - a label decorator or null for no decorations.

      • setWorkingSet

        public void setWorkingSet​(IWorkingSet workingSet)
        Deprecated.
        Description copied from interface: IResourceNavigator
        Sets the working set for this view, or null to clear it.
        Specified by:
        setWorkingSet in interface IResourceNavigator
        Parameters:
        workingSet - the working set, or null to clear it

      • updateActionBars

        protected void updateActionBars​(IStructuredSelection selection)
        Deprecated.
        Updates the action bar actions.
        Parameters:
        selection - the current selection
        Since:
        2.0

      • updateStatusLine

        protected void updateStatusLine​(IStructuredSelection selection)
        Deprecated.
        Updates the message shown in the status line.
        Parameters:
        selection - the current selection

      • updateTitle

        public void updateTitle()
        Deprecated.
        Updates the title text and title tool tip. Called whenever the input of the viewer changes. Called whenever the input of the viewer changes.
        Since:
        2.0

      • setActionGroup

        protected void setActionGroup​(ResourceNavigatorActionGroup actionGroup)
        Deprecated.
        Sets the action group.
        Parameters:
        actionGroup - the action group

      • getAdapter

        public <T> T getAdapter​(Class<T> adapter)
        Deprecated.
        Description copied from class: WorkbenchPart
        Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

        Clients may implement this method but should generally call Adapters.adapt(Object, Class, boolean) rather than invoking it directly. Subclasses may override this method (however, if they do so, they should invoke the method on their superclass to ensure that the Platform's adapter manager is consulted).

        Specified by:
        getAdapter in interface IAdaptable
        Overrides:
        getAdapter in class WorkbenchPart
        Type Parameters:
        T - the class type
        Parameters:
        adapter - the adapter class to look up
        Returns:
        a object of the given class, or null if this object does not have an adapter for the given class

      • getShowInSource

        protected IShowInSource getShowInSource()
        Deprecated.
        Returns the IShowInSource for this view.

      • getShowInTarget

        protected IShowInTarget getShowInTarget()
        Deprecated.
        Returns the IShowInTarget for this view.

      • getSingleElement

        protected static final Object getSingleElement​(ISelection s)
        Deprecated.
        Returns the selected element if the selection consists of a single element only.
        Parameters:
        s - the selection
        Returns:
        the selected first element or null
        Since:
        3.5