KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > editor > view > spi > ViewUtilities


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.editor.view.spi;
21
22 import javax.swing.text.Element JavaDoc;
23 import javax.swing.text.View JavaDoc;
24 import org.netbeans.lib.editor.view.ViewUtilitiesImpl;
25
26 /**
27  * Various utility methods related to views.
28  *
29  * @author Miloslav Metelka
30  * @version 1.00
31  */
32
33 public class ViewUtilities {
34
35     private ViewUtilities() {
36     }
37
38
39     /**
40      * Create view that will cover the whole document.
41      */
42     public static View JavaDoc createDocumentView(Element JavaDoc elem) {
43         return new org.netbeans.lib.editor.view.GapDocumentView(elem);
44     }
45
46     /**
47      * Check correctness of the hierarchy under the given view.
48      * <br>
49      * Current checks:
50      * <ul>
51      * <li>
52      * Children are Parents are checked to have correct parent info.
53      * </ul>
54      */
55     public static void checkViewHierarchy(View JavaDoc v) {
56         ViewUtilitiesImpl.checkViewHierarchy(v);
57     }
58
59     /**
60      * Test whether the axis is valid.
61      *
62      * @param axis integer axis
63      * @return true if the axis is either <code>View.X_AXIS</code>
64      * or <code>View.Y_AXIS</code>. False is returned otherwise.
65      */
66     public static boolean isAxisValid(int axis) {
67         switch (axis) {
68             case View.X_AXIS:
69             case View.Y_AXIS:
70                 return true;
71         }
72         
73         return false;
74     }
75
76 }
77
Popular Tags