View Javadoc

1   /***
2    * Redistribution  and use  in source  and binary  forms, with  or without
3    * modification, are permitted provided  that the following conditions are
4    * met :
5    *
6    * . Redistributions  of  source  code  must  retain  the  above copyright
7    *   notice, this list of conditions and the following disclaimer.
8    *
9    * . Redistributions in  binary form  must reproduce  the above  copyright
10   *   notice, this list of conditions  and the following disclaimer in  the
11   *   documentation and/or other materials provided with the distribution.
12   *
13   * . The name of the author may not be used to endorse or promote products
14   *   derived from this software without specific prior written permission.
15   *
16   * THIS SOFTWARE IS  PROVIDED BY THE  AUTHOR ``AS IS''  AND ANY EXPRESS  OR
17   * IMPLIED  WARRANTIES,  INCLUDING,  BUT   NOT  LIMITED  TO,  THE   IMPLIED
18   * WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE ARE
19   * DISCLAIMED.  IN NO  EVENT SHALL  THE AUTHOR  BE LIABLE  FOR ANY  DIRECT,
20   * INDIRECT,  INCIDENTAL,  SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL  DAMAGES
21   * (INCLUDING,  BUT  NOT LIMITED  TO,  PROCUREMENT OF  SUBSTITUTE  GOODS OR
22   * SERVICES;  LOSS  OF USE,  DATA,  OR PROFITS;  OR  BUSINESS INTERRUPTION)
23   * HOWEVER CAUSED  AND ON  ANY THEORY  OF LIABILITY,  WHETHER IN  CONTRACT,
24   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25   * ANY  WAY  OUT OF  THE  USE OF  THIS  SOFTWARE, EVEN  IF  ADVISED OF  THE
26   * POSSIBILITY OF SUCH DAMAGE.
27   *
28   * $Id$
29   */
30  
31  package palmed.ui;
32  
33  import javax.microedition.lcdui.Command;
34  import javax.microedition.lcdui.CommandListener;
35  import javax.microedition.lcdui.Displayable;
36  import javax.microedition.lcdui.TextField;
37  
38  /***
39   * This dialog prompts the user for a string input.
40   *
41   * @author Mathieu Champlon
42   * @version $Revision$ $Date$
43   */
44  public class InputDialog extends Dialog implements CommandListener
45  {
46      /***
47       * The maximum number of characters in the input field.
48       */
49      private static final int INPUT_MAX_SIZE = 256;
50      /***
51       * The validation command.
52       */
53      private final Command okCommand_ = new Command( "Ok", Command.OK, 1 );
54      /***
55       * The cancelation command.
56       */
57      private final Command cancelCommand_ = new Command( "Cancel", Command.CANCEL, 1 );
58      /***
59       * The listener.
60       */
61      private final IInputListener listener_;
62      /***
63       * The input text field.
64       */
65      private final TextField text_;
66  
67      /***
68       * Create a dialog for user input.
69       *
70       * @param title the form title
71       * @param description the message describing what the user has to enter
72       * @param listener the listener to receive user callbacks
73       */
74      public InputDialog( final String title, final String description, final IInputListener listener )
75      {
76          super( title );
77          if( listener == null )
78              throw new IllegalArgumentException( "parameter 'listener' is null" );
79          appendMessage( description );
80          text_ = new TextField( null, null, INPUT_MAX_SIZE, TextField.ANY );
81          append( text_ );
82          addCommand( okCommand_ );
83          addCommand( cancelCommand_ );
84          setCommandListener( this );
85          listener_ = listener;
86      }
87  
88      /***
89       * {@inheritDoc}
90       */
91      public final void commandAction( final Command command, final Displayable displayable )
92      {
93          if( command == okCommand_ )
94              listener_.enter( text_.getString() );
95          else
96              listener_.cancel();
97          text_.setString( "" );
98      }
99  }