001: /*
002: *
003: *
004: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: */
026:
027: package com.sun.midp.chameleon;
028:
029: import javax.microedition.lcdui.Command;
030: import javax.microedition.lcdui.CommandListener;
031:
032: /**
033: * The SubMenuCommand is an extension of LCDUI's Command object.
034: * It represents a collection of Commands which should be made
035: * available as a type of "sub menu" under a single Command heading.
036: */
037: public class SubMenuCommand extends Command {
038:
039: /** An array holding the Commands that are part of the "submenu". */
040: protected Command[] subCommands;
041:
042: /** The CommandListener to notify when a sub command is selected. */
043: protected CommandListener listener;
044:
045: /**
046: * Creates a new command object with the given short
047: *
048: * <a href="#label">label</a>,
049: * <a href="#type">type</a>, and
050: * <a href="#priority">priority</a>.
051: *
052: * The newly created command has no long label. This constructor is
053: * identical to <code>Command(label, null, commandType, priority)</code>.
054: *
055: * @param label the command's short label
056: * @param commandType the command's type
057: * @param priority the command's priority value
058: *
059: * @throws NullPointerException if label is <code>null</code>
060: * @throws IllegalArgumentException if the <code>commandType</code>
061: * is an invalid type
062: *
063: * @see #Command(String, String, int, int)
064: */
065: public SubMenuCommand(String label, int commandType, int priority) {
066: super (label, commandType, priority);
067: }
068:
069: /**
070: * Creates a new command object with the given
071: * <a href="#label">labels</a>,
072: * <a href="#type">type</a>, and
073: * <a href="#priority">priority</a>.
074: *
075: * <p>The short label is required and must not be
076: * <code>null</code>. The long label is
077: * optional and may be <code>null</code> if the command is to have
078: * no long label.</p>
079: *
080: * @param shortLabel the command's short label
081: * @param longLabel the command's long label, or <code>null</code> if none
082: * @param commandType the command's type
083: * @param priority the command's priority value
084: *
085: * @throws NullPointerException if <code>shortLabel</code> is
086: * <code>null</code>
087: * @throws IllegalArgumentException if the <code>commandType</code> is an
088: * invalid type
089: */
090: public SubMenuCommand(String shortLabel, String longLabel,
091: int commandType, int priority) {
092: super (shortLabel, longLabel, commandType, priority);
093: }
094:
095: /**
096: * Removes all commands that are currently in the list of sub commands.
097: */
098: public synchronized void removeAll() {
099: subCommands = null;
100: }
101:
102: /**
103: * Adds the given Command to the list of sub commands.
104: *
105: * @param cmd The Command to add to the current list of submenu commands
106: *
107: * @throws IllegalArgumentException if the given Command is null
108: */
109: public synchronized void addSubCommand(Command cmd) {
110: if (cmd == null) {
111: throw new IllegalArgumentException("Added command was null");
112: }
113:
114: if (subCommands == null) {
115: subCommands = new Command[] { cmd };
116: } else {
117: Command[] newCommands = new Command[subCommands.length + 1];
118: System.arraycopy(subCommands, 0, newCommands, 0,
119: subCommands.length);
120: newCommands[subCommands.length] = cmd;
121: subCommands = newCommands;
122: newCommands = null;
123: }
124: }
125:
126: /**
127: * Adds the given set of Commands to the list of sub commands.
128: *
129: * @param cmds An array of Commands to add to the current list of
130: * submenu commands
131: *
132: * @throws IllegalArgumentException if the given array is null
133: */
134: public synchronized void addSubCommands(Command[] cmds) {
135: if (cmds == null) {
136: throw new IllegalArgumentException(
137: "Added command array was null");
138: }
139:
140: if (subCommands == null) {
141: subCommands = new Command[cmds.length];
142: System.arraycopy(cmds, 0, subCommands, 0, cmds.length);
143: } else {
144: Command[] newCommands = new Command[subCommands.length
145: + cmds.length];
146: System.arraycopy(subCommands, 0, newCommands, 0,
147: subCommands.length);
148: System.arraycopy(cmds, 0, newCommands, subCommands.length,
149: cmds.length);
150: subCommands = newCommands;
151: newCommands = null;
152: }
153: }
154:
155: /**
156: * Retrieves the set of subcommands from this SubMenuCommand.
157: * This method will return a copy of the internal array holding
158: * the set of sub menu Commands.
159: *
160: * @return an array holding the set of Commands to be shown
161: * on the "submenu" for this SubMenuCommand. 'null'
162: * means this SubMenuCommand has no sub commands.
163: */
164: public synchronized Command[] getSubCommands() {
165: if (subCommands == null) {
166: return null;
167: }
168:
169: Command[] cmdCopy = new Command[subCommands.length];
170: System
171: .arraycopy(subCommands, 0, cmdCopy, 0,
172: subCommands.length);
173: return cmdCopy;
174: }
175:
176: /**
177: * Sets the CommandListener of this SubMenuCommand to notify when one
178: * of the sub commands is selected.
179: *
180: * @param listener the CommandListener to notify when a sub command is
181: * selected
182: */
183: public void setListener(CommandListener listener) {
184: this .listener = listener;
185: }
186:
187: /**
188: * Called to notify the CommandListener of this SubMenuCommand that
189: * a sub command has been selected.
190: *
191: * @param c the Command that was selected
192: */
193: public synchronized void notifyListener(Command c) {
194: if (listener != null) {
195: listener.commandAction(c, null);
196: }
197: }
198: }
|