VAqua.src.org.violetlib.aqua.AquaSegmentedButtonBorder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaqua Show documentation
An improved native Swing look and feel for macOS
The newest version!
/*
 * Changes Copyright (c) 2015-2020 Alan Snyder.
 * All rights reserved.
 *
 * You may not use, copy or modify this file, except in compliance with the license agreement. For details see
 * accompanying license terms.
 */

/*
 * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package org.violetlib.aqua;

import javax.swing.*;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.violetlib.jnr.aqua.*;
import org.violetlib.jnr.aqua.AquaUIPainter.*;

import static org.violetlib.aqua.OSXSystemProperties.OSVersion;
import static org.violetlib.jnr.aqua.SegmentedButtonConfiguration.DividerState;

/**
 * A border for a button that is painted by a native painter configured using a segmented button widget. The native
 * painter defines the border insets, which capture the visual size of the border.
 */
public class AquaSegmentedButtonBorder extends AquaButtonBorder implements FocusRingOutlineProvider {

    protected final @NotNull SegmentedButtonWidget widget;
    protected final @NotNull AquaButtonExtendedTypes.WidgetInfo info;
    protected final @NotNull Position position;

    /**
     * Create a border for a segmented button. The widget is provisional. The widget may be superseded in some cases
     * based on the group membership of the button at the time the widget is used.
     */
    public AquaSegmentedButtonBorder(@NotNull SegmentedButtonWidget widget,
                                     @NotNull AquaButtonExtendedTypes.WidgetInfo info,
                                     @NotNull Position position) {
        this.widget = widget;
        this.info = info;
        this.position = position;
    }

    @Override
    public @NotNull SegmentedButtonWidget getButtonWidget(@NotNull AbstractButton b) {
        // For layout purposes, the standard widget is sufficient
        return widget;
    }

    @Override
    protected @NotNull AquaButtonExtendedTypes.WidgetInfo getWidgetInfo(@NotNull AbstractButton b) {
        return info;
    }

    @Override
    public @Nullable GenericButtonConfiguration getConfiguration(@NotNull AbstractButton b, int width, int height) {
        SegmentedButtonLayoutConfiguration g = (SegmentedButtonLayoutConfiguration) getLayoutConfiguration(b);
        if (g == null) {
            // should not happen
            return null;
        }

        ButtonModel model = b.getModel();
        State state = getState(b);
        boolean isFocused = (state != State.DISABLED && state != State.INACTIVE && state != State.DISABLED_INACTIVE)
                && b.isFocusPainted() && b.hasFocus();

        AquaButtonExtendedTypes.WidgetInfo info = getWidgetInfo(b);

        boolean isSelected = model.isSelected();
        if (isSelected) {
            // Special case for nonexclusive selected textured segmented buttons. Use the same background as the
            // non-selected button.
            if (info.isTextured()) {
                boolean useNonexclusive = shouldUseNonexclusiveStyle(b, info);
                if (useNonexclusive) {
                    isSelected = false;
                }
            }
        }

        SegmentedButtonWidget widget = SegmentedControlModel.getWidget(b, g);
        boolean isExclusive = isButtonExclusive(b);

        // Special case for exclusive textured segmented buttons in light mode on 10.14: make them active-insensitive.
        // This is not what macOS 10.14 actually does, but it is much more readable, and it is similar to what macOS
        // 10.15 does, which is to make all textured segmented buttons active-insensitive.

        if (OSXSystemProperties.OSVersion == 1014
                && state.isInactive()
                && widget.isTextured()
                && !AppearanceManager.getAppearance(b).isDark()
                && isExclusive) {
            state = state.toActive();
        }

        Size sz = g.getSize();
        AquaUIPainter.Direction d = AquaUIPainter.Direction.UP;
        Position pos = g.getPosition();
        boolean leftDividerPainted = false;
        boolean leftDividerSelected = false;
        boolean rightDividerPainted = pos == Position.FIRST || pos == Position.MIDDLE;
        boolean rightDividerSelected = false;

        // The divider on the right side must be suppressed in certain cases.

        if (rightDividerPainted) {
            AbstractButton rightButton = SegmentedControlModel.getRightAdjacentButton(b);
            if (rightButton != null && rightButton.isSelected() && !b.isSelected()) {
                SegmentedButtonWidget w = getButtonWidgetForPainting(rightButton);
                if (w != null && w.isSlider()) {
                    rightDividerPainted = false;
                }
            }
        }

        DividerState leftState = AquaSegmentedButtonBorder.getDividerState(leftDividerPainted, leftDividerSelected);
        DividerState rightState = AquaSegmentedButtonBorder.getDividerState(rightDividerPainted, rightDividerSelected);
        AquaUIPainter.SwitchTracking tracking = isExclusive ? SwitchTracking.SELECT_ONE : SwitchTracking.SELECT_ANY;
        return new SegmentedButtonConfiguration(widget, sz, state, isSelected, isFocused, d, pos,
                leftState, rightState, tracking);
    }

    private @Nullable SegmentedButtonWidget getButtonWidgetForPainting(@NotNull AbstractButton b) {
        LayoutConfiguration g = getLayoutConfiguration(b);
        return g != null ? SegmentedControlModel.getWidget(b, g) : null;
    }

    @Override
    public @NotNull SegmentedButtonLayoutConfiguration determineLayoutConfiguration(@NotNull AbstractButton b) {
        SegmentedButtonWidget widget = getButtonWidget(b);
        Size defaultSize = getSpecialDefaultSize(b);
        Size size = AquaUtilControlSize.getUserSizeFrom(b, defaultSize);
        return new SegmentedButtonLayoutConfiguration(widget, size, position);
    }

    protected @Nullable Size getSpecialDefaultSize(@NotNull AbstractButton b) {
        if (OSVersion >= 1016) {
            boolean isToolbar = AquaUtils.isOnToolbar(b);
            return isToolbar ? AquaUIPainter.Size.LARGE : null;
        }
        return null;
    }

    @Override
    protected boolean isRollover(@NotNull AbstractButton b) {
        return SegmentedControlModel.isRollover(b);
    }

    public static SegmentedButtonConfiguration.DividerState getDividerState(boolean isPainted, boolean isSelected) {
        if (!isPainted) {
            return SegmentedButtonConfiguration.DividerState.NONE;
        }
        return isSelected
                ? SegmentedButtonConfiguration.DividerState.SELECTED
                : SegmentedButtonConfiguration.DividerState.ORDINARY;
    }
}