KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > tasklist > usertasks > UserTaskViewListener


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.usertasks;
21
22 import org.openide.text.Annotation;
23 import org.netbeans.modules.tasklist.usertasks.model.UserTask;
24
25
26 /**
27  * Listener which when notified off changes in current task
28  * updates in all views. Registations are done using default lookup.
29  * <p>
30  * For editor only selection use
31  * {@link TaskListView#showTaskInEditor} aad {@link TaskListView#hideTaskInEditor}
32  *
33  * @author Tor Norbye
34  */
35 public interface UserTaskViewListener {
36     /**
37      * Called to indicate that a particular task is made current.
38      * Do what you can to "select" this task.
39      * @param task The task to be shown
40      * @param annotation Annotation to be used to show the task, or
41      * null to use the default
42      */
43     void showTask(UserTask task, Annotation annotation);
44
45     /**
46      * Called to indicate that a particular task should be hidden.
47      * This typically means that the task was deleted so it should
48      * no longer have any visual cues. The task referred to is the
49      * most recent task passed to showTask.
50      * NOTE: hideTaskInEditor is NOT called before every new call to showTask.
51      * If your task viewer implements a "singleton" marker, you'll
52      * want to call hideTask yourself before showing the new marker.
53      */
54     void hideTask();
55 }
56
Popular Tags