org.apache.wicket.extensions.model.AbstractCheckBoxModel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation

Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.

There is a newer version: 5.0.0

Show newest version

/*
 * 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.extensions.model;

import org.apache.wicket.Component;
import org.apache.wicket.model.IModel;

/**
 * Model adapter that makes working with models for checkboxes easier.
 * 
 * @author Igor Vaynberg (ivaynberg)
 * 
 */
public abstract class AbstractCheckBoxModel implements IModel
{
	private static final long serialVersionUID = 1L;

	/**
	 * Detach model.
	 */
	public void detach()
	{
	}

	/**
	 * @return true to indicate the checkbox should be selected, false otherwise
	 */
	public abstract boolean isSelected();

	/**
	 * Called when checkbox has been selected
	 * 
	 */
	public abstract void select();

	/**
	 * Called when checkbox is unselected
	 * 
	 */
	public abstract void unselect();

	/**
	 * 
	 * @see org.apache.wicket.model.IModel#getObject()
	 */
	public final Boolean getObject()
	{
		return isSelected();
	}

	/**
	 * @see org.apache.wicket.model.IModel#setObject(Object)
	 */
	public final void setObject(final Boolean object)
	{
		if (Boolean.TRUE.equals(object))
		{
			select();
		}
		else
		{
			unselect();
		}
	}


	// TODO Remove methods after deprecation release is done

	/**
	 * @param component
	 * @return throws UnsupportedOperationException
	 * @deprecated replaced by {@link #getObject()}
	 */
	@Deprecated
	public final Object getObject(final Component component)
	{
		throw new UnsupportedOperationException();
	}

	/**
	 * @param component
	 * @return throws UnsupportedOperationException
	 * @deprecated replaced by {@link #isSelected()}
	 */
	@Deprecated
	public final boolean isSelected(final Component component)
	{
		throw new UnsupportedOperationException();
	}

	/**
	 * @param component
	 * @param object
	 * @deprecated replaced by {@link #setObject(Object)}
	 */
	@Deprecated
	public final void setObject(final Component component, final Object object)
	{
		throw new UnsupportedOperationException();
	}

	/**
	 * @param component
	 * @param sel
	 * @deprecated replaced by {@link #select()}
	 */
	@Deprecated
	public final void setSelected(final Component component, final boolean sel)
	{
		throw new UnsupportedOperationException();
	}
}