KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > tasklist > core > TaskViewListener


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.tasklist.core;
21
22 import org.openide.text.Annotation;
23
24
25 /**
26  * Listener which when notified off changes in current task
27  * updates in all views. Registations are done using default lookup.
28  * <p>
29  * For editor only selection use
30  * {@link TaskListView#showTaskInEditor} aad {@link TaskListView#hideTaskInEditor}
31  *
32  * @author Tor Norbye
33  *
34  * @todo Instead of having showTask, hideTask, consider generalizing
35  * this to communicating the current selection. Obviously
36  * deleting a task will cause it to be unselected. Single-click
37  * vs. double click issue.
38  */
39 public interface TaskViewListener {
40
41     /** Called to indicate that a particular task is made current.
42      * Do what you can to "select" this task.
43      * @param task The task to be shown
44      * @param annotation Annotation to be used to show the task, or
45      * null to use the default
46      */
47     void showTask(Task task, Annotation annotation);
48
49     /** Called to indicate that a particular task should be hidden.
50     This typically means that the task was deleted so it should
51     no longer have any visual cues. The task referred to is the
52     most recent task passed to showTask.
53         NOTE: hideTaskInEditor is NOT called before every new call to showTask.
54         If your task viewer implements a "singleton" marker, you'll
55         want to call hideTask yourself before showing the new marker.
56     */
57     void hideTask();
58 }
59
Popular Tags