com.alee.extended.button.SplitButtonPainter 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 is a Java Swing Look and Feel and extended components library for cross-platform applications
There is a newer version: 2.2.1
package com.alee.extended.button;

import com.alee.laf.button.AbstractButtonPainter;
import com.alee.painter.decoration.IDecoration;
import com.alee.utils.CompareUtils;

import javax.swing.*;
import java.awt.*;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;

/**
 * Basic painter for WebSplitButton component.
 * It is used as WebSplitButtonUI default painter.
 *
 * @param  component type
 * @param  component UI type
 * @param  decoration type
 * @author Mikle Garin
 */

public class SplitButtonPainter>
        extends AbstractButtonPainter implements ISplitButtonPainter
{
    /**
     * todo 1. Replace custom split button painting with button component
     * todo 2. Replace custom separator painting with separator component
     */

    /**
     * Style settings.
     */
    protected Color splitLineColor;
    protected Color splitLineDisabledColor;
    protected int splitIconGap;
    protected int contentGap;

    /**
     * Listeners.
     */
    protected MouseAdapter splitButtonTracker;

    /**
     * Runtime variables.
     */
    protected boolean onSplit = false;

    @Override
    public void install ( final E c, final U ui )
    {
        super.install ( c, ui );

        // Adding split button mouseover tracker
        splitButtonTracker = new MouseAdapter ()
        {
            @Override
            public void mouseMoved ( final MouseEvent e )
            {
                // Saving old split mouseover state
                final boolean wasOnSplit = onSplit;

                // Updating split mouseover state
                onSplit = getSplitButtonHitbox ( component ).contains ( e.getPoint () );

                // Repainting button if state has changed
                if ( wasOnSplit != onSplit )
                {
                    repaint ();
                }
            }

            @Override
            public void mouseExited ( final MouseEvent e )
            {
                // Saving old split mouseover state
                final boolean wasOnSplit = onSplit;

                // Resetting split mouseover state
                onSplit = false;

                // Repainting button if state has changed
                if ( wasOnSplit != onSplit )
                {
                    repaint ();
                }
            }
        };
        component.addMouseListener ( splitButtonTracker );
        component.addMouseMotionListener ( splitButtonTracker );
    }

    @Override
    public void uninstall ( final E c, final U ui )
    {
        // Removing split button mouseover tracker
        component.removeMouseMotionListener ( splitButtonTracker );
        component.removeMouseListener ( splitButtonTracker );
        splitButtonTracker = null;
        onSplit = false;

        super.uninstall ( c, ui );
    }

    @Override
    protected void propertyChange ( final String property, final Object oldValue, final Object newValue )
    {
        // Perform basic actions on property changes
        super.propertyChange ( property, oldValue, newValue );

        // Updating border on split icon change
        if ( CompareUtils.equals ( property, WebSplitButton.SPLIT_ICON_PROPERTY ) )
        {
            updateBorder ();
        }
    }

    /**
     * Returns gap between split icon and split part sides.
     *
     * @return gap between split icon and split part sides
     */
    public int getSplitIconGap ()
    {
        return splitIconGap;
    }

    /**
     * Sets gap between split icon and split part sides
     *
     * @param splitIconGap gap between split icon and split part sides
     */
    public void setSplitIconGap ( final int splitIconGap )
    {
        this.splitIconGap = splitIconGap;
    }

    /**
     * Returns gap between split part and button content.
     *
     * @return gap between split part and button content
     */
    public int getContentGap ()
    {
        return contentGap;
    }

    /**
     * Sets gap between split part and button content.
     *
     * @param contentGap gap between split part and button content
     */
    public void setContentGap ( final int contentGap )
    {
        this.contentGap = contentGap;
    }

    @Override
    public boolean isOnSplit ()
    {
        return onSplit;
    }

    @Override
    public Insets getBorders ()
    {
        final Insets borders = super.getBorders ();
        final Icon splitIcon = component.getSplitIcon ();
        return splitIcon != null ? i ( borders, 0, 0, 0, contentGap + 1 + splitIconGap + splitIcon.getIconWidth () + splitIconGap ) :
                borders;
    }

    @Override
    protected void paintContent ( final Graphics2D g2d, final Rectangle bounds, final E c, final U ui )
    {
        // Painting button content
        super.paintContent ( g2d, bounds, c, ui );

        // Painting split button
        paintSplitButton ( g2d, bounds, c );
    }

    /**
     * Paints split button.
     *
     * @param g2d    graphics context
     * @param bounds painting bounds
     * @param c      split button
     */
    protected void paintSplitButton ( final Graphics2D g2d, final Rectangle bounds, final E c )
    {
        // Painting split button icon
        final Icon splitIcon = component.getSplitIcon ();
        final Rectangle br = getSplitButtonBounds ( bounds, c );
        final int ix = br.x + br.width / 2 - splitIcon.getIconWidth () / 2;
        final int iy = br.y + br.height / 2 - splitIcon.getIconHeight () / 2;
        splitIcon.paintIcon ( component, g2d, ix, iy );

        // Painting split button line
        final Rectangle lr = getSplitLineBounds ( bounds, c );
        g2d.setPaint ( c.isEnabled () ? splitLineColor : splitLineDisabledColor );
        g2d.drawLine ( lr.x, lr.y, lr.x, lr.y + lr.height );
    }

    /**
     * Returns bounds of the split button part.
     *
     * @param b painting bounds
     * @param c split button
     * @return bounds of the split button part
     */
    protected Rectangle getSplitButtonBounds ( final Rectangle b, final E c )
    {
        final Insets i = c.getInsets ();
        final int x = b.x + ( ltr ? b.width - i.right + contentGap + 1 + splitIconGap : i.left - contentGap - 1 - splitIconGap );
        return new Rectangle ( x, b.y + i.top, component.getSplitIcon ().getIconWidth (), b.height - i.top - i.bottom );
    }

    /**
     * Returns bounds of the split line part.
     *
     * @param b painting bounds
     * @param c split button
     * @return bounds of the split line part
     */
    protected Rectangle getSplitLineBounds ( final Rectangle b, final E c )
    {
        final Insets i = c.getInsets ();
        final int x = b.x + ( ltr ? b.width - i.right + contentGap : i.left - contentGap );
        return new Rectangle ( x, b.y + i.top, 1, b.height - i.top - i.bottom - 1 );
    }

    /**
     * Returns split button part hitbox.
     *
     * @param c split button
     * @return split button part hitbox
     */
    protected Rectangle getSplitButtonHitbox ( final E c )
    {
        final Insets i = c.getInsets ();
        return new Rectangle ( ltr ? c.getWidth () - i.right : 0, 0, ltr ? i.right : i.left, c.getHeight () );
    }
}