org.opencms.gwt.client.ui.input.CmsMultiCheckBox 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.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_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.CmsDomUtil;
import org.opencms.util.CmsPair;
import org.opencms.util.CmsStringUtil;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.google.gwt.event.dom.client.FocusEvent;
import com.google.gwt.event.dom.client.FocusHandler;
import com.google.gwt.event.dom.client.HasFocusHandlers;
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.ui.Composite;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.Panel;
/**
* A form widget consisting of a group of checkboxes.
*
* @since 8.0.0
*
*/
public class CmsMultiCheckBox extends Composite
implements I_CmsFormWidget, I_CmsHasInit, HasValueChangeHandlers, HasFocusHandlers {
/** The type string for this widget. */
public static final String WIDGET_TYPE = "multicheck";
/** The list of checkboxes. */
protected List m_checkboxes = new ArrayList();
/** Error display for this widget. */
protected CmsErrorWidget m_error = new CmsErrorWidget();
/** The select options of the multi check box. */
protected Map m_items = new LinkedHashMap();
/** Panel which contains all the components of the widget. */
protected Panel m_panel = new FlowPanel();
/**
* Constructs a new checkbox group from a list of string pairs.
*
* The first string of every pair is the value of the checkbox, the second string is the label.
*
* @param items a list of pairs of strings.
*/
public CmsMultiCheckBox(List> items) {
super();
init(CmsPair.pairsToMap(items));
}
/**
* Constructs a new checkbox group from a map from strings to strings.
*
* The keys of the map are used as the selection values of the checkboxes, while the value
* for a given key in the map is used as the label for the checkbox which is displayed to the user.
*
* @param items the map of checkbox options
*/
public CmsMultiCheckBox(Map items) {
super();
init(items);
}
/**
* 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 CmsMultiCheckBox(widgetParams);
}
});
}
/**
* @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_CmsFormWidget#getApparentValue()
*/
public String getApparentValue() {
return getFormValueAsString();
}
/**
* Returns a list of all checkboxes.
*
* @return a list of checkboxes
* */
public List getCheckboxes() {
return m_checkboxes;
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getFieldType()
*/
public FieldType getFieldType() {
return I_CmsFormWidget.FieldType.STRING_LIST;
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getFormValue()
*/
public Object getFormValue() {
return new ArrayList(getSelected());
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#getFormValueAsString()
*/
public String getFormValueAsString() {
List selected = new ArrayList(getSelected());
return CmsStringUtil.listAsString(selected, "|");
}
/**
* Returns the set of values of the selected checkboxes.
*
* @return a set of strings
*/
public Set getSelected() {
Set result = new HashSet();
int i = 0;
for (Map.Entry entry : m_items.entrySet()) {
String key = entry.getKey();
CmsCheckBox checkBox = m_checkboxes.get(i);
if (checkBox.isChecked()) {
result.add(key);
}
i += 1;
}
return result;
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#isEnabled()
*/
public boolean isEnabled() {
boolean result = true;
for (CmsCheckBox checkbox : m_checkboxes) {
if (!checkbox.isEnabled()) {
result = false;
}
}
return result;
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#reset()
*/
public void reset() {
for (CmsCheckBox checkbox : m_checkboxes) {
checkbox.setChecked(false);
}
}
/**
* @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
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setEnabled(boolean)
*/
public void setEnabled(boolean enabled) {
for (CmsCheckBox checkbox : m_checkboxes) {
checkbox.setEnabled(enabled);
}
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setErrorMessage(java.lang.String)
*/
public void setErrorMessage(String errorMessage) {
m_error.setText(errorMessage);
}
/**
* Sets the value of the widget.
*
* @param value the new value
*/
@SuppressWarnings("unchecked")
public void setFormValue(Object value) {
if (value instanceof List) {
List keys = (List)value;
Set keySet = new HashSet(keys);
int i = 0;
for (Map.Entry entry : m_items.entrySet()) {
String key = entry.getKey();
CmsCheckBox checkbox = m_checkboxes.get(i);
checkbox.setChecked(keySet.contains(key));
i += 1;
}
}
}
/**
* @see org.opencms.gwt.client.ui.input.I_CmsFormWidget#setFormValueAsString(java.lang.String)
*/
public void setFormValueAsString(String formValue) {
if (formValue == null) {
formValue = "";
}
List values = CmsStringUtil.splitAsList(formValue, "|");
setFormValue(values);
}
/**
* Enables or disables italics display in the checkbox labels.
*
* @param weak true if italics display should be enabled
*/
public void setTextWeak(boolean weak) {
String style = I_CmsInputLayoutBundle.INSTANCE.inputCss().weakText();
if (weak) {
addStyleName(style);
} else {
removeStyleName(style);
}
}
/**
* Fires the value change event for the widget.
*
* @param newValue the new value
*/
protected void fireValueChanged(String newValue) {
ValueChangeEvent.fire(this, newValue);
}
/**
* Initializes the widget given a map of select options.
*
* The keys of the map are the values of the select options, while the values of the map
* are the labels which should be used for the checkboxes.
*
* @param items the map of select options
*/
protected void init(Map items) {
initWidget(m_panel);
m_items = new LinkedHashMap(items);
m_panel.setStyleName(I_CmsInputLayoutBundle.INSTANCE.inputCss().multiCheckBox());
m_panel.addStyleName(I_CmsLayoutBundle.INSTANCE.generalCss().textMedium());
FocusHandler focusHandler = new FocusHandler() {
public void onFocus(FocusEvent event) {
CmsDomUtil.fireFocusEvent(CmsMultiCheckBox.this);
}
};
for (Map.Entry entry : items.entrySet()) {
String value = entry.getValue();
CmsCheckBox checkbox = new CmsCheckBox(value);
// wrap the check boxes in FlowPanels to arrange them vertically
FlowPanel checkboxWrapper = new FlowPanel();
checkboxWrapper.add(checkbox);
checkbox.addValueChangeHandler(new ValueChangeHandler() {
public void onValueChange(ValueChangeEvent valueChanged) {
fireValueChanged(getFormValueAsString());
}
});
checkbox.getButton().addFocusHandler(focusHandler);
m_panel.add(checkboxWrapper);
m_checkboxes.add(checkbox);
}
m_panel.add(m_error);
}
/**
* @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());
}
}