KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > xam > ui > cookies > ViewComponentCookie


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-2007 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.xml.xam.ui.cookies;
21
22 import org.netbeans.modules.xml.xam.Component;
23 import org.openide.nodes.Node;
24
25 /**
26  * ViewComponentCookie displays a xam component in a view, opening the
27  * editor as necessary, and switching to the desired view, then
28  * scrolling to or otherwise showing the component.
29  *
30  * @author Ajit Bhate
31  * @author Todd Fast, todd.fast@sun.com
32  * @author Nathan Fiedler
33  */
34 public interface ViewComponentCookie extends Node.Cookie {
35
36     /**
37      * Indicates a type of view.
38      */
39     public enum View {
40         /** Source "textual" view */
41         SOURCE,
42         /** Tree/column "structural" view */
43         STRUCTURE,
44         /** Schema/WSDL "design" view */
45         DESIGN,
46         /** Super-type "view" */
47         SUPER,
48         /** The currently showing view */
49         CURRENT,
50     }
51
52     /**
53      * Show the xam component in one view or another.
54      *
55      * @param view the view to be used.
56      * @param component the xam component to show.
57      * @param parameters the optional parameters for the viewer.
58      */
59     public void view(View view, Component component, Object JavaDoc... parameters);
60
61     /**
62      * Determines if referenced xam component can be view in given view.
63      *
64      * @param view the view to be used.
65      * @return true if referenced component can be viewed, false otherwise.
66      */
67     public boolean canView(View view, Component component);
68 }
69
Popular Tags