animationthread.java

j2me is based on j2mepolish, client & server for mobile application. menu sample

//#condition polish.usePolishGui
/*
 * Created on 15-Mar-2004 at 10:52:57.
 *
 * Copyright (c) 2004-2005 Robert Virkus / Enough Software
 *
 * This file is part of J2ME Polish.
 *
 * J2ME Polish 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 2 of the License, or
 * (at your option) any later version.
 * 
 * J2ME Polish 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 J2ME Polish; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * Commercial licenses are also available, please
 * refer to the accompanying LICENSE.txt or visit
 * http://www.j2mepolish.org for details.
 */
package de.enough.polish.ui;


import javax.microedition.lcdui.Displayable;

import de.enough.polish.util.ArrayList;

/**
 * <p>Is used to animate Screens, Backgrounds and Items.</p>
 * <p>
 * 	You can specify the animation interval in milliseconds in the variables section of
 *  your build.xml script.
 *  Example:
 *  <pre>
 *  <variables>
 *		<variable name="polish.animationInterval" value="200" />
 *	</variables>
 * 	</pre> 
 *  sets the interval to 200 ms. When not specified, the default interval
 *  of 100 ms will be used. 
 * </p>
 * <p>Copyright Enough Software 2004, 2005</p>

 * <pre>
 * history
 *        15-Mar-2004 - rob creation
 * </pre>
 * @author Robert Virkus, [e-mail]
 */
public class AnimationThread extends Thread
{
	
	//#ifdef polish.animationInterval:defined
		//#= public final static int ANIMATION_INTERVAL = ${polish.animationInterval};
	//#else
		public final static int ANIMATION_INTERVAL = 100;
	//#endif
		//#ifdef polish.sleepInterval:defined
		//#= private final static int SLEEP_INTERVAL = ${polish.sleepInterval};
	//#else
		private final static int SLEEP_INTERVAL = 300;
	//#endif
	protected static boolean releaseResourcesOnScreenChange;
	private static ArrayList animationList;
	
	/**
	 * Creates a new animation thread.
	 */
	public AnimationThread() {
		//#if polish.cldc1.1 && polish.debug.error
			//# super("AnimationThread");
		//#else
			super();
		//#endif
		
		//#if polish.blackberry and false
			//# // # Application app = Application.getApplication();
			//# // # app.addKeyListener( this );
			//# // # app.addTrackwheelListener( this );
		//#endif
	}
	
	/**
	 * Animates the current screen.
	 */
	public void run() {
		long sleeptime = ANIMATION_INTERVAL;
//		int animationCounter = 0;
		while ( true ) {
			try {
				Thread.sleep(sleeptime);
				Screen screen = StyleSheet.currentScreen;
				if (screen != null) {
					boolean animated = screen.animate();
					if (animated) {
						//System.out.println("AnimationThread: screen needs repainting");
						//#if polish.Bugs.displaySetCurrentFlickers && polish.useFullScreen
							//# if ( MasterCanvas.instance != null ) {
								//# MasterCanvas.instance.repaint();
							//# }
						//#else
							screen.repaint();					
						//#endif
						
						sleeptime = ANIMATION_INTERVAL;
					}
					if (animationList != null) {
						Object[] animationItems = animationList.getInternalArray();
						for (int i = 0; i < animationItems.length; i++) {
							Item item = (Item) animationItems[i];
							if (item == null) {
								break;
							}
							
							if ( item.animate() ) {
								// repaint only area of item:
								item.repaint();
							}
						}
					}

					if (releaseResourcesOnScreenChange) {
						Displayable d = StyleSheet.display.getCurrent();
						if (d != screen) {
							StyleSheet.currentScreen = null;
						}
					}
				} else {
					if (releaseResourcesOnScreenChange) {
						StyleSheet.releaseResources();
						releaseResourcesOnScreenChange = false;
					}
					sleeptime = SLEEP_INTERVAL;
				}
			} catch (InterruptedException e) {
				// ignore
			} catch (Throwable e) {
				//#debug error
				//# System.out.println("unable to animate screen" + e );
				e.printStackTrace();
			}
		}
	}

	/**
	 * Adds the given item to list of items that should be animated.
	 * Typically an item adds itself to the list in the showNotify() method and
	 * then de-registers itself in the hideNotify() method.
	 *  
	 * @param item the item that needs to be animated regardless of it's focused state etc.
	 * @see #removeAnimationItem(Item)
	 */
	public static void addAnimationItem( Item item ) {
		if (animationList == null) {
			animationList = new ArrayList();
		}
		if (!animationList.contains(item)) {
			animationList.add( item );
		}
	}

	//#if polish.LibraryBuild
	//# /**
	 //# * Adds the given item to list of items that should be animated.
	 //# * Typically an item adds itself to the list in the showNotify() method and
	 //# * then de-registers itself in the hideNotify() method.
	 //# *  
	 //# * @param item the item that needs to be animated regardless of it's focused state etc.
	 //# * @see #removeAnimationItem(javax.microedition.lcdui.CustomItem)
	 //# */
	//# public static void addAnimationItem( javax.microedition.lcdui.CustomItem item) {
		//# // ignore
	//# }
	//#endif

	/**
	 * Removes the given item to list of items that should be animated.
	 * Typically an item adds itself to the list in the showNotify() method and
	 * then de-registers itself in the hideNotify() method.
	 *  
	 * @param item the item that does not need to be animated anymore
	 * @see #addAnimationItem(Item)
	 */
	public static void removeAnimationItem( Item item ) {
		if (animationList != null) {
			animationList.remove(item);
		}
	}

	//#if polish.LibraryBuild
	//# /**
	 //# * Removes the given item to list of items that should be animated.
	 //# * Typically an item adds itself to the list in the showNotify() method and
	 //# * then de-registers itself in the hideNotify() method.
	 //# *  
	 //# * @param item the item that does not need to be animated anymore
	 //# * @see #addAnimationItem(javax.microedition.lcdui.CustomItem)
	 //# */
	//# public static void removeAnimationItem( javax.microedition.lcdui.CustomItem item) {
		//# // ignore
	//# }
	//#endif

}