Replace deprecated DOM.setElementAttribute().

[online-glom:gwt-glom.git] / src / main / java / org / glom / web / client / Utils.java

/*
 * Copyright (C) 2011 Openismus GmbH
 *
 * This file is part of GWT-Glom.
 *
 * GWT-Glom is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * GWT-Glom is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with GWT-Glom.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.glom.web.client;

import org.glom.web.shared.DataItem;
import org.glom.web.shared.TypedDataItem;
import org.glom.web.shared.libglom.Field.GlomFieldType;
import org.glom.web.shared.libglom.NumericFormat;

import com.google.gwt.core.client.GWT;
import com.google.gwt.dom.client.Document;
import com.google.gwt.dom.client.Style.Visibility;
import com.google.gwt.i18n.client.LocaleInfo;
import com.google.gwt.i18n.client.NumberFormat;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.ui.Widget;

/**
 *
 */
public class Utils {

        public static NumberFormat getNumberFormat(final NumericFormat numericFormat) {

                final StringBuilder pattern = new StringBuilder("0.");

                // add pattern for thousands separator
                if (numericFormat.getUseThousandsSeparator()) {
                        pattern.insert(0, "#,##");
                }

                // add pattern for restricted decimal places
                if (numericFormat.getDecimalPlacesRestricted()) {
                        for (int i = 0; i < numericFormat.getDecimalPlaces(); i++) {
                                pattern.append('0');
                        }
                } else {
                        // The default precision in libglom is 15.
                        pattern.append("###############");
                }

                // TODO use exponential numbers when more than 15 decimal places

                return NumberFormat.getFormat(pattern.toString());

        }

        /**
         * Get the vertical height with decorations (i.e. CSS) by temporarily adding the widget to the body element of the
         * document in a transparent container. This is required because the size information is only available when the
         * widget is attached to the DOM.
         * 
         * This method must be called before the widget is added to its container because it will be removed from any
         * container it is already inside. TODO: Fix this problem by saving a reference to its parent and re-addding it
         * after the height information has been calculated.
         * 
         * @param widget
         *            get the height information for this widget
         * @return the height of the widget with styling applied
         */
        public static int getWidgetHeight(final Widget widget) {
                final Document doc = Document.get();
                com.google.gwt.dom.client.Element div = doc.createDivElement();

                // Hidden elements are invisible, don't respond to events, and are not part of the tab order. But they will take
                // up space.
                div.getStyle().setVisibility(Visibility.HIDDEN);
                div.appendChild(widget.getElement().<com.google.gwt.dom.client.Element> cast());

                doc.getBody().appendChild(div);
                final int height = widget.getOffsetHeight();
                doc.getBody().removeChild(div);
                div = null;

                return height;
        }

        public static TypedDataItem getTypedDataItem(final GlomFieldType glomFieldType, final DataItem dataItem) {
                final TypedDataItem primaryKeyItem = new TypedDataItem();
                switch (glomFieldType) {
                case TYPE_BOOLEAN:
                        primaryKeyItem.setBoolean(dataItem.getBoolean());
                        break;
                case TYPE_NUMERIC:
                        primaryKeyItem.setNumber(dataItem.getNumber());
                        break;
                case TYPE_TEXT:
                        primaryKeyItem.setText(new String(dataItem.getText() == null ? "" : dataItem.getText()));
                        break;
                default:
                        GWT.log("getTypedDataItem(): Unsupported Glom Field Type: " + glomFieldType);
                        break;
                }

                return primaryKeyItem;
        }

        public static String getCurrentLocaleID() {
                String localeID = LocaleInfo.getCurrentLocale().getLocaleName();
                if (localeID.equals("default")) {
                        localeID = ""; // This is how libglom refers to the default locale.
                }

                if (StringUtils.isEmpty(localeID)) {
                        // LocaleInfo.getCurrentLocale() returns "default" even if a real locale was specified in the URL,
                        // if the locale is not specified as supported in our OnlineGlom.gwt.xml file,
                        // but people could use locales in .glom files that we have not thought of,
                        // so we should allow their use by getting the query parameter value directly:
                        final String paramValue = Window.Location.getParameter(LocaleInfo.getLocaleQueryParam());
                        localeID = paramValue;

                        // Prevent a null string from being used,
                        // in case the caller does not expect it.
                        if (localeID == null) {
                                localeID = "";
                        }
                }

                return localeID;
        }

}