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

Introduction

Here is the source code for org.kuali.student.common.ui.client.widgets.KSLabel.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.user.client.ui.Label;

/**
 * KSLabel wraps gwt Label.  This class provides most of the same functionality, but sets KS css styles
 * for its default look (for improved browser compatibility and customizability).
 *
 * @author Kuali Student Team
 *
 */
public class KSLabel extends Label {
    /**
     * Creates an empty label.
     *
     */
    public KSLabel() {
        super();
        setupDefaultStyle();
    }

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

    /**
     * Creates a label with the specified text and sets the word wrap flag.
     * False will disable word wrap, otherwise word wrap will be enabled.
     *
     * @param text the new label's text
     * @param wordWrap false to disable word wrapping
     */
    public KSLabel(String text, boolean wordWrap) {
        super(text, wordWrap);
        ensureDebugId(DebugIdUtils.createWebDriverSafeDebugId(text));
        setupDefaultStyle();
    }

    /**
     * This method sets the default style for labels.
     *
     */
    private void setupDefaultStyle() {
        addStyleName("KS-Label");
        //cant think of why you would need a default hover style for labels
    }
}