org.kuali.student.common.ui.client.widgets.KSCheckBox.java Source code

Introduction

Here is the source code for org.kuali.student.common.ui.client.widgets.KSCheckBox.java

Source

/**
 * Copyright 2010 The Kuali Foundation Licensed under the
 * Educational Community License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License. You may
 * obtain a copy of the License at
 *
 * http://www.osedu.org/licenses/ECL-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an "AS IS"
 * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package org.kuali.student.common.ui.client.widgets;

import org.kuali.student.common.ui.client.util.DebugIdUtils;

import com.google.gwt.event.dom.client.BlurEvent;
import com.google.gwt.event.dom.client.BlurHandler;
import com.google.gwt.event.dom.client.FocusEvent;
import com.google.gwt.event.dom.client.FocusHandler;
import com.google.gwt.event.logical.shared.ValueChangeEvent;
import com.google.gwt.event.logical.shared.ValueChangeHandler;
import com.google.gwt.user.client.ui.CheckBox;

/**
 * KSCheckBox wraps gwt Checkbox.  This class provides most of the same functionality, but sets KS css styles
 * for its default look and a variety of checkbox events (for improved browser compatibility and customizability).
 * @author Kuali Student Team
 *
 */
public class KSCheckBox extends CheckBox {

    /**
     * Creates a check box with no label.
     *
     */
    public KSCheckBox() {
        super();
        setupDefaultStyle();
    }

    /**
     * Creates a check box with the specified text label.
     *
     * @param label the check box's label
     */
    public KSCheckBox(String label) {
        super(label);
        ensureDebugId(DebugIdUtils.createWebDriverSafeDebugId(label));
        setupDefaultStyle();
    }

    /**
     * This method sets the default style for the checkbox and checkbox events.
     *
     */
    private void setupDefaultStyle() {
        addStyleName("KS-Checkbox");

        this.addBlurHandler(new BlurHandler() {
            public void onBlur(BlurEvent event) {
                KSCheckBox.this.removeStyleName("KS-Checkbox-Focus");

            }
        });

        this.addFocusHandler(new FocusHandler() {
            public void onFocus(FocusEvent event) {
                KSCheckBox.this.addStyleName("KS-Checkbox-Focus");

            }
        });

        //hover does not function fully for check boxes as is
        /*        this.addMouseOverHandler(new MouseOverHandler(){
        public void onMouseOver(MouseOverEvent event) {
            KSCheckBox.this.addStyleName(KSStyles.KS_CHECKBOX_HOVER_STYLE);
            
        }
                });
            
                this.addMouseOutHandler(new MouseOutHandler(){
            
        public void onMouseOut(MouseOutEvent event) {
            KSCheckBox.this.removeStyleName(KSStyles.KS_CHECKBOX_HOVER_STYLE);
            
        }
            
                });*/

        this.addValueChangeHandler(new ValueChangeHandler<Boolean>() {
            @Override

            public void onValueChange(ValueChangeEvent<Boolean> event) {
                if (KSCheckBox.this.getValue()) {
                    KSCheckBox.this.addStyleName("KS-Checkbox-Checked");
                } else {
                    KSCheckBox.this.removeStyleName("KS-Checkbox-Checked");
                    KSCheckBox.this.setFocus(false);
                }
            }
        });
    }

}