org.netbeans.swing.outline.CheckRenderDataProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-swing-outline Show documentation
NetBeans swing outline
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2009 Sun Microsystems, Inc.
 */

package org.netbeans.swing.outline;

/**
 * An extension to {@link RenderDataProvider} adding a possibility to
 * display a check box in the tree portion an Outline, next to the label.
 *
 * @author Martin Entlicher
 * @since 1.4
 */
public interface CheckRenderDataProvider extends RenderDataProvider {

    /**
     * Tell the renderer to display the check-box.
     *
     * @param o the tree object
     * @return true if the check-box should be displayed, false otherwise.
     */
    boolean isCheckable(Object o);

    /**
     * Provide the enabled state of the check-box.
     *
     * @param o the tree object
     * @return true if the check-box should be enabled, false otherwise.
     */
    boolean isCheckEnabled(Object o);

    /**
     * Provide the selected state of the check-box.
     * 
     * @param o the tree object
     * @return true if the check-box should be selected,
     *         false if it should be unselected and
     *         null if the state is unknown.
     */
    Boolean isSelected(Object o);

    /**
     * Called by the renderer when the check-box gets selected/unselected
     * 
     * @param o the tree object
     * @param selected true if the check-box was selected,
     *                 false if the check-box was unselected.
     */
    void setSelected(Object o, Boolean selected);

}