org.pushingpixels.radiance.theming.ktx.RadianceComponentOrParentExtensions.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of radiance-theming-ktx Show documentation
Building modern, elegant and fast Swing applications
The newest version!
/*
 * Copyright (c) 2005-2024 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.theming.ktx

import org.pushingpixels.radiance.theming.api.RadianceThemingCortex
import org.pushingpixels.radiance.theming.api.RadianceThemingSlices
import org.pushingpixels.radiance.theming.api.painter.preview.DefaultPreviewPainter
import org.pushingpixels.radiance.theming.api.painter.preview.PreviewPainter
import org.pushingpixels.radiance.theming.api.shaper.ClassicButtonShaper
import org.pushingpixels.radiance.theming.api.shaper.PillButtonShaper
import org.pushingpixels.radiance.theming.api.shaper.RadianceButtonShaper
import javax.swing.JComponent

/**
 * Specifies preview painter to be used for showing preview of this component or its
 * immediate children. Default implementation is available in the
 * [DefaultPreviewPainter].
 *
 * @param previewPainter Preview painter. Can be `null`.
 */
@RadianceComponentOrParentScope
public fun JComponent.setComponentPreviewPainter(previewPainter: PreviewPainter) {
    RadianceThemingCortex.ComponentOrParentScope.setComponentPreviewPainter(this, previewPainter)
}

/**
 * Specifies whether this component or its immediate children should ignore the
 * default (minimum) dimension for buttons. Note that [RadianceButtonShaper]
 * implementations are not required to respect this call. The current implementations of the
 * default [PillButtonShaper] and [ClassicButtonShaper] respect this
 * setting.
 *
 * @param buttonIgnoreMinimumSize If `true`, the component or its immediate
 * children will ignore the default (minimum) dimension for buttons under button
 * shapers that respect this setting. Pass `null` to reset to the default
 * behavior.
 */
public fun JComponent.setButtonIgnoreMinimumSize(buttonIgnoreMinimumSize: Boolean?) {
    RadianceThemingCortex.ComponentOrParentScope.setButtonIgnoreMinimumSize(this, buttonIgnoreMinimumSize)
}

/**
 * Specifies when this component or its immediate children should paint
 * the background.
 *
 * @param backgroundAppearanceStrategy Background appearance strategy. Pass `null` to reset
 * to the default behavior.
 */
public fun JComponent.setBackgroundAppearanceStrategy(
        backgroundAppearanceStrategy: RadianceThemingSlices.BackgroundAppearanceStrategy?) {
    RadianceThemingCortex.ComponentOrParentScope.setBackgroundAppearanceStrategy(this,
            backgroundAppearanceStrategy)
}