org.apache.wicket.extensions.model.AbstractCheckBoxModel.java Source code

Introduction

Here is the source code for org.apache.wicket.extensions.model.AbstractCheckBoxModel.java

Source

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

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

    /**
     * @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()
     */
    @Override
    public final Boolean getObject() {
        return isSelected();
    }

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