KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > app > Column


1 /*
2  * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3  * Copyright (C) 2002-2005 NextApp, Inc.
4  *
5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6  *
7  * The contents of this file are subject to the Mozilla Public License Version
8  * 1.1 (the "License"); you may not use this file except in compliance with
9  * the License. You may obtain a copy of the License at
10  * http://www.mozilla.org/MPL/
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * Alternatively, the contents of this file may be used under the terms of
18  * either the GNU General Public License Version 2 or later (the "GPL"), or
19  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20  * in which case the provisions of the GPL or the LGPL are applicable instead
21  * of those above. If you wish to allow use of your version of this file only
22  * under the terms of either the GPL or the LGPL, and not to allow others to
23  * use your version of this file under the terms of the MPL, indicate your
24  * decision by deleting the provisions above and replace them with the notice
25  * and other provisions required by the GPL or the LGPL. If you do not delete
26  * the provisions above, a recipient may use your version of this file under
27  * the terms of any one of the MPL, the GPL or the LGPL.
28  */
29
30 package nextapp.echo2.app;
31
32 /**
33  * A layout <code>Component</code> which renders its contents in a single
34  * vertical column of cells.
35  * <p>
36  * <b>Child LayoutData</b>: Children of this component may provide
37  * layout information using the
38  * <code>nextapp.echo2.app.layout.ColumnLayoutData</code> layout data object.
39  *
40  * @see nextapp.echo2.app.layout.ColumnLayoutData
41  */
42 public class Column extends Component {
43     
44     public static final String JavaDoc PROPERTY_BORDER = "border";
45     public static final String JavaDoc PROPERTY_CELL_SPACING = "cellSpacing";
46     public static final String JavaDoc PROPERTY_INSETS = "insets";
47     
48     /**
49      * Creates a new <code>Column</code>.
50      */
51     public Column() {
52         super();
53     }
54     
55     /**
56      * Returns the <code>Border</code> that encloses the entire <code>Column</code>.
57      *
58      * @return the border
59      */
60     public Border getBorder() {
61         return (Border) getProperty(PROPERTY_BORDER);
62     }
63     
64     /**
65      * Returns the spacing between individual cells of the <code>Column</code>.
66      * This property only supports <code>Extent</code>s with
67      * fixed (i.e., not percent) units.
68      *
69      * @return the cell spacing
70      */
71     public Extent getCellSpacing() {
72         return (Extent) getProperty(PROPERTY_CELL_SPACING);
73     }
74     
75     /**
76      * Returns the default inset between the border and cells of the
77      * <code>Column</code>. This value will be overridden for a child
78      * component if a setting is specified in its <code>ColumnLayoutData</code>.
79      *
80      * @return the inset
81      */
82     public Insets getInsets() {
83         return (Insets) getProperty(PROPERTY_INSETS);
84     }
85     
86      /**
87      * Sets the <code>Border</code> that encloses the entire <code>Column</code>.
88      *
89      * @param newValue the new border
90      */
91     public void setBorder(Border newValue) {
92         setProperty(PROPERTY_BORDER, newValue);
93     }
94     
95     /**
96      * Sets the spacing between individual cells of the <code>Column</code>.
97      * This property only supports <code>Extent</code>s with
98      * fixed (i.e., not percent) units.
99      *
100      * @param newValue the new spacing
101      */
102     public void setCellSpacing(Extent newValue) {
103         setProperty(PROPERTY_CELL_SPACING, newValue);
104     }
105     
106     /**
107      * Sets the inset between the border and cells of the <code>Column</code>.
108      * This value will be overridden for a child component if a setting is
109      * specified in its <code>ColumnLayoutData</code>.
110      *
111      * @param newValue the new inset
112      */
113     public void setInsets(Insets newValue) {
114         setProperty(PROPERTY_INSETS, newValue);
115     }
116 }
117
Popular Tags