001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.acacia.client.widgets;
029
030import com.google.gwt.dom.client.Element;
031import com.google.gwt.event.logical.shared.ValueChangeEvent;
032import com.google.gwt.event.logical.shared.ValueChangeHandler;
033import com.google.gwt.event.shared.HandlerRegistration;
034import com.google.gwt.user.client.ui.FocusWidget;
035
036/**
037 * Abstract editing widget class.<p>
038 */
039public abstract class A_CmsEditWidget extends FocusWidget implements I_CmsEditWidget {
040
041    /** The previous value. */
042    private String m_previousValue;
043
044    /**
045     * Constructor wrapping a specific DOM element.<p>
046     *
047     * @param element the element to wrap
048     */
049    protected A_CmsEditWidget(Element element) {
050
051        super(element);
052        m_previousValue = element.getInnerHTML();
053    }
054
055    /**
056     * @see com.google.gwt.event.logical.shared.HasValueChangeHandlers#addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
057     */
058    public abstract HandlerRegistration addValueChangeHandler(ValueChangeHandler<String> handler);
059
060    /**
061     * @see com.google.gwt.user.client.ui.HasValue#getValue()
062     */
063    public String getValue() {
064
065        return getElement().getInnerText().trim();
066    }
067
068    /**
069     * @see org.opencms.acacia.client.widgets.I_CmsEditWidget#onAttachWidget()
070     */
071    public void onAttachWidget() {
072
073        onAttach();
074    }
075
076    /**
077     * @see org.opencms.acacia.client.widgets.I_CmsEditWidget#owns(com.google.gwt.dom.client.Element)
078     */
079    public boolean owns(com.google.gwt.dom.client.Element element) {
080
081        return false;
082    }
083
084    /**
085     * Fires the value change event, if the value has changed.<p>
086     *
087     * @param force <code>true</code> to force firing the event, not regarding an actually changed value
088     */
089    protected void fireValueChange(boolean force) {
090
091        String currentValue = getValue();
092        if (force || !currentValue.equals(m_previousValue)) {
093            m_previousValue = currentValue;
094            ValueChangeEvent.fire(this, currentValue);
095        }
096    }
097
098    /**
099     * Returns the previous value.<p>
100     *
101     * @return the previous value
102     */
103    protected String getPreviousValue() {
104
105        return m_previousValue;
106    }
107
108    /**
109     * Sets the previous value.<p>
110     *
111     * @param previousValue the previous value to set
112     */
113    protected void setPreviousValue(String previousValue) {
114
115        m_previousValue = previousValue;
116    }
117}