|
1
|
/*******************************************************************************
|
|
2
|
* Copyright (c) 2006, 2009 IBM Corporation and others.
|
|
3
|
* All rights reserved. This program and the accompanying materials
|
|
4
|
* are made available under the terms of the Eclipse Public License v1.0
|
|
5
|
* which accompanies this distribution, and is available at
|
|
6
|
* http://www.eclipse.org/legal/epl-v10.html
|
|
7
|
*
|
|
8
|
* Contributors:
|
|
9
|
* IBM Corporation - initial API and implementation
|
|
10
|
******************************************************************************/
|
|
11
|
|
|
12
|
package org.eclipse.ui.navigator;
|
|
13
|
|
|
14
|
/**
|
|
15
|
* Provides information about a <b>commonFilter</b> extension.
|
|
16
|
*
|
|
17
|
* @since 3.2
|
|
18
|
* @noextend This interface is not intended to be extended by clients.
|
|
19
|
* @noimplement This interface is not intended to be implemented by clients.
|
|
20
|
*
|
|
21
|
*/
|
|
22
|
public interface ICommonFilterDescriptor {
|
|
23
|
|
|
24
|
/**
|
|
25
|
*
|
|
26
|
* @return An identifier used to determine whether the filter is visible.
|
|
27
|
*
|
|
28
|
*/
|
|
29
|
String getId();
|
|
30
|
|
|
31
|
/**
|
|
32
|
*
|
|
33
|
* @return A translated name to identify the filter
|
|
34
|
*/
|
|
35
|
String getName();
|
|
36
|
|
|
37
|
/**
|
|
38
|
*
|
|
39
|
* @return A translated description to explain to the user what the defined
|
|
40
|
* filter will hide from the view.
|
|
41
|
*/
|
|
42
|
String getDescription();
|
|
43
|
|
|
44
|
/**
|
|
45
|
*
|
|
46
|
* @return Indicates the filter should be in an "Active" state by default.
|
|
47
|
*/
|
|
48
|
boolean isActiveByDefault();
|
|
49
|
}
|