com.alee.laf.toolbar.WhiteSpace 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.laf.toolbar;

import com.alee.extended.layout.AbstractLineLayout;
import com.alee.extended.layout.HorizontalFlowLayout;
import com.alee.extended.layout.VerticalFlowLayout;
import com.alee.utils.SwingUtils;

import javax.swing.*;
import java.awt.*;

/**
 * Custom component to create spacings where layout can't do the stuff you need.
 * It is basically better to use this, instead of combining two containers with two layouts.
 * The best case is of course when layout handles the spacing, but its not always that easy.
 *
 * @author Mikle Garin
 */
public class WhiteSpace extends JComponent implements SwingConstants
{
    /**
     * todo 1. Appropriate implement component with UI and painter
     */

    /**
     * Spacing amount in px.
     */
    private int spacing;

    /**
     * Spacing orientation.
     * It can either be {@link #HORIZONTAL} or {@link #VERTICAL}.
     */
    private int orientation;

    /**
     * Constructs new spacer.
     */
    public WhiteSpace ()
    {
        this ( 2 );
    }

    /**
     * Constructs new spacer.
     *
     * @param spacing space amount
     */
    public WhiteSpace ( final int spacing )
    {
        this ( spacing, -1 );
    }

    /**
     * Constructs new spacer.
     *
     * @param spacing     space amount
     * @param orientation space orientation
     */
    public WhiteSpace ( final int spacing, final int orientation )
    {
        super ();
        SwingUtils.setOrientation ( this );
        setSpacing ( spacing );
        setOrientation ( orientation );
    }

    /**
     * Returns spacing orientation.
     *
     * @return spacing orientation
     */
    public int getOrientation ()
    {
        return orientation;
    }

    /**
     * Returns actual current orientation.
     *
     * @return actual current orientation
     */
    protected int getActualOrientation ()
    {
        final int orientation;
        final Container container = getParent ();
        if ( container != null )
        {
            final LayoutManager layoutManager = container.getLayout ();
            if ( layoutManager instanceof AbstractLineLayout )
            {
                /**
                 * Support for {@link AbstractLineLayout} and any extending layout manager.
                 */
                final AbstractLineLayout layout = ( AbstractLineLayout ) layoutManager;
                orientation = layout.getOrientation ( container );
            }
            else if ( layoutManager instanceof BoxLayout )
            {
                /**
                 * Support for {@link BoxLayout} and any extending layout manager.
                 */
                final BoxLayout layout = ( BoxLayout ) layoutManager;
                final int axis = layout.getAxis ();
                orientation = axis == BoxLayout.LINE_AXIS || axis == BoxLayout.X_AXIS ? HORIZONTAL : VERTICAL;
            }
            else if ( layoutManager instanceof HorizontalFlowLayout || layoutManager instanceof FlowLayout )
            {
                /**
                 * Static {@link #HORIZONTAL} orientation for some known layout types.
                 */
                orientation = HORIZONTAL;
            }
            else if ( layoutManager instanceof VerticalFlowLayout )
            {
                /**
                 * Static {@link #VERTICAL} orientation for some known layout types.
                 */
                orientation = VERTICAL;
            }
            else
            {
                /**
                 * Default orientation usage for all other layout types.
                 */
                orientation = this.orientation;
            }
        }
        else
        {
            /**
             * Default orientation usage for unattached component.
             */
            orientation = this.orientation;
        }
        return orientation;
    }

    /**
     * Sets spacing orientation.
     * Specify {@code -1} to have spacing for both orientations.
     *
     * @param orientation new spacing orientation
     */
    public void setOrientation ( final int orientation )
    {
        this.orientation = orientation;
    }

    /**
     * Returns spacing amount in px.
     *
     * @return spacing amount in px
     */
    public int getSpacing ()
    {
        return spacing;
    }

    /**
     * Sets spacing amount in px.
     *
     * @param spacing new spacing amount in px
     */
    public void setSpacing ( final int spacing )
    {
        this.spacing = spacing;
    }

    @Override
    public Dimension getPreferredSize ()
    {
        final int orientation = getActualOrientation ();
        final int width = orientation != VERTICAL ? spacing : 0;
        final int height = orientation != HORIZONTAL ? spacing : 0;
        return new Dimension ( width, height );
    }
}