com.alkacon.acacia.client.widgets.FormWidgetWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acacia-editor-client Show documentation
A GWT based resource editor. This component is used as a part of OpenCms, an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.
There is a newer version: 2.1
Show newest version
/*
 * This library is part of the Acacia Editor -
 * an open source inline and form based content editor for GWT.
 *
 * Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package com.alkacon.acacia.client.widgets;

import com.alkacon.acacia.client.css.I_LayoutBundle;
import com.alkacon.geranium.client.I_HasResizeOnShow;
import com.alkacon.geranium.client.util.DomUtil;

import com.google.gwt.dom.client.Element;
import com.google.gwt.event.dom.client.FocusHandler;
import com.google.gwt.event.logical.shared.HasResizeHandlers;
import com.google.gwt.event.logical.shared.ResizeHandler;
import com.google.gwt.event.logical.shared.ValueChangeHandler;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.HTML;

/** 
 * Wraps an edit widget to supply a widget label.
 **/
public class FormWidgetWrapper extends Composite implements I_FormEditWidget, HasResizeHandlers, I_HasResizeOnShow {

    /** The edit widget. */
    private I_EditWidget m_editWidget;

    /** The label. */
    private HTML m_label;

    /** The main panel. */
    private FlowPanel m_mainPanel;

    /**
     * Constructor.

     * 
     * @param editWidget the edit widget to wrap
     */
    public FormWidgetWrapper(I_EditWidget editWidget) {

        m_mainPanel = new FlowPanel();
        m_label = new HTML();
        m_label.setStyleName(I_LayoutBundle.INSTANCE.form().label());
        m_mainPanel.add(m_label);
        m_editWidget = editWidget;
        m_mainPanel.add(m_editWidget);
        m_editWidget.asWidget().addStyleName(I_LayoutBundle.INSTANCE.form().widget());
        initWidget(m_mainPanel);
    }

    /**
     * @see com.google.gwt.event.dom.client.HasFocusHandlers#addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)
     */
    public HandlerRegistration addFocusHandler(FocusHandler handler) {

        return m_editWidget.addFocusHandler(handler);
    }

    /**
     * @see com.google.gwt.event.logical.shared.HasResizeHandlers#addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler)
     */
    public HandlerRegistration addResizeHandler(ResizeHandler handler) {

        if (m_editWidget instanceof HasResizeHandlers) {
            return ((HasResizeHandlers)m_editWidget).addResizeHandler(handler);
        }
        return null;
    }

    /**
     * @see com.alkacon.acacia.client.widgets.I_EditWidget#addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
     */
    public HandlerRegistration addValueChangeHandler(ValueChangeHandler handler) {

        return m_editWidget.addValueChangeHandler(handler);
    }

    /**
     * Gets the wrapped widget.
     * 
     * @return the wrapped widget 
     */
    public I_EditWidget getEditWidget() {

        return m_editWidget;
    }

    /**
     * @see com.google.gwt.user.client.ui.HasValue#getValue()
     */
    public String getValue() {

        return m_editWidget.getValue();
    }

    /**
     * @see com.alkacon.acacia.client.widgets.I_EditWidget#isActive()
     */
    public boolean isActive() {

        return m_editWidget.isActive();
    }

    /**
     * @see com.alkacon.acacia.client.widgets.I_EditWidget#onAttachWidget()
     */
    public void onAttachWidget() {

        super.onAttach();
    }

    /**
     * @see com.alkacon.acacia.client.widgets.I_EditWidget#owns(com.google.gwt.dom.client.Element)
     */
    public boolean owns(Element element) {

        return (m_editWidget != null) && m_editWidget.owns(element);
    }

    /**
     * @see com.alkacon.geranium.client.I_HasResizeOnShow#resizeOnShow()
     */
    public void resizeOnShow() {

        if (m_editWidget instanceof I_HasResizeOnShow) {
            ((I_HasResizeOnShow)m_editWidget).resizeOnShow();
        }
    }

    /**
     * @see com.alkacon.acacia.client.widgets.I_EditWidget#setActive(boolean)
     */
    public void setActive(boolean active) {

        m_editWidget.setActive(active);
    }

    /**
     * @see com.alkacon.acacia.client.widgets.I_EditWidget#setName(java.lang.String)
     */
    public void setName(String name) {

        m_editWidget.setName(name);

    }

    /**
     * @see com.google.gwt.user.client.ui.HasValue#setValue(java.lang.Object)
     */
    public void setValue(String value) {

        m_editWidget.setValue(value);
    }

    /**
     * @see com.alkacon.acacia.client.widgets.I_EditWidget#setValue(java.lang.String, boolean)
     */
    public void setValue(String value, boolean fireEvent) {

        m_editWidget.setValue(value, fireEvent);
    }

    /**
     * @see com.alkacon.acacia.client.widgets.I_FormEditWidget#setWidgetInfo(java.lang.String, java.lang.String)
     */
    public void setWidgetInfo(String label, String help) {

        m_label.setHTML(label);
        m_label.setTitle(DomUtil.stripHtml(help));
    }

}