Eclipse Platform
Release 3.2

org.eclipse.ui.navigator
Interface INavigatorContentDescriptor


public interface INavigatorContentDescriptor

The descriptor provides a handle to a content extension. Information such as the Id, the name, the priority, and whether the descriptor provides one or more root elements is provided.

There is one INavigatorContentExtension for each content service. There is only one INavigatorContentDescriptor for each extension.

This interface is not intended to be implemented by clients.

Since:
3.2

Method Summary
 boolean arePossibleChildren(IStructuredSelection aSelection)
          A convenience method to check all elements in a selection.
 String getId()
          Returns the navgiator content extension id
 String getName()
          Returns the name of this navigator extension
 INavigatorContentDescriptor getOverriddenDescriptor()
           
 Set getOverriddingExtensions()
           
 org.eclipse.ui.internal.navigator.extensions.OverridePolicy getOverridePolicy()
           
 int getPriority()
          Returns the priority of the navigator content extension.
 String getSuppressedExtensionId()
           
 boolean hasOverridingExtensions()
          Does not force the creation of the set of overriding extensions.
 boolean hasSaveablesProvider()
           
 boolean isActiveByDefault()
          The enabledByDefault attribute specifies whether an extension should be activated in the context of a viewer automatically.
 boolean isPossibleChild(Object anElement)
          Determine if this content extension could provide the given element as a child.
 boolean isTriggerPoint(Object anElement)
          Determine if this content extension is enabled for the given element.
 

Method Detail

getId

public String getId()
Returns the navgiator content extension id

Returns:
the navgiator content extension id

getName

public String getName()
Returns the name of this navigator extension

Returns:
the name of this navigator extension

getPriority

public int getPriority()
Returns the priority of the navigator content extension.

Returns:
the priority of the navigator content extension. Returns 0 (zero) if no priority was specified.

isActiveByDefault

public boolean isActiveByDefault()
The enabledByDefault attribute specifies whether an extension should be activated in the context of a viewer automatically. Users may override this setting through the "Types of Content" dialog.

Returns:
true if the extension is enabled by default.

isTriggerPoint

public boolean isTriggerPoint(Object anElement)
Determine if this content extension is enabled for the given element.

Parameters:
anElement - The element that should be used for the evaluation.
Returns:
True if and only if the extension is enabled for the element.

isPossibleChild

public boolean isPossibleChild(Object anElement)
Determine if this content extension could provide the given element as a child.

This method is used to determine what the parent of an element could be for Link with Editor support.

Parameters:
anElement - The element that should be used for the evaluation.
Returns:
True if and only if the extension might provide an object of this type as a child.

arePossibleChildren

public boolean arePossibleChildren(IStructuredSelection aSelection)
A convenience method to check all elements in a selection.

Parameters:
aSelection - A non-null selection
Returns:
True if and only if every element in the selection is a possible child.

getSuppressedExtensionId

public String getSuppressedExtensionId()
Returns:
Returns the suppressedExtensionId or null if none specified.

getOverridePolicy

public org.eclipse.ui.internal.navigator.extensions.OverridePolicy getOverridePolicy()
Returns:
Returns the overridePolicy or null if this extension does not override another extension.

getOverriddenDescriptor

public INavigatorContentDescriptor getOverriddenDescriptor()
Returns:
The descriptor of the suppressedExtensionId if non-null.

hasOverridingExtensions

public boolean hasOverridingExtensions()
Does not force the creation of the set of overriding extensions.

Returns:
True if this extension has overridding extensions.

getOverriddingExtensions

public Set getOverriddingExtensions()
Returns:
The set of overridding extensions (of type INavigatorContentDescriptor

hasSaveablesProvider

public boolean hasSaveablesProvider()
Returns:
true if the extension's content provider may adapt to a SaveablesProvider.

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.