com.alee.painter.decoration.layout.OverflowLineLayout 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.painter.decoration.layout;

import com.alee.api.jdk.Objects;
import com.alee.painter.decoration.IDecoration;
import com.alee.painter.decoration.content.IContent;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;

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

/**
 * Simple {@link IContentLayout} implementation with two positions for component with possible overflow and trailing component.
 *
 * @param  component type
 * @param  decoration type
 * @param  layout type
 * @author Mikle Garin
 * @see AbstractContentLayout
 * @see IContentLayout
 */
@XStreamAlias ( "OverflowLineLayout" )
public class OverflowLineLayout, I extends OverflowLineLayout>
        extends AbstractContentLayout
{
    /**
     * Leading component constraints.
     * It is always placed before the {@link #OVERFLOW} component.
     */
    protected static final String LEADING = "leading";

    /**
     * Central component constraints.
     * Whenever it doesn't fit into available size it will be shrinked appropriately.
     */
    protected static final String OVERFLOW = "overflow";

    /**
     * Trailing component constraints.
     * It is always placed after the {@link #OVERFLOW} component.
     * Whenever {@link #OVERFLOW} has enough space it will be positioned right after its preferred size plus {@link #gap}.
     */
    protected static final String TRAILING = "trailing";

    /**
     * Horizontal gap between content elements.
     */
    @XStreamAsAttribute
    protected Integer gap;

    /**
     * Returns gap between content elements.
     *
     * @return gap between content elements
     */
    protected int getGap ()
    {
        return gap != null ? gap : 0;
    }

    @Override
    public List getContents ( final C c, final D d, String constraints )
    {
        // Handling constraints depending on component orientation
        final boolean ltr = isLeftToRight ( c, d );
        if ( !ltr )
        {
            if ( Objects.equals ( constraints, LEADING ) )
            {
                constraints = TRAILING;
            }
            else if ( Objects.equals ( constraints, TRAILING ) )
            {
                constraints = LEADING;
            }
        }

        // Returning content according to the constraints
        return super.getContents ( c, d, constraints );
    }

    @Override
    public ContentLayoutData layoutContent ( final C c, final D d, final Rectangle bounds )
    {
        final ContentLayoutData layoutData = new ContentLayoutData ( 5 );
        final boolean ltr = isLeftToRight ( c, d );
        final int gap = getGap ();

        final Dimension lps = getPreferredSize ( c, d, LEADING,
                new Dimension ( bounds.width, bounds.height ) );
        final Dimension tps = getPreferredSize ( c, d, TRAILING,
                new Dimension ( Math.max ( 0, bounds.width - lps.width - gap ), bounds.height ) );
        final Dimension ops = getPreferredSize ( c, d, OVERFLOW,
                new Dimension ( Math.max ( 0, bounds.width - lps.width - gap - tps.width - gap ), bounds.height ) );

        int x = ltr ? bounds.x : Math.max ( bounds.x, bounds.x + bounds.width - lps.width - gap - ops.width - gap - tps.width );
        final int y = bounds.y;
        int width = Math.min ( bounds.width, lps.width + gap + ops.width + gap + tps.width );
        final int height = bounds.height;
        if ( !isEmpty ( c, d, LEADING ) )
        {
            layoutData.put ( LEADING, new Rectangle ( x, y, lps.width, height ) );
            x += lps.width + gap;
            width -= lps.width + gap;
        }
        if ( !isEmpty ( c, d, TRAILING ) )
        {
            final int tx = Math.max ( x, x + width - tps.width );
            layoutData.put ( TRAILING, new Rectangle ( tx, y, tps.width, height ) );
            width -= tps.width + gap;
        }
        if ( !isEmpty ( c, d, OVERFLOW ) )
        {
            layoutData.put ( OVERFLOW, new Rectangle ( x, y, width, height ) );
        }
        return layoutData;
    }

    @Override
    protected Dimension getContentPreferredSize ( final C c, final D d, final Dimension available )
    {
        final Dimension ps = new Dimension ( 0, 0 );
        final int gap = getGap ();
        if ( !isEmpty ( c, d, LEADING ) )
        {
            final Dimension cps = getPreferredSize ( c, d, LEADING, available );
            ps.width += cps.width + gap;
            ps.height = Math.max ( ps.height, cps.height );
            available.width -= ps.width + gap;
        }
        if ( !isEmpty ( c, d, TRAILING ) )
        {
            final Dimension cps = getPreferredSize ( c, d, TRAILING, available );
            ps.width += cps.width + gap;
            ps.height = Math.max ( ps.height, cps.height );
            available.width -= ps.width + gap;
        }
        if ( !isEmpty ( c, d, OVERFLOW ) )
        {
            final Dimension cps = getPreferredSize ( c, d, OVERFLOW, available );
            ps.width += cps.width;
            ps.height = Math.max ( ps.height, cps.height );
        }
        return ps;
    }
}