← Back to branch summary

~ubuntu-branches/ubuntu/utopic/eclipse-eclox/utopic

« back to all changes in this revision

Viewing changes to eclox.ui/src/eclox/ui/editor/advanced/filters/IFilter.java

  • Committer: Package Import Robot
  • Author(s): Graham Inggs
  • Date: 2013-07-07 20:33:10 UTC
  • Revision ID: package-import@ubuntu.com-20130707203310-a44yw80gqtc2s9ob
Tags: upstream-0.10.0
Import upstream version 0.10.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
eclox.ui/src/eclox/ui/editor/advanced/filters/IFilter.java
 
1
/*******************************************************************************
 
2
 * Copyright (C) 2003-2005, 2013 Guillaume Brocker
 
3
 * 
 
4
 * All rights reserved. This program and the accompanying materials
 
5
 * are made available under the terms of the Eclipse Public License v1.0
 
6
 * which accompanies this distribution, and is available at
 
7
 * http://www.eclipse.org/legal/epl-v10.html
 
8
 *
 
9
 * Contributors:
 
10
 *     Guillaume Brocker - Initial API and implementation
 
11
 *
 
12
 ******************************************************************************/ 
 
13
 
 
14
package eclox.ui.editor.advanced.filters;
 
15
 
 
16
import org.eclipse.jface.viewers.StructuredViewer;
 
17
import org.eclipse.swt.widgets.Composite;
 
18
import org.eclipse.ui.forms.IManagedForm;
 
19
 
 
20
import eclox.core.doxyfiles.Doxyfile;
 
21
 
 
22
/**
 
23
 * Defines the interface for setting filters.
 
24
 * 
 
25
 * @author gbrocker
 
26
 */
 
27
public interface IFilter {
 
28
        
 
29
        /**
 
30
         * Tells the filter which doxyfile is to filter.
 
31
         * 
 
32
         * @param       doxyfile        a doxyfile instance
 
33
         */
 
34
        void setDoxyfile( Doxyfile doxyfile );
 
35
 
 
36
    /**
 
37
     * Asks the filter to create its user interface controls.
 
38
     * 
 
39
     * @param   managedForm a managed form to use for the widget creation
 
40
     * @param   parent      a composite being the parent of all widgets
 
41
     */
 
42
    void createControls( IManagedForm managedForm, Composite parent );
 
43
    
 
44
    /**
 
45
     * Asks the filter to create viewer filter and add them in a given viewer
 
46
     * 
 
47
     * @param   viewer  a viewer where filter must be added
 
48
     */
 
49
    void createViewerFilters( StructuredViewer viewer );
 
50
    
 
51
    /**
 
52
     * Asks the filter to dispose its controls.
 
53
     */
 
54
    void disposeControls();
 
55
    
 
56
    /**
 
57
     * Asks the filter to dispose created viewer filter given a viewer
 
58
     * 
 
59
     * @param   viewer  a structured view from which created viewer filter must be removed
 
60
     */
 
61
    void disposeViewerFilers( StructuredViewer viewer );
 
62
    
 
63
    /**
 
64
     * Retrieves the filter name.
 
65
     * 
 
66
     * This name must by human readable sinci it is used in the graphical
 
67
     * user interface.
 
68
     * 
 
69
     * @return  a string containing the filter name
 
70
     */
 
71
    String getName();
 
72
}