/*
 * 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;

/**
 * A Javascript-based "Select All" checkbox component that works with {@link CheckBoxMultipleChoice}
 * . By default, clicking on any of the controlled checkboxes automatically updates the state of the
 * "select all" checkbox. Override {@link AbstractCheckSelector#wantAutomaticUpdate()} to change
 * this.
 * 
 * @author Carl-Eric Menzel
 */
public class CheckboxMultipleChoiceSelector extends AbstractCheckSelector
{
	private static final long serialVersionUID = 1L;

	private final CheckBoxMultipleChoice<?> choiceComponent;

	/**
	 * @param id
	 *            The component ID
	 * @param choiceComponent
	 *            The checkbox choice component this Selector will manage.
	 */
	public CheckboxMultipleChoiceSelector(String id, CheckBoxMultipleChoice<?> choiceComponent)
	{
		super(id);

		this.choiceComponent = choiceComponent;
		choiceComponent.setOutputMarkupId(true);
	}

	@Override
	protected CharSequence getFindCheckboxesFunction()
	{
		return String.format("Wicket.CheckboxSelector.findCheckboxesFunction('%s', '%s')",
			choiceComponent.getMarkupId(), choiceComponent.getInputName());
	}
}
