org.pushingpixels.radiance.component.internal.ui.ribbon.JRibbonTaskToggleButton Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swingset3-demos Show documentation
Demonstrating the abilities of the Swing UI Toolkit swingset2 and swingx aka swingset3
The newest version!
/*
 * Copyright (c) 2005-2021 Radiance Kirill Grouchnikov. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  o Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 *  o Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 *  o Neither the name of the copyright holder nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.pushingpixels.radiance.component.internal.ui.ribbon;

import org.pushingpixels.radiance.component.api.common.JCommandButton;
import org.pushingpixels.radiance.component.api.common.model.Command;
import org.pushingpixels.radiance.component.api.common.model.CommandButtonPresentationModel;
import org.pushingpixels.radiance.component.api.common.projection.Projection;
import org.pushingpixels.radiance.component.api.ribbon.RibbonTask;
import org.pushingpixels.radiance.component.internal.theming.ribbon.ui.RadianceRibbonTaskToggleButtonUI;
import org.pushingpixels.radiance.component.internal.ui.common.RadianceInternalButton;

import java.awt.*;

/**
 * Toggle button for ribbon tasks. This class is for internal use only and
 * should not be directly used by the applications.
 *
 * @author Kirill Grouchnikov
 */
public class JRibbonTaskToggleButton extends JCommandButton
        implements RadianceInternalButton {
    /**
     * The UI class ID string.
     */
    public static final String uiClassID = "RibbonTaskToggleButtonUI";

    /**
     * Color of the matching contextual task group. Can be null if
     * the associated task is not contextual.
     */
    private Color contextualGroupHueColor;

    private String keyTip;

    private RibbonTask ribbonTask;

    public JRibbonTaskToggleButton(Projection projection) {
        super(projection);
    }

    @Override
    public void updateUI() {
        setUI(RadianceRibbonTaskToggleButtonUI.createUI(this));
    }

    @Override
    public String getUIClassID() {
        return uiClassID;
    }

    /**
     * Returns the hue color of the matching contextual task group if the
     * associated task is contextual.
     *
     * @return The hue color of the matching contextual task group if the
     * associated task is contextual, null otherwise.
     */
    public Color getContextualGroupHueColor() {
        return this.contextualGroupHueColor;
    }

    public void setRibbonTask(RibbonTask ribbonTask) {
        this.ribbonTask = ribbonTask;
    }

    public RibbonTask getRibbonTask() {
        return this.ribbonTask;
    }

    /**
     * Sets the hue color of the matching contextual task group on this button.
     *
     * @param contextualGroupHueColor The hue color of the matching contextual task group.
     */
    public void setContextualGroupHueColor(Color contextualGroupHueColor) {
        Color old = this.contextualGroupHueColor;
        this.contextualGroupHueColor = contextualGroupHueColor;

        this.firePropertyChange("contextualGroupHueColor", old,
                this.contextualGroupHueColor);
    }

    public void setKeyTip(String keyTip) {
        this.keyTip = keyTip;
    }

    public String getKeyTip() {
        return keyTip;
    }
}