| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.wicket.markup.html.form; |
| |
| import java.util.Locale; |
| |
| import org.apache.wicket.IRequestListener; |
| import org.apache.wicket.markup.ComponentTag; |
| import org.apache.wicket.model.IModel; |
| import org.apache.wicket.request.mapper.parameter.PageParameters; |
| import org.apache.wicket.util.convert.IConverter; |
| |
| /** |
| * HTML checkbox input component. |
| * <p> |
| * Java: |
| * |
| * <pre> |
| * form.add(new CheckBox("bool")); |
| * </pre> |
| * |
| * HTML: |
| * |
| * <pre> |
| * <input type="checkbox" wicket:id="bool" /> |
| * </pre> |
| * |
| * </p> |
| * <p> |
| * You can can extend this class and override method wantOnSelectionChangedNotifications() to force |
| * server roundtrips on each selection change. |
| * </p> |
| * <p> |
| * A CheckBox always has a valid therefore values from methods |
| * {@link FormComponent#setRequired(boolean)} and {@link FormComponent#isRequired()} are not taken |
| * into account. |
| * </p> |
| * |
| * @author Jonathan Locke |
| */ |
| public class CheckBox extends FormComponent<Boolean> implements IRequestListener |
| { |
| private static final long serialVersionUID = 1L; |
| |
| /** |
| * @see org.apache.wicket.Component#Component(String) |
| */ |
| public CheckBox(final String id) |
| { |
| this(id, null); |
| } |
| |
| /** |
| * @param id |
| * @param model |
| * @see org.apache.wicket.Component#Component(String, IModel) |
| */ |
| public CheckBox(final String id, IModel<Boolean> model) |
| { |
| super(id, model); |
| setType(Boolean.class); |
| } |
| |
| /** |
| * @see org.apache.wicket.markup.html.form.IOnChangeListener#onSelectionChanged() |
| */ |
| @Override |
| public void onRequest() |
| { |
| convertInput(); |
| updateModel(); |
| onSelectionChanged(getModelObject()); |
| } |
| |
| /** |
| * Template method that can be overridden by clients that implement IOnChangeListener to be |
| * notified by onChange events of a select element. This method does nothing by default. |
| * <p> |
| * Called when a option is selected of a dropdown list that wants to be notified of this event. |
| * This method is to be implemented by clients that want to be notified of selection events. |
| * |
| * @param newSelection |
| * The newly selected object of the backing model NOTE this is the same as you would |
| * get by calling getModelObject() if the new selection were current |
| * @see #wantOnSelectionChangedNotifications() |
| */ |
| protected void onSelectionChanged(Boolean newSelection) |
| { |
| } |
| |
| /** |
| * Whether this component's onSelectionChanged event handler should called using javascript if |
| * the selection changes. If true, a roundtrip will be generated with each selection change, |
| * resulting in the model being updated (of just this component) and onSelectionChanged being |
| * called. This method returns false by default. |
| * |
| * @return True if this component's onSelectionChanged event handler should called using |
| * javascript if the selection changes |
| */ |
| protected boolean wantOnSelectionChangedNotifications() |
| { |
| return false; |
| } |
| |
| /** |
| * @see org.apache.wicket.MarkupContainer#getStatelessHint() |
| */ |
| @Override |
| protected boolean getStatelessHint() |
| { |
| if (wantOnSelectionChangedNotifications()) |
| { |
| return false; |
| } |
| return super.getStatelessHint(); |
| } |
| |
| /** |
| * Processes the component tag. |
| * |
| * @param tag |
| * Tag to modify |
| * @see org.apache.wicket.Component#onComponentTag(ComponentTag) |
| */ |
| @Override |
| protected void onComponentTag(final ComponentTag tag) |
| { |
| checkComponentTag(tag, "input"); |
| checkComponentTagAttribute(tag, "type", "checkbox"); |
| |
| final String value = getValue(); |
| final IConverter<Boolean> converter = getConverter(Boolean.class); |
| final Boolean checked = converter.convertToObject(value, getLocale()); |
| |
| if (Boolean.TRUE.equals(checked)) |
| { |
| tag.put("checked", "checked"); |
| } |
| else |
| { |
| // In case the attribute was added at design time |
| tag.remove("checked"); |
| } |
| |
| // remove value attribute, because it overrides the browser's submitted value, eg a [input |
| // type="checkbox" value=""] will always submit as false |
| tag.remove("value"); |
| |
| // Should a roundtrip be made (have onSelectionChanged called) when the |
| // checkbox is clicked? |
| if (wantOnSelectionChangedNotifications()) |
| { |
| CharSequence url = urlForListener(new PageParameters()); |
| |
| Form<?> form = findParent(Form.class); |
| if (form != null) |
| { |
| tag.put("onclick", form.getJsForInterfaceUrl(url)); |
| } |
| else |
| { |
| // NOTE: do not encode the url as that would give invalid |
| // JavaScript |
| tag.put("onclick", "window.location.href='" + url + |
| (url.toString().indexOf('?') > -1 ? "&" : "?") + getInputName() + |
| "=' + this.checked;"); |
| } |
| |
| } |
| |
| super.onComponentTag(tag); |
| } |
| |
| @Override |
| public IConverter<?> createConverter(Class<?> type) |
| { |
| if (Boolean.class.equals(type)) |
| { |
| return CheckBoxConverter.INSTANCE; |
| } |
| return null; |
| } |
| |
| /** |
| * Converter specific to the check box |
| * |
| * @author igor.vaynberg |
| */ |
| private static class CheckBoxConverter implements IConverter<Boolean> |
| { |
| private static final long serialVersionUID = 1L; |
| |
| private static final IConverter<Boolean> INSTANCE = new CheckBoxConverter(); |
| |
| /** |
| * Constructor |
| */ |
| private CheckBoxConverter() |
| { |
| |
| } |
| |
| /** |
| * @see org.apache.wicket.util.convert.IConverter#convertToObject(java.lang.String, |
| * java.util.Locale) |
| */ |
| @Override |
| public Boolean convertToObject(String value, Locale locale) |
| { |
| if ("on".equals(value) || "true".equals(value)) |
| { |
| return Boolean.TRUE; |
| } |
| else |
| { |
| return Boolean.FALSE; |
| } |
| } |
| |
| /** |
| * @see org.apache.wicket.util.convert.IConverter#convertToString(java.lang.Object, |
| * java.util.Locale) |
| */ |
| @Override |
| public String convertToString(Boolean value, Locale locale) |
| { |
| return value.toString(); |
| } |
| } |
| |
| @Override |
| public boolean checkRequired() |
| { |
| // a checkbox always has a value so this check always passes |
| return true; |
| } |
| |
| } |