com.alee.utils.swing.extensions.SizeMethods 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.utils.swing.extensions;

import com.alee.api.annotations.NotNull;

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

/**
 * This interface provides a set of methods that should be added into any {@link JComponent} that supports customizable sizes.
 *
 * @param  component type
 * @author Mikle Garin
 * @see MethodExtension
 * @see SizeMethodsImpl
 */
public interface SizeMethods extends MethodExtension
{
    /**
     * Undefined size value constant.
     */
    public static final int UNDEFINED = -1;

    /**
     * Returns {@link JComponent} preferred width set in {@link #setPreferredWidth(int)} or {@link #UNDEFINED}.
     * To retrieve actual {@link JComponent} preferred width use {@link #getPreferredSize()} method instead.
     *
     * @return {@link JComponent} preferred width set in {@link #setPreferredWidth(int)} or {@link #UNDEFINED}
     */
    public int getPreferredWidth ();

    /**
     * Sets {@link JComponent} preferred width.
     * Pass {@link #UNDEFINED} to let {@link JComponent} choose preferred width on its own.
     *
     * @param preferredWidth new {@link JComponent} preferred width
     * @return modified {@link JComponent}
     */
    @NotNull
    public C setPreferredWidth ( int preferredWidth );

    /**
     * Returns {@link JComponent} preferred height set in {@link #setPreferredHeight(int)} or {@link #UNDEFINED}.
     * To retrieve actual {@link JComponent} preferred height use {@link #getPreferredSize()} method instead.
     *
     * @return {@link JComponent} preferred height set in {@link #setPreferredHeight(int)} or {@link #UNDEFINED}
     */
    public int getPreferredHeight ();

    /**
     * Sets {@link JComponent} preferred height.
     * Pass {@link #UNDEFINED} to let {@link JComponent} choose preferred height on its own.
     *
     * @param preferredHeight new {@link JComponent} preferred height
     * @return modified {@link JComponent}
     */
    @NotNull
    public C setPreferredHeight ( int preferredHeight );

    /**
     * Returns {@link JComponent} preferred size.
     * This size is already adjusted according to min/max width and height settings.
     * Use {@link #getOriginalPreferredSize()} method to retrieve original {@link JComponent} preferred size.
     *
     * @return {@link JComponent} preferred size
     */
    @NotNull
    public Dimension getPreferredSize ();

    /**
     * Returns original {@link JComponent} preferred size before any adjustments.
     * This might be useful for various calculations involving {@link JComponent} size.
     * In most cases this is the size provided by UI implementation of the {@link JComponent}.
     *
     * @return original {@link JComponent} preferred size before any adjustments
     */
    @NotNull
    public Dimension getOriginalPreferredSize ();

    /**
     * Sets {@link JComponent} preferred size.
     * This method is a simple bridge for {@link JComponent#setPreferredSize(Dimension)} method.
     *
     * @param width  {@link JComponent} preferred width
     * @param height {@link JComponent} preferred height
     * @return modified {@link JComponent}
     */
    @NotNull
    public C setPreferredSize ( int width, int height );

    /**
     * Returns {@link JComponent} maximum width set in {@link #setMaximumWidth(int)} or {@link #UNDEFINED}.
     * To retrieve actual {@link JComponent} maximum width use {@link #getMaximumSize()} method instead.
     *
     * @return {@link JComponent} maximum width set in {@link #setMaximumWidth(int)} or {@link #UNDEFINED}
     */
    public int getMaximumWidth ();

    /**
     * Sets {@link JComponent} maximum width.
     * Pass {@link #UNDEFINED} to let {@link JComponent} choose maximum width on its own.
     *
     * @param maximumWidth new {@link JComponent} maximum width
     * @return modified {@link JComponent}
     */
    @NotNull
    public C setMaximumWidth ( int maximumWidth );

    /**
     * Returns {@link JComponent} maximum height set in {@link #setMaximumHeight(int)} or {@link #UNDEFINED}.
     * To retrieve actual {@link JComponent} maximum height use {@link #getMaximumSize()} method instead.
     *
     * @return {@link JComponent} maximum height set in {@link #setMaximumHeight(int)} or {@link #UNDEFINED}
     */
    public int getMaximumHeight ();

