tasklist.ui/src/org/netbeans/modules/tasklist/ui/checklist/CheckListModel.java

/**
 * 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.netbeans.modules.tasklist.ui.checklist;

import javax.swing.ListModel;

/**
 * Model for CheckList
 * @see CheckList
 */
public interface CheckListModel extends ListModel {
    /**
     * Returns the state of the checkbox for the specified index.
     * @param index the requested index
     */
    public boolean isChecked(int index);

    /**
     * Changes the state of the checkbox for the specified index.
     * @param index index of an item
     * @param c new state
     */
    public void setChecked(int index, boolean c);

    /**
     * Optional description for use in a tool tip.
     * @param index index of an item
     * @return description text, or null
     */
    String getDescription(int index);

}