com.alee.laf.splitpane.SplitPaneState 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.laf.splitpane;

import com.alee.api.merge.Mergeable;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;

import javax.swing.*;
import java.io.Serializable;

/**
 * {@link JSplitPane} state holder.
 *
 * @author Mikle Garin
 * @see How to use SettingsManager
 * @see SplitPaneSettingsProcessor
 * @see com.alee.managers.settings.UISettingsManager
 * @see com.alee.managers.settings.SettingsManager
 * @see com.alee.managers.settings.SettingsProcessor
 */
@XStreamAlias ( "SplitPaneState" )
public class SplitPaneState implements Mergeable, Cloneable, Serializable
{
    /**
     * {@link JSplitPane} divider location.
     */
    @XStreamAsAttribute
    protected final Integer dividerLocation;

    /**
     * Constructs default {@link SplitPaneState}.
     */
    public SplitPaneState ()
    {
        this ( ( Integer ) null );
    }

    /**
     * Constructs new {@link SplitPaneState} with settings from {@link JSplitPane}.
     *
     * @param splitPane {@link JSplitPane} to retrieve settings from
     */
    public SplitPaneState ( final JSplitPane splitPane )
    {
        this ( splitPane.getDividerLocation () );
    }

    /**
     * Constructs new {@link SplitPaneState} with specified settings.
     *
     * @param dividerLocation {@link JSplitPane} divider location
     */
    public SplitPaneState ( final Integer dividerLocation )
    {
        this.dividerLocation = dividerLocation;
    }

    /**
     * Returns {@link JSplitPane} divider location.
     *
     * @return {@link JSplitPane} divider location
     */
    public Integer dividerLocation ()
    {
        return dividerLocation;
    }

    /**
     * Applies this {@link SplitPaneState} to the specified {@link JSplitPane}.
     *
     * @param splitPane {@link JSplitPane} to apply this {@link SplitPaneState} to
     */
    public void apply ( final JSplitPane splitPane )
    {
        if ( dividerLocation != null )
        {
            splitPane.setDividerLocation ( dividerLocation );
        }
    }
}