com.mycollab.vaadin.web.ui.grid.GridFormLayoutHelper.java Source code

Introduction

Here is the source code for com.mycollab.vaadin.web.ui.grid.GridFormLayoutHelper.java

Source

/**
 * This file is part of mycollab-web.
 *
 * mycollab-web is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * mycollab-web 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with mycollab-web.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.mycollab.vaadin.web.ui.grid;

import com.mycollab.vaadin.ui.ELabel;
import com.mycollab.vaadin.ui.UIConstants;
import com.mycollab.vaadin.web.ui.WebThemes;
import com.vaadin.server.FontAwesome;
import com.vaadin.shared.ui.label.ContentMode;
import com.vaadin.ui.Alignment;
import com.vaadin.ui.Component;
import com.vaadin.ui.GridLayout;
import org.apache.commons.lang3.StringUtils;
import org.vaadin.viritin.layouts.MHorizontalLayout;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

/**
 * @author MyCollab Ltd.
 * @since 1.0
 */
public class GridFormLayoutHelper implements Serializable {
    private static final long serialVersionUID = 1L;
    private final GridLayout layout;

    private String fieldControlWidth;
    private String defaultCaptionWidth;
    private final Alignment captionAlignment;

    private Map<String, GridCellWrapper> fieldCaptionMappings = new HashMap<>();

    public GridFormLayoutHelper(int columns, int rows, String fieldControlWidth, String defaultCaptionWidth,
            Alignment captionAlignment) {
        this.fieldControlWidth = fieldControlWidth;
        this.defaultCaptionWidth = defaultCaptionWidth;
        this.captionAlignment = captionAlignment;

        layout = new GridLayout(2 * columns, rows);
        layout.setMargin(false);
        layout.setSpacing(false);
        layout.setRowExpandRatio(0, 0);
    }

    public static GridFormLayoutHelper defaultFormLayoutHelper(int columns, int rows) {
        return defaultFormLayoutHelper(columns, rows, "167px");
    }

    public static GridFormLayoutHelper defaultFormLayoutHelper(int columns, int rows, String controlWidth) {
        GridFormLayoutHelper helper = new GridFormLayoutHelper(columns, rows, "100%", controlWidth,
                Alignment.TOP_LEFT);
        helper.getLayout().setWidth("100%");
        helper.getLayout().setSpacing(false);
        helper.getLayout().setMargin(false);
        helper.getLayout().addStyleName(WebThemes.GRIDFORM_STANDARD);
        return helper;
    }

    public GridFormLayoutHelper withCaptionWidth(String width) {
        this.defaultCaptionWidth = width;
        return this;
    }

    public void appendRow() {
        layout.setRows(layout.getRows() + 1);
    }

    public int getRows() {
        return layout.getRows();
    }

    public <T extends Component> T addComponent(T field, String caption, int columns, int rows, int colSpan,
            String width) {
        return this.addComponent(field, caption, null, columns, rows, colSpan, width, captionAlignment);
    }

    public <T extends Component> T addComponent(T field, String caption, String contextHelp, int columns, int rows,
            int colSpan, String width) {
        return this.addComponent(field, caption, contextHelp, columns, rows, colSpan, width, captionAlignment);
    }

    public <T extends Component> T addComponent(T field, String caption, int columns, int rows) {
        return this.addComponent(field, caption, null, columns, rows, 1, fieldControlWidth, captionAlignment);
    }

    public <T extends Component> T addComponent(T field, String caption, String contextHelp, int columns,
            int rows) {
        return this.addComponent(field, caption, contextHelp, columns, rows, 1, fieldControlWidth,
                captionAlignment);
    }

    private <T extends Component> T addComponent(T field, String caption, String contextHelp, int columns, int rows,
            int colSpan, String width, Alignment alignment) {
        GridCellWrapper cell = buildCell(caption, contextHelp, columns, rows, colSpan, width, alignment);
        cell.addComponent(field);
        return field;
    }

    public GridCellWrapper buildCell(String caption, String contextHelp, int columns, int rows) {
        return buildCell(caption, contextHelp, columns, rows, 1, fieldControlWidth, captionAlignment);
    }

    public GridCellWrapper buildCell(String caption, String contextHelp, int columns, int rows, int colSpan,
            String width, Alignment alignment) {
        if (StringUtils.isNotBlank(caption)) {
            ELabel captionLbl = new ELabel(caption).withStyleName(UIConstants.LABEL_WORD_WRAP)
                    .withDescription(caption);
            MHorizontalLayout captionWrapper = new MHorizontalLayout().withSpacing(false).withMargin(true)
                    .withWidth(defaultCaptionWidth).withFullHeight().withStyleName("gridform-caption")
                    .with(captionLbl).expand(captionLbl).withAlign(captionLbl, alignment);
            if (StringUtils.isNotBlank(contextHelp)) {
                ELabel contextHelpLbl = new ELabel("&nbsp;" + FontAwesome.QUESTION_CIRCLE.getHtml(),
                        ContentMode.HTML).withStyleName(WebThemes.INLINE_HELP).withDescription(contextHelp)
                                .withWidthUndefined();
                captionWrapper.with(contextHelpLbl);
            }
            layout.addComponent(captionWrapper, 2 * columns, rows);
        }
        GridCellWrapper fieldWrapper = new GridCellWrapper();
        fieldWrapper.setWidth(width);
        layout.addComponent(fieldWrapper, 2 * columns + 1, rows, 2 * (columns + colSpan - 1) + 1, rows);
        layout.setColumnExpandRatio(2 * columns + 1, 1.0f);

        if (StringUtils.isNotBlank(caption)) {
            fieldCaptionMappings.put(caption, fieldWrapper);
        }
        return fieldWrapper;
    }

    /**
     * @param caption
     * @return null if it can not find the component wrapper associates with
     * <code>caption</code>
     */
    public GridCellWrapper getComponentWrapper(String caption) {
        return fieldCaptionMappings.get(caption);
    }

    public GridLayout getLayout() {
        return layout;
    }
}