KickJava   Java API By Example, From Geeks To Geeks.

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


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  * horizontal row 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.RowLayoutData</code> layout data object.
39  *
40  * @see nextapp.echo2.app.layout.RowLayoutData
41  */
42 public class Row extends Component {
43     
44     public static final String JavaDoc PROPERTY_ALIGNMENT = "alignment";
45     public static final String JavaDoc PROPERTY_BORDER = "border";
46     public static final String JavaDoc PROPERTY_CELL_SPACING = "cellSpacing";
47     public static final String JavaDoc PROPERTY_INSETS = "insets";
48     
49     /**
50      * Creates a new <code>Row</code>.
51      */
52     public Row() {
53         super();
54     }
55
56     /**
57      * Returns the alignment of the row's content.
58      * Only horizontal alignments are supported.
59      *
60      * @return the alignment
61      */
62     public Alignment getAlignment() {
63         return (Alignment) getProperty(PROPERTY_ALIGNMENT);
64     }
65
66     /**
67      * Returns the <code>Border</code> that encloses the entire <code>Column</code>.
68      *
69      * @return the border
70      */
71     public Border getBorder() {
72         return (Border) getProperty(PROPERTY_BORDER);
73     }
74     
75     /**
76      * Returns the spacing between individual cells of the <code>Column</code>.
77      * This property only supports <code>Extent</code>s with
78      * fixed (i.e., not percent) units.
79      *
80      * @return the cell spacing
81      */
82     public Extent getCellSpacing() {
83         return (Extent) getProperty(PROPERTY_CELL_SPACING);
84     }
85     
86     /**
87      * Returns the inset between the border and cells of the <code>Column</code>.
88      *
89      * @return the inset
90      */
91     public Insets getInsets() {
92         return (Insets) getProperty(PROPERTY_INSETS);
93     }
94
95     /**
96      * Sets the alignment of the row's content.
97      * Only horizontal alignments are supported.
98      *
99      * @param newValue the new alignment
100      */
101     public void setAlignment(Alignment newValue) {
102         setProperty(PROPERTY_ALIGNMENT, newValue);
103     }
104     
105     /**
106      * Sets the <code>Border</code> that encloses the entire <code>Column</code>.
107      *
108      * @param newValue the new border
109      */
110     public void setBorder(Border newValue) {
111         setProperty(PROPERTY_BORDER, newValue);
112     }
113     
114     /**
115      * Sets the spacing between individual cells of the <code>Column</code>.
116      * This property only supports <code>Extent</code>s with
117      * fixed (i.e., not percent) units.
118      *
119      * @param newValue the new spacing
120      */
121     public void setCellSpacing(Extent newValue) {
122         setProperty(PROPERTY_CELL_SPACING, newValue);
123     }
124     
125     /**
126      * Sets the inset between the border and cells of the <code>Column</code>.
127      *
128      * @param newValue the new inset
129      */
130     public void setInsets(Insets newValue) {
131         setProperty(PROPERTY_INSETS, newValue);
132     }
133 }
134
Popular Tags