com.expressui.core.view.form.layout.TopLabelGridLayout.java Source code

Introduction

Here is the source code for com.expressui.core.view.form.layout.TopLabelGridLayout.java

Source

/*
 * Copyright (c) 2012 Brown Bag Consulting.
 * This file is part of the ExpressUI project.
 * Author: Juan Osuna
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License Version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * Brown Bag Consulting, Brown Bag Consulting DISCLAIMS THE WARRANTY OF
 * NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the ExpressUI software without
 * disclosing the source code of your own applications. These activities
 * include: offering paid services to customers as an ASP, providing
 * services from a web application, shipping ExpressUI with a closed
 * source product.
 *
 * For more information, please contact Brown Bag Consulting at this
 * address: juan@brownbagconsulting.com.
 */

package com.expressui.core.view.form.layout;

import com.expressui.core.util.StringUtil;
import com.expressui.core.view.field.FormField;
import com.vaadin.terminal.Sizeable;
import com.vaadin.ui.Field;
import com.vaadin.ui.VerticalLayout;

/**
 * Form grid layout that places labels on top of the fields.
 */
public class TopLabelGridLayout extends FormGridLayout {

    /**
     * Constructs layout with given number of columns and rows, from ExpressUI perspective.
     *
     * @param columns number of columns
     * @param rows    number of rows
     */
    public TopLabelGridLayout(int columns, int rows) {
        super(columns, rows);
    }

    @Override
    public void setFormColumns(int columns) {
        setColumns(columns);
    }

    @Override
    public void addField(FormField formField) {
        VerticalLayout fieldLayout = (VerticalLayout) getComponent(formField.getColumnStart() - 1,
                formField.getRowStart() - 1);
        if (fieldLayout == null) {
            addFieldImpl(formField);
        } else {
            Field field = formField.getField();
            fieldLayout.addComponent(field);
        }
    }

    private void addFieldImpl(FormField formField) {
        VerticalLayout fieldLayout = new VerticalLayout();
        fieldLayout.setWidth(SIZE_UNDEFINED, Sizeable.UNITS_PERCENTAGE);
        String id = StringUtil.generateDebugId("e", this, fieldLayout, "fieldLayout");
        fieldLayout.setDebugId(id);
        fieldLayout.addComponent(formField.getFieldLabel());
        fieldLayout.addComponent(formField.getField());
        if (formField.getColumnEnd() != null && formField.getRowEnd() != null) {
            addComponent(fieldLayout, formField.getColumnStart() - 1, formField.getRowStart() - 1,
                    formField.getColumnEnd() - 1, formField.getRowEnd() - 1);
        } else {
            addComponent(fieldLayout, formField.getColumnStart() - 1, formField.getRowStart() - 1);
        }
    }

    @Override
    public void removeField(FormField formField) {
        removeComponent(formField.getColumnStart() - 1, formField.getRowStart() - 1);
    }
}