org.opencms.gwt.client.ui.input.CmsTextBox 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 (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.gwt.client.ui.input;
import org.opencms.gwt.client.I_CmsHasInit;
import org.opencms.gwt.client.ui.I_CmsAutoHider;
import org.opencms.gwt.client.ui.css.I_CmsInputCss;
import org.opencms.gwt.client.ui.css.I_CmsInputLayoutBundle;
import org.opencms.gwt.client.ui.css.I_CmsLayoutBundle;
import org.opencms.gwt.client.ui.input.form.CmsWidgetFactoryRegistry;
import org.opencms.gwt.client.ui.input.form.I_CmsFormWidgetFactory;
import org.opencms.gwt.client.util.CmsExtendedValueChangeEvent;
import org.opencms.util.CmsStringUtil;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import com.google.gwt.dom.client.Style.Unit;
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.ClickHandler;
import com.google.gwt.event.dom.client.FocusEvent;
import com.google.gwt.event.dom.client.FocusHandler;
import com.google.gwt.event.dom.client.HasBlurHandlers;
import com.google.gwt.event.dom.client.HasClickHandlers;
import com.google.gwt.event.dom.client.HasFocusHandlers;
import com.google.gwt.event.dom.client.HasKeyPressHandlers;
import com.google.gwt.event.dom.client.KeyCodes;
import com.google.gwt.event.dom.client.KeyPressEvent;
import com.google.gwt.event.dom.client.KeyPressHandler;
import com.google.gwt.event.dom.client.KeyUpEvent;
import com.google.gwt.event.dom.client.KeyUpHandler;
import com.google.gwt.event.dom.client.MouseOutEvent;
import com.google.gwt.event.dom.client.MouseOutHandler;
import com.google.gwt.event.dom.client.MouseOverEvent;
import com.google.gwt.event.dom.client.MouseOverHandler;
import com.google.gwt.event.logical.shared.HasValueChangeHandlers;
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.user.client.Event;
import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.ui.Composite;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.TextBox;
/**
* Basic text box class for forms.
*
* @since 8.0.0
*
*/
public class CmsTextBox extends Composite
implements I_CmsFormWidget, I_CmsHasInit, HasFocusHandlers, HasBlurHandlers, HasValueChangeHandlers,
HasKeyPressHandlers, HasClickHandlers, I_CmsHasBlur, I_CmsHasGhostValue {
/**
* Event handler for this text box.
*/
private class TextBoxHandler
implements MouseOverHandler, MouseOutHandler, FocusHandler, BlurHandler, ValueChangeHandler, KeyUpHandler {
/** The current text box value. */
private String m_currentValue;
/**
* Constructor.
*
* @param currentValue the current text box value
*/
protected TextBoxHandler(String currentValue) {
m_currentValue = currentValue;
}
/**
* @see com.google.gwt.event.dom.client.BlurHandler#onBlur(com.google.gwt.event.dom.client.BlurEvent)
*/
public void onBlur(BlurEvent event) {
if (!m_ghostMode && m_textbox.getText().equals("")) {
setGhostValue(m_ghostValue, true);
} else if (m_ghostMode) {
setGhostStyleEnabled(true, true);
}
checkForChange(false);
}
/**
* @see com.google.gwt.event.dom.client.FocusHandler#onFocus(com.google.gwt.event.dom.client.FocusEvent)
*/
public void onFocus(FocusEvent event) {
setGhostStyleEnabled(false, m_ghostMode);
}
/**
* @see com.google.gwt.event.dom.client.KeyUpHandler#onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent)
*/
public void onKeyUp(KeyUpEvent event) {
if (CmsStringUtil.isEmpty(m_textbox.getValue())) {
if (m_ghostValue != null) {
setGhostMode(true);
}
} else {
if (m_ghostMode && !m_textbox.getValue().equals(m_ghostValue)) {
setGhostMode(false);
}
}
if (isTriggerChangeOnKeyPress()) {
checkForChange(m_inhibitValidationForKeypresses);
}
}
/**
* @see com.google.gwt.event.dom.client.MouseOutHandler#onMouseOut(com.google.gwt.event.dom.client.MouseOutEvent)
*/
public void onMouseOut(MouseOutEvent event) {
hideError();
}
/**
* @see com.google.gwt.event.dom.client.MouseOverHandler#onMouseOver(com.google.gwt.event.dom.client.MouseOverEvent)
*/
public void onMouseOver(MouseOverEvent event) {
if (!isPreventShowError()) {
showError();
}
}
/**
* @see com.google.gwt.event.logical.shared.ValueChangeHandler#onValueChange(ValueChangeEvent event)
*/
public void onValueChange(ValueChangeEvent event) {
if (m_ghostMode && m_textbox.getValue().equals(m_ghostValue)) {
fireValueChangedEvent(false);
return;
}
setGhostMode(false);
if ((m_ghostValue != null) && "".equals(m_textbox.getValue())) {
setGhostMode(true);
setGhostStyleEnabled(true, true);
setValueInTextBoxDelayed(m_ghostValue);
}
if (!event.getValue().equals(m_currentValue)) {
m_currentValue = event.getValue();
fireValueChangedEvent(false);
}
}
/**
* Sets the current value.
*
* @param value the current value
*/
public void setValue(String value) {
m_currentValue = value;
}
/**
* Checks if the current text box value has changed and fires the value changed event.
*
* @param inhibitValidation if set to true, validation should not be performed directly by event handlers
*/
protected void checkForChange(boolean inhibitValidation) {
if (!m_textbox.getValue().equals(m_currentValue)) {
m_currentValue = getFormValueAsString();
fireValueChangedEvent(inhibitValidation);
}
}
}
/** The CSS bundle used for this widget. */
public static final I_CmsInputCss CSS = I_CmsInputLayoutBundle.INSTANCE.inputCss();
/** The widget type identifier for this widget. */
public static final String WIDGET_TYPE = "string";
/** Key codes for functional keys. */
protected static final int[] NAVIGATION_CODES = {
KeyCodes.KEY_ALT,
KeyCodes.KEY_CTRL,
KeyCodes.KEY_DOWN,
KeyCodes.KEY_END,
KeyCodes.KEY_ENTER,
KeyCodes.KEY_ESCAPE,
KeyCodes.KEY_HOME,
KeyCodes.KEY_LEFT,
KeyCodes.KEY_RIGHT,
KeyCodes.KEY_SHIFT,
KeyCodes.KEY_TAB,
KeyCodes.KEY_UP};
/** Default pseudo-padding for text boxes. */
private static final int DEFAULT_PADDING = 4;
/** A counter used for giving text box widgets ids. */
private static int idCounter;
/** Flag for ghost mode. */
protected boolean m_ghostMode;
/** The ghost value. */
protected String m_ghostValue;
/** The text box used internally by this widget. */
protected TextBox m_textbox = new TextBox();
/** Flag which controls whether validation should be inhibited when value change events are fired as a consequence of key presses. */
boolean m_inhibitValidationForKeypresses;
/** Flag indicating if the text box should be cleared when leaving the ghost mode. */
private boolean m_clearOnChangeMode;
/** A list of the click handler registrations for this text box. */
private List m_clickHandlerRegistrations = new ArrayList();
/** A list of the click handlers for this text box. */
private List m_clickHandlers = new ArrayList();
/** Stores the enable/disable state of the textbox. */
private boolean m_enabled;
/** The error display for this widget. */
private CmsErrorWidget m_error = new CmsErrorWidget();
/** The width of the error message. */
private String m_errorMessageWidth;
/** The text box handler instance. */
private TextBoxHandler m_handler;
/** The container for the textbox container and error widget. */
private FlowPanel m_panel = new FlowPanel();
/** Signals whether the error message will be shown on mouse over. */
private boolean m_preventShowError;
/** The container for the text box. */
private CmsPaddedPanel m_textboxContainer = new CmsPaddedPanel(DEFAULT_PADDING);
/** Flag indicating if the value change event should also be fired after key press events. */
private boolean m_triggerChangeOnKeyPress;
/**
* Constructs a new instance of this widget.
*/
public CmsTextBox() {
setEnabled(true);
m_textbox.setStyleName(CSS.textBox());
m_textbox.getElement().setId("CmsTextBox_" + (idCounter++));
TextBoxHandler handler = new TextBoxHandler("");
m_textbox.addMouseOverHandler(handler);
m_textbox.addMouseOutHandler(handler);
m_textbox.addFocusHandler(handler);
m_textbox.addBlurHandler(handler);
m_textbox.addValueChangeHandler(handler);
//m_textbox.addKeyPressHandler(handler);
m_textbox.addKeyUpHandler(handler);
m_handler = handler;
m_textboxContainer.setStyleName(CSS.textBoxPanel());
m_textboxContainer.addStyleName(I_CmsLayoutBundle.INSTANCE.generalCss().cornerAll());
m_textboxContainer.addStyleName(I_CmsLayoutBundle.INSTANCE.generalCss().textMedium());
m_panel.add(m_textboxContainer);
m_panel.add(m_error);
m_textboxContainer.add(m_textbox);
m_textboxContainer.setPaddingX(4);
sinkEvents(Event.ONPASTE);
initWidget(m_panel);
}
/**
* Initializes this class.
*/
public static void initClass() {
// registers a factory for creating new instances of this widget
CmsWidgetFactoryRegistry.instance().registerFactory(WIDGET_TYPE, new I_CmsFormWidgetFactory() {
/**
* @see org.opencms.gwt.client.ui.input.form.I_CmsFormWidgetFactory#createWidget(java.util.Map)
*/
public I_CmsFormWidget createWidget(Map widgetParams) {
return new CmsTextBox();
}
});
}
/**
* @see com.google.gwt.event.dom.client.HasBlurHandlers#addBlurHandler(com.google.gwt.event.dom.client.BlurHandler)
*/
public HandlerRegistration addBlurHandler(BlurHandler handler) {
return m_textbox.addBlurHandler(handler);
}
/**
* @see com.google.gwt.event.dom.client.HasClickHandlers#addClickHandler(com.google.gwt.event.dom.client.ClickHandler)
*/
public HandlerRegistration addClickHandler(ClickHandler handler) {
HandlerRegistration registration = addDomHandler(handler, ClickEvent.getType());
m_clickHandlerRegistrations.add(registration);
m_clickHandlers.add(handler);
return registration;
}
/**
* @see com.google.gwt.event.dom.client.HasFocusHandlers#addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)
*/
public HandlerRegistration addFocusHandler(FocusHandler handler) {
return m_textbox.addFocusHandler(handler);
}
/**
* @see com.google.gwt.event.dom.client.HasKeyPressHandlers#addKeyPressHandler(com.google.gwt.event.dom.client.KeyPressHandler)
*/
public HandlerRegistration addKeyPressHandler(KeyPressHandler handler) {
return addDomHandler(handler, KeyPressEvent.getType());
}
/**
* @see com.google.gwt.event.logical.shared.HasValueChangeHandlers#addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)
*/
public HandlerRegistration addValueChangeHandler(ValueChangeHandler handler) {
return addHandler(handler, ValueChangeEvent.getType());
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsHasBlur#blur()
*/
public void blur() {
m_textbox.getElement().blur();
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getApparentValue()
*/
public String getApparentValue() {
String result = m_textbox.getValue();
if (CmsStringUtil.isEmpty(result)) {
result = null;
}
return result;
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getFieldType()
*/
public FieldType getFieldType() {
return I_CmsFormWidget.FieldType.STRING;
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getFormValue()
*/
public Object getFormValue() {
if (m_textbox.getText() == null) {
return "";
}
return m_textbox.getText();
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getFormValueAsString()
*/
public String getFormValueAsString() {
if (m_ghostMode) {
return "";
}
return (String)getFormValue();
}
/**
* Returns the HTML id of the internal textbox used by this widget.
*
* @return the HTML id of the internal textbox used by this widget
*/
public String getId() {
return m_textbox.getElement().getId();
}
/**
* Returns the text in the text box.
*
* @return the text
*/
public String getText() {
return m_textbox.getText();
}
/**
* Returns the Textbox of this widget.
*
* @return the CmsTextBox
*/
public TextBox getTextBox() {
return m_textbox;
}
/**
* Returns the Panel of this widget.
*
* @return the Panel
*/
public CmsPaddedPanel getTextBoxContainer() {
return m_textboxContainer;
}
/**
* Returns true if this textbox has an error set.
*
* @return true if this textbox has an error set
*/
public boolean hasError() {
return m_error.hasError();
}
/**
* Gets whether this widget is enabled.
*
* @return true if the widget is enabled
*/
public boolean isEnabled() {
return m_enabled;
}
/**
* Returns the preventShowError.
*
* @return the preventShowError
*/
public boolean isPreventShowError() {
return m_preventShowError;
}
/**
* Returns the read only flag.
*
* @return true if this text box is only readable
*/
public boolean isReadOnly() {
return m_textbox.isReadOnly();
}
/**
* Returns if the text box is set to trigger the value changed event on key press and not on blur only.
*
* @return true if the text box is set to trigger the value changed event on key press
*/
public boolean isTriggerChangeOnKeyPress() {
return m_triggerChangeOnKeyPress;
}
/**
* @see com.google.gwt.user.client.ui.Composite#onBrowserEvent(com.google.gwt.user.client.Event)
*/
@Override
public void onBrowserEvent(Event event) {
super.onBrowserEvent(event);
/*
* In IE8, the change event is not fired if we switch to another application window after having
* pasted some text into the text box, so we need to turn off ghost mode manually
*/
if (event.getTypeInt() == Event.ONPASTE) {
setGhostMode(false);
}
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#reset()
*/
public void reset() {
m_textbox.setText("");
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setAutoHideParent(org.opencms.gwt.client.ui.I_CmsAutoHider)
*/
public void setAutoHideParent(I_CmsAutoHider autoHideParent) {
// nothing to do
}
/**
* Sets the changed style on the text box.
*/
public void setChangedStyle() {
m_textbox.addStyleName(CSS.changed());
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setEnabled(boolean)
*/
public void setEnabled(boolean enabled) {
if (!m_enabled && enabled) {
// if the state changed to enable then add the stored handlers
// copy the stored handlers into a new list to avoid concurred access to the list
List handlers = new ArrayList(m_clickHandlers);
m_clickHandlers.clear();
for (ClickHandler handler : handlers) {
addClickHandler(handler);
}
m_textboxContainer.removeStyleName(CSS.textBoxPanelDisabled());
m_enabled = true;
} else if (m_enabled && !enabled) {
// if state changed to disable then remove all click handlers
for (HandlerRegistration registration : m_clickHandlerRegistrations) {
registration.removeHandler();
}
m_clickHandlerRegistrations.clear();
m_textboxContainer.addStyleName(CSS.textBoxPanelDisabled());
setErrorMessage(null);
m_enabled = false;
}
m_textbox.setEnabled(m_enabled);
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setErrorMessage(java.lang.String)
*/
public void setErrorMessage(String errorMessage) {
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(errorMessage)) {
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(m_errorMessageWidth)) {
m_error.setWidth(m_errorMessageWidth);
} else {
int width = getOffsetWidth() - 8;
width = width > 0 ? width : 100;
m_error.setWidth(width + Unit.PX.toString());
}
m_textboxContainer.removeStyleName(CSS.textBoxPanel());
m_textboxContainer.addStyleName(CSS.textBoxPanelError());
} else {
m_textboxContainer.removeStyleName(CSS.textBoxPanelError());
m_textboxContainer.addStyleName(CSS.textBoxPanel());
}
m_error.setText(errorMessage);
}
/**
* Sets the width of the error message for this textbox.
*
* @param width the object's new width, in CSS units (e.g. "10px", "1em")
*/
public void setErrorMessageWidth(String width) {
m_errorMessageWidth = width;
}
/**
* Sets the focus on the text box.
*
* @param focused signals if the focus should be set
*/
public void setFocus(boolean focused) {
m_textbox.setFocus(focused);
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setFormValueAsString(java.lang.String)
*/
public void setFormValueAsString(String newValue) {
if (newValue == null) {
newValue = "";
}
if ("".equals(newValue) && (m_ghostValue != null)) {
setGhostMode(true);
setGhostStyleEnabled(true, true);
setValueInTextBoxDelayed(m_ghostValue);
} else {
setGhostMode(false);
setGhostStyleEnabled(false, true);
// don't set the value if it matches the old one
if (!newValue.equals(getFormValueAsString())) {
setFormValue(newValue);
}
}
}
/**
* Enables or disables ghost mode.
*
* @param ghostMode if true, enables ghost mode, else disables it
*/
public void setGhostMode(boolean ghostMode) {
//setGhostStyleEnabled(ghostMode);
m_ghostMode = ghostMode;
}
/**
* Sets if the input field should be cleared when leaving the ghost mode.
*
* @param clearOnChangeMode true to clear on leaving the ghost mode
*/
public void setGhostModeClear(boolean clearOnChangeMode) {
m_clearOnChangeMode = clearOnChangeMode;
}
/**
* Enables or disables the "ghost mode" style.
*
* This *only* changes the style, not the actual mode.
*
* @param enabled true if the ghost mode style should be enabled, false if it should be disabled
* @param mayClear true if no value was previously set
*/
public void setGhostStyleEnabled(boolean enabled, boolean mayClear) {
if (enabled) {
m_textbox.addStyleName(CSS.textboxGhostMode());
} else {
m_textbox.removeStyleName(CSS.textboxGhostMode());
if (m_clearOnChangeMode && mayClear) {
setText("");
}
}
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsHasGhostValue#setGhostValue(java.lang.String, boolean)
*/
public void setGhostValue(String value, boolean ghostMode) {
m_ghostValue = value;
if (!ghostMode) {
return;
}
m_textbox.setValue(value);
setGhostMode(true);
setGhostStyleEnabled(true, true);
}
/**
* Sets the 'inhibitValidationForKeypresses' flag.
*
* @param inhibitValidationForKeypresses the new flag value
*/
public void setInhibitValidationForKeypresses(boolean inhibitValidationForKeypresses) {
m_inhibitValidationForKeypresses = inhibitValidationForKeypresses;
}
/**
* Sets the name of the input box.
*
* @param name of the input box
* */
public void setName(String name) {
m_textbox.setName(name);
}
/**
* Sets the preventShowError.
*
* @param preventShowError the preventShowError to set
*/
public void setPreventShowError(boolean preventShowError) {
m_preventShowError = preventShowError;
if (preventShowError) {
m_error.setErrorVisible(false);
}
}
/**
* Enables or disables read-only mode.
*
* @param readOnly if true, enables read-only mode, else disables it
*/
public void setReadOnly(boolean readOnly) {
m_textbox.setReadOnly(readOnly);
if (readOnly) {
addStyleName(CSS.textBoxReadOnly());
} else {
removeStyleName(CSS.textBoxReadOnly());
}
}
/**
* Sets if the value changed event should be triggered on key press and not on blur only.
*
* @param triggerOnKeyPress true if the value changed event should be triggered on key press
*/
public void setTriggerChangeOnKeyPress(boolean triggerOnKeyPress) {
m_triggerChangeOnKeyPress = triggerOnKeyPress;
}
/**
* Sets the value of the text box after a short delay.
*
* @param value the value to set
*/
public void setValueInTextBoxDelayed(final String value) {
Timer timer = new Timer() {
@Override
public void run() {
m_textbox.setValue(value);
}
};
timer.schedule(1);
}
/**
* Updates the layout of the text box.
*/
public void updateLayout() {
m_textboxContainer.updatePadding();
}
/**
* Fires a value change event.
*/
protected void fireValueChangedEvent() {
fireValueChangedEvent(false);
}
/**
* Helper method for firing a 'value changed' event.
*
* @param inhibitValidation if true, some additional information will be added to the event to ask event handlers to not perform any validation directly
*/
protected void fireValueChangedEvent(boolean inhibitValidation) {
if (!inhibitValidation) {
ValueChangeEvent.fire(this, getFormValueAsString());
} else {
CmsExtendedValueChangeEvent e = new CmsExtendedValueChangeEvent(getFormValueAsString());
e.setInhibitValidation(true);
this.fireEvent(e);
}
}
/**
* Hides the error for this textbox.
*/
protected void hideError() {
m_error.hideError();
}
/**
* Checks if the given key code represents a functional key.
*
* @param keyCode the key code to check
*
* @return true if the given key code represents a functional key
*/
protected boolean isNavigationKey(int keyCode) {
for (int i = 0; i < NAVIGATION_CODES.length; i++) {
if (NAVIGATION_CODES[i] == keyCode) {
return true;
}
}
return false;
}
/**
* Shows the error for this textbox.
*/
protected void showError() {
m_error.showError();
}
/**
* Sets the value of the widget.
*
* @param value the new value
*/
private void setFormValue(Object value) {
if (value instanceof String) {
String strValue = (String)value;
setText(strValue);
}
}
/**
* Sets the text in the text box.
*
* @param text the new text
*/
private void setText(String text) {
m_textbox.setText(text);
m_handler.setValue(text);
}
}