ScrollablePanel.java

/**
 * Copyright (c) 2005-2017, KoLmafia development team
 * http://kolmafia.sourceforge.net/
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  [1] Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *  [2] 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.
 *  [3] Neither the name "KoLmafia" 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 net.sourceforge.kolmafia.swingui.panel;

import java.awt.BorderLayout;
import java.awt.CardLayout;
import java.awt.Color;

import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.SwingConstants;

import net.java.dev.spellcast.utilities.ActionPanel;
import net.java.dev.spellcast.utilities.JComponentUtilities;

import net.sourceforge.kolmafia.StaticEntity;

import net.sourceforge.kolmafia.swingui.listener.ThreadedListener;

import net.sourceforge.kolmafia.swingui.widget.GenericScrollPane;

public class ScrollablePanel
	extends ActionPanel
{
	protected ConfirmedListener CONFIRM_LISTENER = new ConfirmedListener();
	protected CancelledListener CANCEL_LISTENER = new CancelledListener();

	public JPanel actualPanel;
	public JPanel centerPanel;

	public JPanel eastPanel;
	public VerifyButtonPanel buttonPanel;
	public JComponent scrollComponent;
	public JLabel titleComponent;
	public GenericScrollPane scrollPane;

	public ScrollablePanel( final String title, final JComponent scrollComponent )
	{
		this( title, null, null, scrollComponent );
	}

	public ScrollablePanel( final String title, final String confirmedText, final String cancelledText,
		final JComponent scrollComponent )
	{
		this( title, confirmedText, cancelledText, scrollComponent, true );
	}

	public ScrollablePanel( final String title, final String confirmedText, final String cancelledText,
		final JComponent scrollComponent, final boolean isRootPane )
	{
		this.scrollComponent = scrollComponent;

		this.centerPanel = new JPanel( new BorderLayout() );

		if ( !title.equals( "" ) )
		{
			this.titleComponent = JComponentUtilities.createLabel(
				title, SwingConstants.CENTER, Color.black, Color.white );
			this.centerPanel.add( this.titleComponent, BorderLayout.NORTH );
		}

		this.scrollPane = new GenericScrollPane( scrollComponent );
		this.centerPanel.add( scrollPane, BorderLayout.CENTER );
		this.actualPanel = new JPanel( new BorderLayout( 20, 10 ) );
		this.actualPanel.add( this.centerPanel, BorderLayout.CENTER );

		this.eastPanel = new JPanel( new BorderLayout() );

		if ( confirmedText != null )
		{
			this.buttonPanel = new VerifyButtonPanel( confirmedText, cancelledText, cancelledText, CONFIRM_LISTENER, CANCEL_LISTENER );
			this.buttonPanel.setBothDisabledOnClick( true );

			this.eastPanel.add( this.buttonPanel, BorderLayout.NORTH );
			this.actualPanel.add( this.eastPanel, BorderLayout.EAST );
		}

		JPanel containerPanel = new JPanel( new CardLayout( 10, 10 ) );
		containerPanel.add( this.actualPanel, "" );

		if ( isRootPane )
		{
			this.getContentPane().setLayout( new BorderLayout() );
			this.getContentPane().add( containerPanel, BorderLayout.CENTER );
		}
		else
		{
			this.setLayout( new BorderLayout() );
			this.add( containerPanel, BorderLayout.CENTER );
		}

		( (JPanel) this.getContentPane() ).setOpaque( true );
		StaticEntity.registerPanel( this );

		this.contentSet = true;
	}

	@Override
	public void setEnabled( final boolean isEnabled )
	{
		if ( this.scrollComponent == null || this.buttonPanel == null )
		{
			return;
		}

		this.scrollComponent.setEnabled( isEnabled );
		this.buttonPanel.setEnabled( isEnabled );
	}

	@Override
	public void actionConfirmed()
	{
	}

	@Override
	public void actionCancelled()
	{
	}

	@Override
	public void dispose()
	{
		if ( this.buttonPanel != null )
		{
			this.buttonPanel.dispose();
		}
	}

	private class ConfirmedListener
		extends ThreadedListener
	{
		@Override
		protected void execute()
		{
			if ( ScrollablePanel.this.contentSet )
			{
				ScrollablePanel.this.actionConfirmed();
			}
		}
	}

	private class CancelledListener
		extends ThreadedListener
	{
		@Override
		protected void execute()
		{
			if ( ScrollablePanel.this.contentSet )
			{
				ScrollablePanel.this.actionCancelled();
			}
		}
	}
}