io.graphenee.vaadin.AbstractCardComponent Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2016, 2018 Farrukh Ijaz
 *
 * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package io.graphenee.vaadin;

import java.util.Locale;

import javax.annotation.PostConstruct;

import com.vaadin.ui.Alignment;
import com.vaadin.ui.Button;
import com.vaadin.ui.Component;
import com.vaadin.ui.themes.ValoTheme;

import org.vaadin.viritin.label.MLabel;
import org.vaadin.viritin.layouts.MHorizontalLayout;
import org.vaadin.viritin.layouts.MVerticalLayout;

import io.graphenee.vaadin.util.VaadinUtils;

@SuppressWarnings("serial")
public abstract class AbstractCardComponent extends MVerticalLayout {

	private boolean isBuilt;
	private T entity;
	private MHorizontalLayout toolBar;
	private Button deleteButton;
	private Button editButton;

	public AbstractCardComponent(T entity) {
		this.setEntity(entity);
	}

	protected AbstractCardComponent build() {
		if (!isBuilt) {
			removeAllComponents();
			setSizeFull();
			MVerticalLayout cardLayout = new MVerticalLayout().withMargin(true).withSpacing(true).withStyleName("card-item-content");
			addComponentToLayout(cardLayout);
			addComponent(cardLayout);
			setHeight(getCardHeight());
			if (shouldShowFooter()) {
				buildFooter(getEntity());
			}
			postBuild();
			isBuilt = true;
		}
		return this;
	}

	public AbstractCardComponent rebuild() {
		isBuilt = false;
		build();
		return this;
	}

	protected String getCardWidth() {
		return "33%";
	}

	protected String getCardHeight() {
		return "-1px";
	}

	@PostConstruct
	private void postConstruct() {
		postInitialize();
	}

	protected void postInitialize() {
	}

	protected void postBuild() {
	}

	protected void addComponentToLayout(MVerticalLayout layout) {
		addComponentToLayout(layout, getEntity());
	}

	protected void addComponentToLayout(MVerticalLayout layout, T item) {
	}

	protected boolean shouldShowFooter() {
		return true;
	}

	protected AbstractCardComponent buildFooter(T item) {
		if (!isBuilt) {
			MHorizontalLayout footer = new MHorizontalLayout();
			MHorizontalLayout toolbar = getToolbar(entity);
			addButtonsToFooter(toolbar);

			if (shouldShowEditButton()) {
				if (toolBar != null && editButton != null) {
					editButton.setStyleName(ValoTheme.BUTTON_SMALL);
					editButton.addStyleName(ValoTheme.BUTTON_QUIET);
					editButton.addStyleName(ValoTheme.BUTTON_ICON_ONLY);
					toolBar.addComponent(editButton);
				}
			}

			if (shouldShowDeleteButton()) {
				if (toolBar != null && deleteButton != null) {
					deleteButton.setStyleName(ValoTheme.BUTTON_SMALL);
					deleteButton.addStyleName(ValoTheme.BUTTON_QUIET);
					deleteButton.addStyleName(ValoTheme.BUTTON_ICON_ONLY);
					toolBar.addComponent(deleteButton);
				}
			}

			footer.addStyleName("popup-footer");
			footer.setWidth(100.0f, Unit.PERCENTAGE);
			footer.addComponentAsFirst(toolbar);
			footer.setComponentAlignment(toolbar, Alignment.MIDDLE_RIGHT);

			addComponent(footer);
			setComponentAlignment(footer, Alignment.BOTTOM_LEFT);
			setExpandRatio(footer, 0);
		}
		return this;
	}

	public MHorizontalLayout getToolbar(T entity) {
		toolBar = new MHorizontalLayout().withSpacing(true).withDefaultComponentAlignment(Alignment.MIDDLE_LEFT).withFullWidth();
		MLabel blankLabel = new MLabel("").withWidth("1px");
		toolBar.addComponentAsFirst(blankLabel);
		toolBar.setExpandRatio(blankLabel, 1);
		return toolBar;
	}

	protected void addButtonsToFooter(MHorizontalLayout footerToolbar) {
	}

	public AbstractCardComponent withDeleteButton(Button deleteButton) {
		this.deleteButton = deleteButton;
		return this;
	}

	public AbstractCardComponent withEditButton(Button editButton) {
		this.editButton = editButton;
		return this;
	}

	protected boolean shouldShowDeleteButton() {
		return true;
	}

	protected boolean shouldShowEditButton() {
		return true;
	}

	public T getEntity() {
		return entity;
	}

	public void setEntity(T entity) {
		this.entity = entity;
	}

	protected String localizedSingularValue(String key) {
		return VaadinUtils.localizedSingularValue(key);
	}

	protected String localizedPluralValue(String key) {
		return VaadinUtils.localizedSingularValue(key);
	}

	protected void localizeRecursively(Component component) {
		VaadinUtils.localizeRecursively(component);
	}

	protected String localizedSingularValue(Locale locale, String key) {
		return VaadinUtils.localizedSingularValue(key);
	}

	protected String localizedPluralValue(Locale locale, String key) {
		return VaadinUtils.localizedSingularValue(key);
	}

	protected void localizeRecursively(Locale locale, Component component) {
		VaadinUtils.localizeRecursively(component);
	}
}