com.alee.managers.style.MarginSupport 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 is a Java Swing Look and Feel and extended components library for cross-platform applications

There is a newer version: 2.2.1

package com.alee.managers.style;

import java.awt.*;

/**
 * This interface is implemented by components and UIs which support customizable margin.
 * Margin is a spacing between component bounds and its visible decoration.
 * 
 * Margin is supported through custom borders in WebLaF-decorated components.
 * Be aware that if you specify your own border into those components this option will have no effect.
 *
 * @author Mikle Garin
 */

public interface MarginSupport
{
    /**
     * Empty margin.
     */
    public static Insets EMPTY = null;

    /**
     * Returns current margin.
     * Might return null which is basically the same as an empty [0,0,0,0] margin.
     *
     * @return current margin
     */
    public Insets getMargin ();

    /**
     * Sets new margin.
     * {@code null} can be provided to set an empty [0,0,0,0] margin.
     *
     * @param margin new margin
     */
    public void setMargin ( Insets margin );
}