01: /*******************************************************************************
02: * Copyright (c) 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: ******************************************************************************/package org.eclipse.ui.navigator;
11:
12: /**
13: * Provides information about a <b>commonFilter</b> extension.
14: *
15: * <p>
16: * This interface is not intended to be implemented by clients.
17: * </p>
18: *
19: * @since 3.2
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: }
|