KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > aspectj > ajde > ui > StructureViewRenderer


1 /* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2  *
3  * This file is part of the IDE support for the AspectJ(tm)
4  * programming language; see http://aspectj.org
5  *
6  * The contents of this file are subject to the Mozilla Public License
7  * Version 1.1 (the "License"); you may not use this file except in
8  * compliance with the License. You may obtain a copy of the License at
9  * either http://www.mozilla.org/MPL/ or http://aspectj.org/MPL/.
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the
14  * License.
15  *
16  * The Original Code is AspectJ.
17  *
18  * The Initial Developer of the Original Code is Xerox Corporation. Portions
19  * created by Xerox Corporation are Copyright (C) 1999-2002 Xerox Corporation.
20  * All Rights Reserved.
21  *
22  * Contributor(s):
23  */
24
25 package org.aspectj.ajde.ui;
26
27 import java.util.EventListener JavaDoc;
28
29 /**
30  * View renderers get notified of structure view update events and should
31  * update the display of the structure view accordingly.
32  *
33  * @author Mik Kersten
34  */
35 public interface StructureViewRenderer extends EventListener JavaDoc {
36
37     /**
38      * Implementors should updated the display of the corresponding
39      * file structure view.
40      */
41     public void updateView(StructureView structureView);
42     
43     /**
44      * Highlights and selects the given node as active. What "active"
45      * means depends on the renderer: a typical activation should cause
46      * the corresponding node's sourceline to be highlighted in the
47      * active editor.
48      */
49     public void setActiveNode(StructureViewNode node);
50     
51     /**
52      * Same behavior as <CODE>setActiveNode(StructureViewNode)</CODE> but
53      * highlights a particular line within the span of the node.
54      *
55      * @param lineOffset number of lines after the begin and before the
56      * end line of the corresponding <CODE>StructureNode</CODE>.
57      */
58     public void setActiveNode(StructureViewNode activeNode, int lineOffset);
59 }
60
Popular Tags