com.google.gwt.user.client.ui.NumberLabel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vaadin-client Show documentation

Vaadin is a web application framework for Rich Internet Applications (RIA). Vaadin enables easy development and maintenance of fast and secure rich web applications with a stunning look and feel and a wide browser support. It features a server-side architecture with the majority of the logic running on the server. Ajax technology is used at the browser-side to ensure a rich and interactive user experience.

There is a newer version: 8.27.1

Show newest version

/*
 * Copyright 2010 Google Inc.
 * 
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-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 com.google.gwt.user.client.ui;

import com.google.gwt.i18n.client.NumberFormat;
import com.google.gwt.text.client.NumberFormatRenderer;

/**
 * Extends {@link ValueLabel} for convenience when dealing with numbers and
 * {@link NumberFormat}, especially in
 * {@link com.google.gwt.uibinder.client.UiBinder UiBinder} templates. (Note
 * that this class does not accept renderers. To do so use {@link ValueLabel}
 * directly.)
 * 
 * Use in UiBinder Templates In
 * {@link com.google.gwt.uibinder.client.UiBinder UiBinder} templates, the
 * {@link NumberFormat} can be specified with one of these attributes:
 * 
 * format
 * a reference to a {@link NumberFormat} instance.
 * predefinedFormat
 * a predefined format (see below for the list of acceptable values).
 * customFormat
 * a number format pattern that can be passed to
 * {@link NumberFormat#getFormat(String)}. See below for a way of specifying a
 * currency code.
 * 
 * The valid values for the {@code predefinedFormat} attributes are:
 * 
 * DECIMAL
 * the standard decimal format for the current locale, as given by
 * {@link NumberFormat#getDecimalFormat()}.
 * CURRENCY
 * the standard currency format for the current locale, as given by
 * {@link NumberFormat#getCurrencyFormat()}. See below for a way of specifying a
 * currency code.
 * PERCENT
 * the standard percent format for the current locale, as given by
 * {@link NumberFormat#getPercentFormat()}.
 * SCIENTIFIC
 * the standard scientific format for the current locale, as given by
 * {@link NumberFormat#getScientificFormat()}.
 * 
 * When using {@code predefinedFormat="CURRENCY"} or a {@code customFormat}, you
 * can specify a currency code using either of the following attributes:
 * 
 * currencyData
 * a reference to a {@link com.google.gwt.i18n.client.CurrencyData
 * CurrencyData} instance.
 * currencyCode
 * an ISO4217 currency code.
 * 
 * 
 * @param  The exact type of number
 */
public class NumberLabel extends ValueLabel {

  public NumberLabel() {
    super(new NumberFormatRenderer());
  }

  public NumberLabel(NumberFormat format) {
    super(new NumberFormatRenderer(format));
  }
}