001: /*
002: * This file is part of the Echo Web Application Framework (hereinafter "Echo").
003: * Copyright (C) 2002-2005 NextApp, Inc.
004: *
005: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
006: *
007: * The contents of this file are subject to the Mozilla Public License Version
008: * 1.1 (the "License"); you may not use this file except in compliance with
009: * the License. You may obtain a copy of the License at
010: * http://www.mozilla.org/MPL/
011: *
012: * Software distributed under the License is distributed on an "AS IS" basis,
013: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
014: * for the specific language governing rights and limitations under the
015: * License.
016: *
017: * Alternatively, the contents of this file may be used under the terms of
018: * either the GNU General Public License Version 2 or later (the "GPL"), or
019: * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
020: * in which case the provisions of the GPL or the LGPL are applicable instead
021: * of those above. If you wish to allow use of your version of this file only
022: * under the terms of either the GPL or the LGPL, and not to allow others to
023: * use your version of this file under the terms of the MPL, indicate your
024: * decision by deleting the provisions above and replace them with the notice
025: * and other provisions required by the GPL or the LGPL. If you do not delete
026: * the provisions above, a recipient may use your version of this file under
027: * the terms of any one of the MPL, the GPL or the LGPL.
028: */
029:
030: package nextapp.echo2.app;
031:
032: /**
033: * A layout <code>Component</code> which renders its contents in a single
034: * vertical column of cells.
035: * <p>
036: * <b>Child LayoutData</b>: Children of this component may provide
037: * layout information using the
038: * <code>nextapp.echo2.app.layout.ColumnLayoutData</code> layout data object.
039: *
040: * @see nextapp.echo2.app.layout.ColumnLayoutData
041: */
042: public class Column extends Component {
043:
044: public static final String PROPERTY_BORDER = "border";
045: public static final String PROPERTY_CELL_SPACING = "cellSpacing";
046: public static final String PROPERTY_INSETS = "insets";
047:
048: /**
049: * Creates a new <code>Column</code>.
050: */
051: public Column() {
052: super ();
053: }
054:
055: /**
056: * Returns the <code>Border</code> that encloses the entire <code>Column</code>.
057: *
058: * @return the border
059: */
060: public Border getBorder() {
061: return (Border) getProperty(PROPERTY_BORDER);
062: }
063:
064: /**
065: * Returns the spacing between individual cells of the <code>Column</code>.
066: * This property only supports <code>Extent</code>s with
067: * fixed (i.e., not percent) units.
068: *
069: * @return the cell spacing
070: */
071: public Extent getCellSpacing() {
072: return (Extent) getProperty(PROPERTY_CELL_SPACING);
073: }
074:
075: /**
076: * Returns the default inset between the border and cells of the
077: * <code>Column</code>. This value will be overridden for a child
078: * component if a setting is specified in its <code>ColumnLayoutData</code>.
079: *
080: * @return the inset
081: */
082: public Insets getInsets() {
083: return (Insets) getProperty(PROPERTY_INSETS);
084: }
085:
086: /**
087: * Sets the <code>Border</code> that encloses the entire <code>Column</code>.
088: *
089: * @param newValue the new border
090: */
091: public void setBorder(Border newValue) {
092: setProperty(PROPERTY_BORDER, newValue);
093: }
094:
095: /**
096: * Sets the spacing between individual cells of the <code>Column</code>.
097: * This property only supports <code>Extent</code>s with
098: * fixed (i.e., not percent) units.
099: *
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: }
|