com.alee.laf.menu.MenuItemLayout 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.menu;

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

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

/**
 * {@link JMenuItem} layout implementation.
 * It only paints contents placed under {@link #ICON}, {@link #TEXT}, {@link #ACCELERATOR} and {@link #ARROW} constraints.
 * If you want to use a similar layout for non-{@link JMenuItem} component - use {@link SimpleMenuItemLayout} instead.
 *
 * @param  component type
 * @param  decoration type
 * @param  layout type
 * @author Mikle Garin
 */
@XStreamAlias ( "MenuItemLayout" )
public class MenuItemLayout, I extends MenuItemLayout>
        extends AbstractMenuItemLayout
{
    /**
     * Whether or not menu items text should be aligned by maximum icon size.
     */
    @Nullable
    @XStreamAsAttribute
    protected Boolean alignTextByIcons;

    @Override
    protected boolean isAlignTextByIcons ( @NotNull final C c, @NotNull final D d )
    {
        return alignTextByIcons == null || alignTextByIcons;
    }

    @NotNull
    @Override
    protected PopupMenuIcons getPopupMenuIcons ( @NotNull final C c, @NotNull final D d )
    {
        final PopupMenuIcons popupMenuIcons = new PopupMenuIcons ( false, false, 0, 0 );
        if ( isAlignTextByIcons ( c, d ) && c.getParent () instanceof JPopupMenu )
        {
            final JPopupMenu popupMenu = ( JPopupMenu ) c.getParent ();
            for ( int i = 0; i < popupMenu.getComponentCount (); i++ )
            {
                final Component component = popupMenu.getComponent ( i );
                if ( component instanceof JMenuItem )
                {
                    final JMenuItem item = ( JMenuItem ) component;
                    adjustForMenuItem ( popupMenuIcons, item );
                }
            }
        }
        else
        {
            adjustForMenuItem ( popupMenuIcons, c );
        }
        return popupMenuIcons;
    }

    /**
     * Adjusts {@link com.alee.laf.menu.AbstractMenuItemLayout.PopupMenuIcons} information according to {@link JMenuItem} settings.
     *
     * @param popupMenuIcons {@link com.alee.laf.menu.AbstractMenuItemLayout.PopupMenuIcons}
     * @param menuItem       {@link JMenuItem}
     */
    protected void adjustForMenuItem ( @NotNull final PopupMenuIcons popupMenuIcons, @NotNull final JMenuItem menuItem )
    {
        final Object stateIcon = menuItem.getClientProperty ( AbstractStateMenuItemPainter.STATE_ICON_PROPERTY );
        final boolean hasStateIcon = stateIcon instanceof Icon;
        if ( hasStateIcon )
        {
            popupMenuIcons.maxStateIconWidth = Math.max (
                    popupMenuIcons.maxStateIconWidth,
                    ( ( Icon ) stateIcon ).getIconWidth ()
            );
        }

        final Icon icon = menuItem.getIcon ();
        final boolean hasIcon = icon != null;
        if ( hasIcon )
        {
            popupMenuIcons.maxIconWidth = Math.max (
                    popupMenuIcons.maxIconWidth,
                    icon.getIconWidth ()
            );
        }

        popupMenuIcons.hasAnyIcons = popupMenuIcons.hasAnyIcons || hasStateIcon || hasIcon;
        popupMenuIcons.hasBothIcons = popupMenuIcons.hasBothIcons || hasStateIcon && hasIcon;
    }

    @Override
    protected int getStateIconGap ( @NotNull final C c, @NotNull final D d )
    {
        return stateIconGap != null ? stateIconGap : getIconTextGap ( c, d );
    }

    @Override
    protected int getIconTextGap ( @NotNull final C c, @NotNull final D d )
    {
        return iconTextGap != null ? iconTextGap : c.getIconTextGap ();
    }

    @Override
    public boolean isEmpty ( @NotNull final C c, @NotNull final D d, final String constraints )
    {
        // Checking default emptiness conditions
        boolean empty = super.isEmpty ( c, d, constraints );

        // Extra conditions for menu items
        if ( !empty )
        {
            if ( Objects.equals ( constraints, STATE_ICON ) )
            {
                // State icon is only dispayed for specific menu item types
                empty = !( c instanceof JCheckBoxMenuItem ) && !( c instanceof JRadioButtonMenuItem );
            }
            else if ( Objects.equals ( constraints, ACCELERATOR ) )
            {
                // Accelerator is only displayed for menu items within popup menu and when it is specified
                empty = !isInPopupMenu ( c, d ) || c.getAccelerator () == null;
            }
            else if ( Objects.equals ( constraints, ARROW ) )
            {
                // Menu arrow is only displayed for menu items within popup menu
                empty = !isInPopupMenu ( c, d );
            }
        }

        return empty;
    }

    /**
     * Returns whether or not the specified menu item is placed within popup menu.
     *
     * @param c painted component
     * @param d painted decoration state
     * @return true if the specified menu item is placed within popup menu, false otherwise
     */
    protected boolean isInPopupMenu ( @NotNull final C c, @NotNull final D d )
    {
        return c.getParent () != null && c.getParent () instanceof JPopupMenu;
    }
}