View Javadoc

1   /**
2    * Copyright 2010 The Kuali Foundation Licensed under the
3    * Educational Community License, Version 2.0 (the "License"); you may
4    * not use this file except in compliance with the License. You may
5    * obtain a copy of the License at
6    *
7    * http://www.osedu.org/licenses/ECL-2.0
8    *
9    * Unless required by applicable law or agreed to in writing,
10   * software distributed under the License is distributed on an "AS IS"
11   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12   * or implied. See the License for the specific language governing
13   * permissions and limitations under the License.
14   */
15  
16  package org.kuali.student.common.ui.client.widgets;
17  
18  
19  import org.kuali.student.common.ui.client.widgets.impl.KSProgressIndicatorImpl;
20  
21  import com.google.gwt.core.client.GWT;
22  
23  /**
24   * KSProgressIndicator can be shown to indicate processing of some request.  It can then be hidden again, to
25   * indicate process completion.
26   * 
27   * The indicator contains a twiddler/spinner image and a text label.
28   * 
29   * @author Kuali Student Team
30   *
31   */
32  public class KSProgressIndicator extends KSProgressIndicatorAbstract{ 
33      KSProgressIndicatorAbstract indicator = GWT.create(KSProgressIndicatorImpl.class);
34      
35      public KSProgressIndicator() {
36          this.initWidget(indicator);
37          
38      }
39  
40      /**
41       * Hides the progress indicator.
42       * 
43       */
44      @Override
45      public void hide() {
46          indicator.hide();
47          
48      }
49  
50      /**
51       * Shows the progress indicator.
52       * 
53       */
54      @Override
55      public void show() {
56          indicator.show();
57          
58      }
59  
60      /**
61       * Sets the text for the progress indicator, explaining what is being processed.
62       * 
63       * @param labelText the text/title of the progress indicator
64       */
65      @Override
66      public void setText(String labelText) {
67          indicator.setText(labelText);
68          
69      }
70  
71  
72  }