org.eclipse.ui.navigator

Interface ICommonFilterDescriptor

public interface ICommonFilterDescriptor

Provides information about a commonFilter extension.

Since:

3.2

Restriction:

This interface is not intended to be implemented by clients.

Restriction:

This interface is not intended to be extended by clients.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.lang.String	getId()
java.lang.String	getName()
boolean	isActiveByDefault()

Method Detail

getId

java.lang.String getId()

Returns:

An identifier used to determine whether the filter is visible.

getName

java.lang.String getName()

Returns:

A translated name to identify the filter

getDescription

java.lang.String getDescription()

Returns:

A translated description to explain to the user what the defined filter will hide from the view.

isActiveByDefault

boolean isActiveByDefault()

Returns:

Indicates the filter should be in an "Active" state by default.