ICommonFilterDescriptor


1   /*******************************************************************************
2    * Copyright (c) 2006 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   * <p>
18   * This interface is not intended to be implemented by clients.
19   * </p>
20   * 
21   * @since 3.2
22   * 
23   */
24  public interface ICommonFilterDescriptor {
25      
26      /**
27       * 
28       * @return An identifier used to determine whether the filter is visible.
29       * 
30       */
31      String   getId();
32  
33      /**
34       * 
35       * @return A translated name to identify the filter
36       */
37      String   getName();
38  
39      /**
40       * 
41       * @return A translated description to explain to the user what the defined
42       *         filter will hide from the view.
43       */
44      String   getDescription();
45  
46      /**
47       * 
48       * @return Indicates the filter should be in an "Active" state by default.
49       */
50      boolean isActiveByDefault();
51  }
52

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags