001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (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.gwt.client.ui.input;
029
030import org.opencms.gwt.client.ui.css.I_CmsInputLayoutBundle;
031import org.opencms.gwt.client.ui.css.I_CmsLayoutBundle;
032
033import com.google.gwt.event.logical.shared.HasSelectionHandlers;
034import com.google.gwt.event.logical.shared.HasValueChangeHandlers;
035import com.google.gwt.event.logical.shared.SelectionHandler;
036import com.google.gwt.event.logical.shared.ValueChangeHandler;
037import com.google.gwt.event.shared.HandlerRegistration;
038import com.google.gwt.user.client.ui.Composite;
039import com.google.gwt.user.client.ui.FlowPanel;
040import com.google.gwt.user.client.ui.SuggestBox;
041import com.google.gwt.user.client.ui.SuggestOracle;
042import com.google.gwt.user.client.ui.SuggestOracle.Suggestion;
043
044/**
045 * Wraps the GWT suggest box to enhance the layout.<p>
046 */
047public class CmsSuggestBox extends Composite
048implements HasValueChangeHandlers<String>, HasSelectionHandlers<SuggestOracle.Suggestion> {
049
050    /** The wrapped suggest box. */
051    private SuggestBox m_suggestBox;
052
053    /** The container for the text box. */
054    private FlowPanel m_textBoxContainer;
055
056    /**
057     * Constructor.<p>
058     *
059     * @param oracle the suggestion oracle
060     */
061    public CmsSuggestBox(SuggestOracle oracle) {
062
063        m_textBoxContainer = new FlowPanel();
064        m_textBoxContainer.setStyleName(I_CmsInputLayoutBundle.INSTANCE.inputCss().textBoxPanel());
065        m_textBoxContainer.addStyleName(I_CmsLayoutBundle.INSTANCE.generalCss().cornerAll());
066        m_textBoxContainer.addStyleName(I_CmsLayoutBundle.INSTANCE.generalCss().textMedium());
067        m_suggestBox = new SuggestBox(oracle);
068        m_textBoxContainer.add(m_suggestBox);
069
070        initWidget(m_textBoxContainer);
071    }
072
073    /**
074     * @see com.google.gwt.event.logical.shared.HasSelectionHandlers#addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler)
075     */
076    public HandlerRegistration addSelectionHandler(SelectionHandler<Suggestion> handler) {
077
078        return m_suggestBox.addSelectionHandler(handler);
079    }
080
081    /**
082     * @see com.google.gwt.event.logical.shared.HasValueChangeHandlers#addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
083     */
084    public HandlerRegistration addValueChangeHandler(ValueChangeHandler<String> handler) {
085
086        return m_suggestBox.addValueChangeHandler(handler);
087    }
088
089    /**
090     * Sets the text value.<p>
091     *
092     * @param textValue he text value
093     */
094    public void setTextValue(String textValue) {
095
096        m_suggestBox.setText(textValue);
097    }
098}