zxing.appspot.com/generator/src/com/google/zxing/web/generator/client/GeneratorSource.java

   1 /*
   2  * Copyright (C) 2008 ZXing authors
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.google.zxing.web.generator.client;
  18
  19 import com.google.gwt.user.client.ui.Grid;
  20 import com.google.gwt.user.client.ui.Widget;
  21
  22 /**
  23  * Base interface for any generator.
  24  *
  25  * @author Yohann Coppel
  26  */
  27 public interface GeneratorSource {
  28   /**
  29    * @return a GWT Grid object, containing the GUI.
  30    */
  31   Grid getWidget();
  32   /**
  33    * @return the name of the generator to be used in the GUI.
  34    */
  35   String getName();
  36   /**
  37    * @return the text to be encoded into the QR code.
  38    * @throws GeneratorException if the input data contains errors.
  39    */
  40   String getText() throws GeneratorException;
  41   /**
  42    * @param widget the widget that was last modified, and that we want to
  43    *        validate the content.
  44    * @throws GeneratorException if the widget contains errors.
  45    */
  46   void validate(Widget widget) throws GeneratorException;
  47   /**
  48    * Called when the generator is selected in the list. Using this method,
  49    * the generator should set the focus to the first widget it defines.
  50    */
  51   void setFocus();
  52 }