de.unioninvestment.eai.portal.portlet.crud.mvp.views.DefaultPanelContentView.java Source code

Introduction

Here is the source code for de.unioninvestment.eai.portal.portlet.crud.mvp.views.DefaultPanelContentView.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 de.unioninvestment.eai.portal.portlet.crud.mvp.views;

import com.vaadin.shared.ui.MarginInfo;
import com.vaadin.ui.AbstractOrderedLayout;
import com.vaadin.ui.Alignment;
import com.vaadin.ui.Button;
import com.vaadin.ui.Button.ClickListener;
import com.vaadin.ui.Component;
import com.vaadin.ui.CustomComponent;
import com.vaadin.ui.HorizontalLayout;
import com.vaadin.ui.VerticalLayout;
import com.vaadin.ui.themes.LiferayTheme;

import de.unioninvestment.eai.portal.portlet.crud.Settings;
import de.unioninvestment.eai.portal.portlet.crud.mvp.presenters.PanelContentPresenter;
import de.unioninvestment.eai.portal.support.vaadin.context.Context;
import de.unioninvestment.eai.portal.support.vaadin.mvp.View;
import de.unioninvestment.portal.liferay.resize.LiferayResizeExtension;

/**
 * Default-Implementierung fr {@link PanelContentView}, {@link View} fr
 * {@link PanelContentPresenter} Elemente.
 * 
 * @author carsten.mjartan
 * @author Jan Malcomess (codecentric AG)
 * @see PanelContentView
 * @since 1.45 extending Panel
 */
public class DefaultPanelContentView extends CustomComponent implements PanelContentView {

    private static final long serialVersionUID = 1L;

    /**
     * Konstruktor.
     * 
     * @param withMargin
     *            ob der Margin gesetzt werden soll
     * @param useHorizontalLayout
     *            when <code>true</code>, components are layed out horizontally.
     *            (@since 1.45).
     * @param width
     *            The desired width of component (@since 1.45). Defaults to
     *            "100%" when not specified.
     * @param height
     *            The desired height of component (@since 1.45). Defaults to
     *            undefined when not specified.
     */
    public DefaultPanelContentView() {
    }

    @Override
    public void initialize(boolean useHorizontalLayout) {

        AbstractOrderedLayout layout = useHorizontalLayout ? new HorizontalLayout() : new VerticalLayout();
        setCompositionRoot(layout);

        layout.setSpacing(true);
        layout.setMargin(true);
    }

    public void setWidth(String newWidth) {
        super.setWidth(newWidth);
        getLayoutInternal().setWidth(newWidth != null ? "100%" : null);
    };

    @Override
    public void setHeight(String height) {
        super.setHeight(height);
        getLayoutInternal().setHeight(height != null ? "100%" : null);
    }

    @Override
    public void setHeightToFitScreen(Integer minimumHeight) {
        int footerHeight = Context.getBean(Settings.class).getFooterHeight();
        new LiferayResizeExtension().extend(this, footerHeight) //
                .useServerSide() //
                .minimumHeight(minimumHeight);

        getLayoutInternal().setHeight("100%");
    }

    /**
     * {@inheritDoc}
     * 
     * @since 1.45
     */
    @Override
    public void setMargin(boolean enabled) {
        getLayoutInternal().setMargin(enabled);
    }

    /**
     * @return MarginInfo containing the currently enabled margins.
     * @since 1.45.
     */
    public MarginInfo getMargin() {
        return getLayoutInternal().getMargin();
    }

    /**
     * Gives convenient access to the layout of this panel -- either
     * <code>{@link VerticalLayout}</code> (default) oder
     * <code>{@link HorizontalLayout}</code>.
     * 
     * @return the layout this panel uses -- either
     *         <code>{@link VerticalLayout}</code> (default) oder
     *         <code>{@link HorizontalLayout}</code>.
     * @since 1.45
     */
    protected AbstractOrderedLayout getLayoutInternal() {
        return (AbstractOrderedLayout) getCompositionRoot();
    }

    @Override
    public void addComponent(Component component) {
        getLayoutInternal().addComponent(component);
    }

    @Override
    public Button addBackButton(String caption, ClickListener clickListener) {
        AbstractOrderedLayout layout = getLayoutInternal();

        Button backButton = new Button(caption);
        backButton.addClickListener(clickListener);
        layout.addComponent(backButton, 0);
        layout.setComponentAlignment(backButton, Alignment.MIDDLE_RIGHT);
        return backButton;
    }

    @Override
    public void setExpandRatio(Component component, float expandRatio) {
        getLayoutInternal().setExpandRatio(component, expandRatio);
    }

    @Override
    public void setHeight(float height, Unit unit) {
        super.setHeight(height, unit);
        getLayoutInternal().setHeight(height >= 0 ? "100%" : null);
    }

}