com.alee.extended.layout.VerticalFlowLayout Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
There is a newer version: 1.2.14
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library 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.
 *
 * WebLookAndFeel library 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 WebLookAndFeel library.  If not, see .
 */

package com.alee.extended.layout;

import java.awt.*;

/**
 * User: mgarin Date: 16.05.11 Time: 13:10
 */

public class VerticalFlowLayout extends FlowLayout
{
    /**
     * Description of the Field
     */
    public final static int TOP = 0;
    public final static int MIDDLE = 1;
    public final static int BOTTOM = 2;

    protected int hgap;
    protected int vgap;
    protected boolean hfill;
    protected boolean vfill;

    /**
     * Construct a new VerticalFlowLayout with a middle alignemnt, and the fill to edge flag set.
     */
    public VerticalFlowLayout ()
    {
        this ( TOP, 0, 0, true, false );
    }

    /**
     * Construct a new VerticalFlowLayout with a middle alignemnt.
     */
    public VerticalFlowLayout ( final boolean hfill, final boolean vfill )
    {
        this ( TOP, 0, 0, hfill, vfill );
    }

    /**
     * Construct a new VerticalFlowLayout with a middle alignemnt.
     */
    public VerticalFlowLayout ( final int hgap, final int vgap )
    {
        this ( TOP, hgap, vgap, true, false );
    }

    /**
     * Construct a new VerticalFlowLayout with a middle alignemnt.
     */
    public VerticalFlowLayout ( final int align, final int hgap, final int vgap )
    {
        this ( align, hgap, vgap, true, false );
    }

    /**
     * Construct a new VerticalFlowLayout with a middle alignemnt.
     */
    public VerticalFlowLayout ( final int align )
    {
        this ( align, 0, 0, true, false );
    }

    /**
     * Construct a new VerticalFlowLayout.
     */
    public VerticalFlowLayout ( final int align, final boolean hfill, final boolean vfill )
    {
        this ( align, 0, 0, hfill, vfill );
    }

    /**
     * Construct a new VerticalFlowLayout.
     */
    public VerticalFlowLayout ( final int align, final int hgap, final int vgap, final boolean hfill, final boolean vfill )
    {
        setAlignment ( align );
        this.hgap = hgap;
        this.vgap = vgap;
        this.hfill = hfill;
        this.vfill = vfill;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setHgap ( final int hgap )
    {
        super.setHgap ( hgap );
        this.hgap = hgap;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setVgap ( final int vgap )
    {
        super.setVgap ( vgap );
        this.vgap = vgap;
    }

    /**
     * Sets the VerticalFill attribute of the VerticalLayout object
     */
    public void setVerticalFill ( final boolean vfill )
    {
        this.vfill = vfill;
    }

    /**
     * Sets the HorizontalFill attribute of the VerticalLayout object
     */
    public void setHorizontalFill ( final boolean hfill )
    {
        this.hfill = hfill;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getHgap ()
    {
        return hgap;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getVgap ()
    {
        return vgap;
    }

    /**
     * Gets the VerticalFill attribute of the VerticalLayout object
     */
    public boolean getVerticalFill ()
    {
        return vfill;
    }

    /**
     * Gets the HorizontalFill attribute of the VerticalLayout object
     */
    public boolean getHorizontalFill ()
    {
        return hfill;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Dimension preferredLayoutSize ( final Container target )
    {
        final Dimension tarsiz = new Dimension ( 0, 0 );
        for ( int i = 0; i < target.getComponentCount (); i++ )
        {
            final Component m = target.getComponent ( i );
            if ( m.isVisible () )
            {
                final Dimension d = m.getPreferredSize ();
                tarsiz.width = Math.max ( tarsiz.width, d.width );
                if ( i > 0 )
                {
                    tarsiz.height += vgap;
                }
                tarsiz.height += d.height;
            }
        }
        final Insets insets = target.getInsets ();
        tarsiz.width += insets.left + insets.right;
        tarsiz.height += insets.top + insets.bottom;
        return tarsiz;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Dimension minimumLayoutSize ( final Container target )
    {
        final Dimension tarsiz = new Dimension ( 0, 0 );

        for ( int i = 0; i < target.getComponentCount (); i++ )
        {
            final Component m = target.getComponent ( i );
            if ( m.isVisible () )
            {
                final Dimension d = m.getMinimumSize ();
                tarsiz.width = Math.max ( tarsiz.width, d.width );
                if ( i > 0 )
                {
                    tarsiz.height += vgap;
                }
                tarsiz.height += d.height;
            }
        }
        final Insets insets = target.getInsets ();
        tarsiz.width += insets.left + insets.right;
        tarsiz.height += insets.top + insets.bottom;
        return tarsiz;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void layoutContainer ( final Container target )
    {
        final Insets insets = target.getInsets ();
        final int maxheight = target.getSize ().height - ( insets.top + insets.bottom );
        final int maxwidth = target.getSize ().width - ( insets.left + insets.right );
        final int numcomp = target.getComponentCount ();
        int x = insets.left;
        int y = 0;
        int colw = 0;
        int start = 0;

        for ( int i = 0; i < numcomp; i++ )
        {
            final Component m = target.getComponent ( i );
            if ( m.isVisible () )
            {
                final Dimension d = m.getPreferredSize ();
                // fit last component to remaining height
                if ( ( this.vfill ) && ( i == ( numcomp - 1 ) ) )
                {
                    d.height = Math.max ( ( maxheight - y ), m.getPreferredSize ().
                            height );
                }
                // fit componenent size to container width
                if ( this.hfill )
                {
                    m.setSize ( maxwidth, d.height );
                    d.width = maxwidth;
                }
                else
                {
                    m.setSize ( d.width, d.height );
                }

                if ( this.vfill && y + d.height > maxheight )
                {
                    placeThem ( target, x, insets.top, colw, maxheight - y, start, i );
                    y = d.height;
                    x += hgap + colw;
                    colw = d.width;
                    start = i;
                }
                else
                {
                    if ( y > 0 )
                    {
                        y += vgap;
                    }
                    y += d.height;
                    colw = Math.max ( colw, d.width );
                }
            }
        }
        placeThem ( target, x, insets.top, colw, maxheight - y, start, numcomp );
    }

    /**
     * places the components defined by first to last within the target container using the bounds box defined
     */
    protected void placeThem ( final Container target, final int x, int y, final int width, final int height, final int first,
                               final int last )
    {
        final int align = getAlignment ();
        //if ( align == this.TOP )
        //  y = 0;
        if ( align == MIDDLE )
        {
            y += height / 2;
        }
        if ( align == BOTTOM )
        {
            y += height;
        }

        for ( int i = first; i < last; i++ )
        {
            final Component m = target.getComponent ( i );
            final Dimension md = m.getSize ();
            if ( m.isVisible () )
            {
                final int px = x + ( width - md.width ) / 2;
                m.setLocation ( px, y );
                y += vgap + md.height;
            }
        }
    }
}