org.hip.vif.web.util.RatingsTable.java Source code

Introduction

Here is the source code for org.hip.vif.web.util.RatingsTable.java

Source

/**
   This package is part of the application VIF.
   Copyright (C) 2011-2014, Benno Luthiger
    
   This program 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 2 of the License, or
   (at your option) any later version.
    
   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 General Public License for more details.
    
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.hip.vif.web.util;

import org.hip.vif.core.util.RatingsHelper;
import org.hip.vif.web.Activator;
import org.ripla.interfaces.IMessages;

import com.vaadin.shared.ui.label.ContentMode;
import com.vaadin.ui.Alignment;
import com.vaadin.ui.Component;
import com.vaadin.ui.CustomComponent;
import com.vaadin.ui.GridLayout;
import com.vaadin.ui.Label;
import com.vaadin.ui.VerticalLayout;

/** Component to display a user's ratings.
 *
 * @author Luthiger Created: 06.10.2011 */
@SuppressWarnings("serial")
public class RatingsTable extends CustomComponent {

    /** Constructor
     *
     * @param inRatings {@link RatingsHelper} the helper object to access the calculated values */
    public RatingsTable(final RatingsHelper inRatings) {
        super();
        setWidthUndefined();
        final VerticalLayout lLayout = new VerticalLayout();
        setCompositionRoot(lLayout);
        lLayout.setWidthUndefined();

        lLayout.addComponent(new Label(String.format(VIFViewHelper.TMPL_TITLE, "vif-caption", //$NON-NLS-1$
                Activator.getMessages().getMessage("ratings.table.title")), ContentMode.HTML)); //$NON-NLS-1$
        lLayout.addComponent(createRatingsTable(inRatings));
    }

    private Component createRatingsTable(final RatingsHelper inRatings) {
        final GridLayout outLayout = new GridLayout(4, 6);
        outLayout.setWidth(400, Unit.PIXELS);
        outLayout.setStyleName("vif-ratings"); //$NON-NLS-1$

        final IMessages lMessages = Activator.getMessages();

        // first row: table header
        final Label lSpacer = new Label(""); //$NON-NLS-1$
        lSpacer.setWidth(70, Unit.PIXELS);
        outLayout.addComponent(lSpacer, 0, 0);
        outLayout.addComponent(createLabel(lMessages.getMessage("ratings.table.column.correctness")), 1, 0); //$NON-NLS-1$
        outLayout.addComponent(createLabel(lMessages.getMessage("ratings.table.column.responsiveness")), 2, 0); //$NON-NLS-1$
        outLayout.addComponent(createLabel(lMessages.getMessage("ratings.table.column.etiquette")), 3, 0); //$NON-NLS-1$

        // first content: good
        addComponent(outLayout, RatingValue.GOOD.render(), 0, 1, Alignment.MIDDLE_CENTER); //$NON-NLS-1$
        addComponent(outLayout, createLabel(inRatings.getCorrectnessA()), 1, 1, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getEfficiencyA()), 2, 1, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getEtiquetteA()), 3, 1, Alignment.MIDDLE_CENTER);
        // second content: average
        addComponent(outLayout, RatingValue.AVERAGE.render(), 0, 2, Alignment.MIDDLE_CENTER); //$NON-NLS-1$
        addComponent(outLayout, createLabel(inRatings.getCorrectnessB()), 1, 2, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getEfficiencyB()), 2, 2, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getEtiquetteB()), 3, 2, Alignment.MIDDLE_CENTER);
        // third content: bad
        addComponent(outLayout, RatingValue.BAD.render(), 0, 3, Alignment.MIDDLE_CENTER); //$NON-NLS-1$
        addComponent(outLayout, createLabel(inRatings.getCorrectnessC()), 1, 3, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getEfficiencyC()), 2, 3, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getEtiquetteC()), 3, 3, Alignment.MIDDLE_CENTER);

        // total
        addComponent(outLayout, new Label(lMessages.getMessage("ratings.table.label.total")), 0, 4, //$NON-NLS-1$
                Alignment.MIDDLE_LEFT);
        addComponent(outLayout, createLabel(inRatings.getTotal1()), 1, 4, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getTotal2()), 2, 4, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getTotal3()), 3, 4, Alignment.MIDDLE_CENTER);

        // average
        addComponent(outLayout, new Label(lMessages.getMessage("ratings.table.label.mean")), 0, 5, //$NON-NLS-1$
                Alignment.MIDDLE_LEFT);
        addComponent(outLayout, createLabel(inRatings.getMean1()), 1, 5, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getMean2()), 2, 5, Alignment.MIDDLE_CENTER);
        addComponent(outLayout, createLabel(inRatings.getMean3()), 3, 5, Alignment.MIDDLE_CENTER);

        return outLayout;
    }

    private Label createLabel(final String inText) {
        final Label out = new Label(inText);
        out.setWidthUndefined();
        return out;
    }

    private void addComponent(final GridLayout inLayout, final Component inComponen, final int inColumn,
            final int inRow, final Alignment inAlignment) {
        inLayout.addComponent(inComponen, inColumn, inRow);
        inLayout.setComponentAlignment(inComponen, inAlignment);
    }

}