nextapp.echo.app.Column Maven / Gradle / Ivy
/*
* This file is part of the Echo Web Application Framework (hereinafter "Echo").
* Copyright (C) 2002-2009 NextApp, Inc.
*
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*/
package nextapp.echo.app;
/**
* Column component: a layout container which renders its content in a single vertical column of cells.
* May have zero or more child components. Does not support Pane components as children.
*
* Child LayoutData: Children of this component may provide
* layout information using the
* nextapp.echo.app.layout.ColumnLayoutData layout data object.
*
* @see nextapp.echo.app.layout.ColumnLayoutData
*/
public class Column extends Component {
/** Serial Version UID. */
private static final long serialVersionUID = 20070101L;
public static final String PROPERTY_BORDER = "border";
public static final String PROPERTY_CELL_SPACING = "cellSpacing";
public static final String PROPERTY_INSETS = "insets";
/**
* Creates a new Column.
*/
public Column() {
super();
}
/**
* Returns the Border that encloses the entire Column.
*
* @return the border
*/
public Border getBorder() {
return (Border) get(PROPERTY_BORDER);
}
/**
* Returns the spacing between individual cells of the Column.
* This property only supports Extents with
* fixed (i.e., not percent) units.
*
* @return the cell spacing
*/
public Extent getCellSpacing() {
return (Extent) get(PROPERTY_CELL_SPACING);
}
/**
* Returns the default inset between the border and cells of the
* Column. This value will be overridden for a child
* component if a setting is specified in its ColumnLayoutData.
*
* @return the inset
*/
public Insets getInsets() {
return (Insets) get(PROPERTY_INSETS);
}
/**
* Sets the Border that encloses the entire Column.
*
* @param newValue the new border
*/
public void setBorder(Border newValue) {
set(PROPERTY_BORDER, newValue);
}
/**
* Sets the spacing between individual cells of the Column.
* This property only supports Extents with
* fixed (i.e., not percent) units.
*
* @param newValue the new spacing
*/
public void setCellSpacing(Extent newValue) {
set(PROPERTY_CELL_SPACING, newValue);
}
/**
* Sets the inset between the border and cells of the Column.
* This value will be overridden for a child component if a setting is
* specified in its ColumnLayoutData.
*
* @param newValue the new inset
*/
public void setInsets(Insets newValue) {
set(PROPERTY_INSETS, newValue);
}
}