com.alee.extended.dock.WDockableFrameUI 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.extended.dock;

import com.alee.api.data.CompassDirection;
import com.alee.laf.WebUI;
import com.alee.utils.LafUtils;

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

/**
 * Pluggable look and feel interface for {@link WebDockableFrame} component.
 *
 * @param  component type
 * @author Mikle Garin
 * @see How to use WebDockablePane
 * @see WebDockablePane
 */
public abstract class WDockableFrameUI extends ComponentUI implements WebUI
{
    /**
     * Runtime variables.
     */
    protected C frame;

    @Override
    public String getPropertyPrefix ()
    {
        return "DockableFrame.";
    }

    @Override
    public void installUI ( final JComponent c )
    {
        // Saving dockable frame reference
        frame = ( C ) c;

        // Installing default component settings
        installDefaults ();

        // Installing default component listeners
        installListeners ();
    }

    @Override
    public void uninstallUI ( final JComponent c )
    {
        // Uninstalling default component listeners
        uninstallListeners ();

        // Uninstalling default component settings
        uninstallDefaults ();

        // Removing dockable frame reference
        frame = null;
    }

    /**
     * Installs default component settings.
     */
    protected void installDefaults ()
    {
        LafUtils.installDefaults ( frame, getPropertyPrefix () );
        frame.setFocusCycleRoot ( true );
        frame.setState ( DockableFrameState.docked );
        frame.setMaximized ( false );
        frame.setRestoreState ( DockableFrameState.docked );
        frame.setPosition ( CompassDirection.west );
        frame.setDraggable ( true );
        frame.setClosable ( true );
        frame.setFloatable ( true );
        frame.setMaximizable ( true );
    }

    /**
     * Uninstalls default component settings.
     */
    protected void uninstallDefaults ()
    {
        LafUtils.uninstallDefaults ( frame );
    }

    /**
     * Installs default component listeners.
     */
    protected void installListeners ()
    {
        /**
         * Do nothing by default.
         */
    }

    /**
     * Uninstalls default component listeners.
     */
    protected void uninstallListeners ()
    {
        /**
         * Do nothing by default.
         */
    }

    /**
     * Returns sidebar button for this frame.
     * Sidebar button usually acts as a frame tab on the sidebar.
     *
     * @return sidebar button for this frame
     */
    public abstract JComponent getSidebarButton ();

    /**
     * Returns minimum frame dialog size.
     *
     * @return minimum frame dialog size
     */
    public abstract Dimension getMinimumDialogSize ();
}