    /**
     * Sets {@link JComponent} maximum height.
     * Pass {@link #UNDEFINED} to let {@link JComponent} choose maximum height on its own.
     *
     * @param maximumHeight new {@link JComponent} maximum height
     * @return modified {@link JComponent}
     */
    @NotNull
    public C setMaximumHeight ( int maximumHeight );

    /**
     * Returns {@link JComponent} maximum size.
     * This size is already adjusted according to min/max width and height settings.
     * Use {@link #getOriginalMaximumSize()} method to retrieve original {@link JComponent} maximum size.
     *
     * @return {@link JComponent} maximum size
     */
    @NotNull
    public Dimension getMaximumSize ();

    /**
     * Returns original {@link JComponent} maximum size before any adjustments.
     * This might be useful for various calculations involving {@link JComponent} size.
     * In most cases this is the size provided by UI implementation of the {@link JComponent}.
     *
     * @return original {@link JComponent} maximum size before any adjustments
     */
    @NotNull
    public Dimension getOriginalMaximumSize ();

    /**
     * Sets {@link JComponent} maximum size.
     * This method is a simple bridge for {@link JComponent#setMaximumSize(Dimension)} method.
     *
     * @param width  {@link JComponent} maximum width
     * @param height {@link JComponent} maximum height
     * @return modified {@link JComponent}
     */
    @NotNull
    public C setMaximumSize ( int width, int height );

    /**
     * Returns {@link JComponent} minimum width set in {@link #setMinimumWidth(int)} or {@link #UNDEFINED}.
     * To retrieve actual {@link JComponent} minimum width use {@link #getMinimumSize()} method instead.
     *
     * @return {@link JComponent} minimum width set in {@link #setMinimumWidth(int)} or {@link #UNDEFINED}
     */
    public int getMinimumWidth ();

    /**
     * Sets {@link JComponent} minimum width.
     * Pass {@link #UNDEFINED} to let {@link JComponent} choose minimum width on its own.
     *
     * @param minimumWidth new {@link JComponent} minimum width
     * @return modified {@link JComponent}
     */
    @NotNull
    public C setMinimumWidth ( int minimumWidth );

    /**
     * Returns {@link JComponent} minimum height set in {@link #setMinimumHeight(int)} or {@link #UNDEFINED}.
     * To retrieve actual {@link JComponent} minimum height use {@link #getMinimumSize()} method instead.
     *
     * @return {@link JComponent} minimum height set in {@link #setMinimumHeight(int)} or {@link #UNDEFINED}
     */
    public int getMinimumHeight ();

    /**
     * Sets {@link JComponent} minimum height.
     * Pass {@link #UNDEFINED} to let {@link JComponent} choose minimum height on its own.
     *
     * @param minimumHeight new {@link JComponent} minimum height
     * @return modified {@link JComponent}
     */
    @NotNull
    public C setMinimumHeight ( int minimumHeight );

    /**
     * Returns {@link JComponent} minimum size.
     * This size is already adjusted according to min/max width and height settings.
     * Use {@link #getOriginalMinimumSize()} method to retrieve original {@link JComponent} minimum size.
     *
     * @return {@link JComponent} minimum size
     */
    @NotNull
    public Dimension getMinimumSize ();

    /**
     * Returns original {@link JComponent} minimum size before any adjustments.
     * This might be useful for various calculations involving {@link JComponent} size.
     * In most cases this is the size provided by UI implementation of the {@link JComponent}.
     *
     * @return original {@link JComponent} minimum size before any adjustments
     */
    @NotNull
    public Dimension getOriginalMinimumSize ();

    /**
     * Sets {@link JComponent} minimum size.
     * This method is a simple bridge for {@link JComponent#setMinimumSize(Dimension)} method.
     *
     * @param width  {@link JComponent} minimum width
     * @param height {@link JComponent} minimum height
     * @return modified {@link JComponent}
     */
    @NotNull
    public C setMinimumSize ( int width, int height );
}