javax.microedition.lcdui.Command Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microemu-midp Show documentation
midp
There is a newer version: 2.0.4
/*
 *  MicroEmulator
 *  Copyright (C) 2001 Bartek Teodorczyk 
 *  Copyright (C) 2005 Andres Navarro
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package javax.microedition.lcdui;

import org.microemu.device.DeviceFactory;
import org.microemu.device.ui.CommandUI;

public class Command {

	public static final int SCREEN = 1;

	public static final int BACK = 2;

	public static final int CANCEL = 3;

	public static final int OK = 4;

	public static final int HELP = 5;

	public static final int STOP = 6;

	public static final int EXIT = 7;

	public static final int ITEM = 8;

	// this is needed to allow for item commands without 
	// breaking the existing interfaces
	// (yeah i know it's ugly) 
	// Andres Navarro
	private Command originalCommand;

	private Item focusedItem;

	private Command itemCommand;

	String label;

	int commandType;

	int priority;
	
	CommandUI ui;

	public Command(String label, int commandType, int priority) {
		this.label = label;
		this.commandType = commandType;
		this.priority = priority;
		
		this.ui = DeviceFactory.getDevice().getUIFactory().createCommandUI(this);
	}

	public Command(String shortLabel, String longLabel, int commandType, int priority) {
		// TODO implement
		this(shortLabel, commandType, priority);
	}

	public int getCommandType() {
		return commandType;
	}

	public String getLabel() {
		return label;
	}

	public String getLongLabel() {
		// TODO implement;
		return label;
	}

	public int getPriority() {
		return priority;
	}	
	
	/**
	 * @since MIDP 3.0
	 */
	public void setImage(Image image) {
		ui.setImage(image);
	}

	Item getFocusedItem() {
		if (isRegularCommand()) {
			throw new IllegalStateException();
		}
		// can't be null!
		return focusedItem;
	}

	Command getItemCommand(Item item) {
		if (!isRegularCommand()) {
			throw new IllegalStateException();
		}
		if (item == null) {
			throw new NullPointerException();
		}
		// we are allowed by the spec to threat all commands containes
		// in an Item as of the type ITEM
		if (itemCommand == null) {
			itemCommand = new Command(getLabel(), Command.ITEM, getPriority());
			itemCommand.originalCommand = this;
		}
		itemCommand.focusedItem = item;
		return itemCommand;
	}

	Command getOriginalCommand() {
		if (isRegularCommand()) {
			throw new IllegalStateException();
		}
		// can't be null!
		return originalCommand;
	}

	boolean isRegularCommand() {
		return originalCommand == null;
	}
}