org.opencms.acacia.client.widgets.CmsTextboxWidget Maven / Gradle / Ivy
Show all versions of opencms-gwt Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (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
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* 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 org.opencms.acacia.client.widgets;
import org.opencms.acacia.client.css.I_CmsLayoutBundle;
import org.opencms.gwt.client.util.CmsDomUtil;
import org.opencms.util.CmsStringUtil;
import com.google.gwt.core.client.GWT;
import com.google.gwt.core.client.Scheduler;
import com.google.gwt.core.client.Scheduler.ScheduledCommand;
import com.google.gwt.dom.client.Element;
import com.google.gwt.event.dom.client.BlurEvent;
import com.google.gwt.event.dom.client.BlurHandler;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.FocusEvent;
import com.google.gwt.event.dom.client.FocusHandler;
import com.google.gwt.event.dom.client.KeyUpEvent;
import com.google.gwt.event.dom.client.KeyUpHandler;
import com.google.gwt.event.logical.shared.ValueChangeEvent;
import com.google.gwt.event.logical.shared.ValueChangeHandler;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.uibinder.client.UiBinder;
import com.google.gwt.uibinder.client.UiField;
import com.google.gwt.uibinder.client.UiHandler;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.FocusPanel;
import com.google.gwt.user.client.ui.HTMLPanel;
import com.google.gwt.user.client.ui.TextBox;
/**
* Provides a display only widget, for use on a widget dialog.
*
* */
public class CmsTextboxWidget extends Composite implements I_CmsEditWidget {
/**
* The UI binder interface.
*/
interface I_CmsTextboxWidgetUiBinder extends UiBinder {
// nothing to do
}
/** The UI binder instance. */
private static I_CmsTextboxWidgetUiBinder uiBinder = GWT.create(I_CmsTextboxWidgetUiBinder.class);
/** The fader of this widget. */
@UiField
FocusPanel m_fadePanel;
/**The main panel of this widget. */
HTMLPanel m_mainPanel;
/** The input test area.*/
@UiField
TextBox m_textbox;
/** The token to control activation. */
private boolean m_active = true;
/** Default value. */
private String m_defaultValue = "";
/** The previous value. */
private String m_previousValue;
/** The value changed handler initialized flag. */
private boolean m_valueChangeHandlerInitialized;
/**
* Creates a new display widget.
*
* @param config the widget configuration
*/
public CmsTextboxWidget(String config) {
m_mainPanel = uiBinder.createAndBindUi(this);
initWidget(m_mainPanel);
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(config)) {
parseConfig(config);
}
}
/**
* @see com.google.gwt.event.dom.client.HasFocusHandlers#addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)
*/
public HandlerRegistration addFocusHandler(FocusHandler handler) {
return addDomHandler(handler, FocusEvent.getType());
}
/**
* @see com.google.gwt.event.logical.shared.HasValueChangeHandlers#addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
*/
public HandlerRegistration addValueChangeHandler(ValueChangeHandler handler) {
// Initialization code
if (!m_valueChangeHandlerInitialized) {
m_valueChangeHandlerInitialized = true;
addDomHandler(new KeyUpHandler() {
public void onKeyUp(KeyUpEvent event) {
// schedule the change event, so the key press can take effect
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
public void execute() {
fireValueChange(false);
}
});
}
}, KeyUpEvent.getType());
addDomHandler(new BlurHandler() {
public void onBlur(BlurEvent event) {
fireValueChange(false);
}
}, BlurEvent.getType());
}
return addHandler(handler, ValueChangeEvent.getType());
}
/**
* Represents a value change event.
*
*/
public void fireChangeEvent() {
String result = "";
if (m_textbox.getText() != null) {
result = m_textbox.getText();
}
ValueChangeEvent.fire(this, result);
}
/**
* @see com.google.gwt.user.client.ui.HasValue#getValue()
*/
public String getValue() {
return m_textbox.getText();
}
/**
* @see org.opencms.acacia.client.widgets.I_CmsEditWidget#isActive()
*/
public boolean isActive() {
return m_active;
}
/**
* @see org.opencms.acacia.client.widgets.I_CmsEditWidget#onAttachWidget()
*/
public void onAttachWidget() {
super.onAttach();
}
/**
* @see org.opencms.acacia.client.widgets.I_CmsEditWidget#owns(com.google.gwt.dom.client.Element)
*/
public boolean owns(Element element) {
// TODO implement this in case we want the delete behavior for optional fields
return false;
}
/**
* @see org.opencms.acacia.client.widgets.I_CmsEditWidget#setActive(boolean)
*/
public void setActive(boolean active) {
if (m_active == active) {
return;
}
m_active = active;
if (m_active) {
getElement().removeClassName(I_CmsLayoutBundle.INSTANCE.form().inActive());
getElement().focus();
m_textbox.setText(m_defaultValue);
} else {
getElement().addClassName(I_CmsLayoutBundle.INSTANCE.form().inActive());
}
if (!active) {
m_textbox.setText("");
}
if (active) {
fireChangeEvent();
}
}
/**
* @see org.opencms.acacia.client.widgets.I_CmsEditWidget#setName(java.lang.String)
*/
public void setName(String name) {
m_textbox.setName(name);
}
/**
* @see com.google.gwt.user.client.ui.UIObject#setTitle(java.lang.String)
*/
@Override
public void setTitle(String title) {
if ((title.length() * 6.88) > m_mainPanel.getOffsetWidth()) {
m_mainPanel.getElement().setTitle(title);
} else {
m_mainPanel.getElement().setTitle("");
}
}
/**
* @see com.google.gwt.user.client.ui.HasValue#setValue(java.lang.Object)
*/
public void setValue(String value) {
m_textbox.setText(value);
}
/**
* @see com.google.gwt.user.client.ui.HasValue#setValue(java.lang.Object, boolean)
*/
public void setValue(String value, boolean fireEvents) {
// set the saved value to the textArea
m_textbox.setText(value);
m_previousValue = value;
if (fireEvents) {
fireChangeEvent();
}
}
/**
* Fires the value change event, if the value has changed.
*
* @param force true to force firing the event, not regarding an actually changed value
*/
protected void fireValueChange(boolean force) {
String currentValue = getValue();
if (force || !currentValue.equals(m_previousValue)) {
m_previousValue = currentValue;
ValueChangeEvent.fire(this, currentValue);
}
}
/**
* Handles fade panel clicks.
*
* @param event the click event
*/
@UiHandler("m_fadePanel")
void onFadeClick(ClickEvent event) {
m_textbox.setFocus(true);
m_textbox.setCursorPos(m_textbox.getText().length());
}
/**
* Handles text box blur.
*
* @param event the blur event
*/
@UiHandler("m_textbox")
void onTextboxBlur(BlurEvent event) {
m_mainPanel.add(m_fadePanel);
setTitle(m_textbox.getText());
}
/**
* Handles text box focus.
*
* @param event the focus event
*/
@UiHandler("m_textbox")
void onTextboxFocus(FocusEvent event) {
m_mainPanel.remove(m_fadePanel);
setTitle("");
CmsDomUtil.fireFocusEvent(this);
}
/**
* Handles text box value change.
*
* @param event the value change event
*/
@UiHandler("m_textbox")
void onTextboxValueChange(ValueChangeEvent event) {
fireValueChange(false);
}
/**
* Parse the configuration String.
* @param config the configuration String
*/
private void parseConfig(String config) {
m_defaultValue = config;
setValue(m_defaultValue);
}
}