/* $Id: SplashScreen.java 18817 2010-10-27 15:52:25Z tfmorris $
*****************************************************************************
* Copyright (c) 2009 Contributors - see below
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* tfmorris
*****************************************************************************
*
* Some portions of this file was previously release using the BSD License:
*/
// Copyright (c) 1996-2006 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
package org.argouml.ui;
import java.awt.BorderLayout;
import java.awt.Cursor;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.GraphicsEnvironment;
import java.awt.Point;
import javax.swing.JPanel;
import javax.swing.JWindow;
import javax.swing.border.EtchedBorder;
import org.argouml.taskmgmt.ProgressEvent;
import org.argouml.taskmgmt.ProgressMonitor;
import org.tigris.gef.ui.IStatusBar;
/**
* The splash screen.
*/
public class SplashScreen extends JWindow implements IStatusBar, ProgressMonitor {
private StatusBar statusBar = new StatusBar();
/**
* Flag indicating that the splash screen has been painted.
*/
private boolean paintCalled = false;
/**
* The constructor.
*/
public SplashScreen() {
this("Splash");
}
/**
* The constructor.
*
* @param title the title of the window
* @param iconName the icon for the window
*/
private SplashScreen(String iconName) {
super();
setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
getContentPane().setLayout(new BorderLayout(0, 0));
SplashPanel panel = new SplashPanel(iconName);
if (panel.getImage() != null) {
int imgWidth = panel.getImage().getIconWidth();
int imgHeight = panel.getImage().getIconHeight();
Point scrCenter = GraphicsEnvironment.getLocalGraphicsEnvironment()
.getCenterPoint();
setLocation(scrCenter.x - imgWidth / 2,
scrCenter.y - imgHeight / 2);
}
JPanel splash = new JPanel(new BorderLayout());
splash.setBorder(new EtchedBorder(EtchedBorder.RAISED));
splash.add(panel, BorderLayout.CENTER);
splash.add(statusBar, BorderLayout.SOUTH);
getContentPane().add(splash);
// add preloading progress bar?
Dimension contentPaneSize = getContentPane().getPreferredSize();
setSize(contentPaneSize.width, contentPaneSize.height);
pack();
}
/**
* @return the status bar of this dialog
* @deprecated for 0.31.7 by tfmorris. Use methods from the
* {@link IStatusBar} interface implemented by this class
* e.g. {@link #showStatus(String)}/
*/
@Deprecated
public StatusBar getStatusBar() {
return statusBar;
}
/*
* @see org.tigris.gef.ui.IStatusBar#showStatus(java.lang.String)
*/
public void showStatus(String s) {
statusBar.showStatus(s);
}
/*
* Override paint so we can set a flag the first time we're called
* and notify any waiting threads that the splash screen has been
* painted.
* @see java.awt.Component#paint(java.awt.Graphics)
*/
@Override
public void paint(Graphics g) {
super.paint(g);
if (!paintCalled) {
synchronized (this) {
paintCalled = true;
notifyAll();
}
}
}
/**
* @param called true if paint() is already called
*/
public void setPaintCalled(boolean called) {
this.paintCalled = called;
}
/**
* @return true if paint() is already called
*/
public boolean isPaintCalled() {
return paintCalled;
}
public void progress(ProgressEvent event) throws InterruptedException {
statusBar.progress(event);
}
public void updateProgress(int progress) {
statusBar.updateProgress(progress);
}
public void updateSubTask(String name) {
statusBar.updateSubTask(name);
}
public void updateMainTask(String name) {
statusBar.updateMainTask(name);
}
public boolean isCanceled() {
return false;
}
public void setMaximumProgress(int max) {
statusBar.setMaximumProgress(max);
}
public void notifyNullAction() {
// ignored - will never be called
}
public void notifyMessage(String title, String introduction, String message) {
// TODO: Auto-generated method stub
}
public void close() {
// TODO: Auto-generated method stub
}
}