org.gwt.advanced.client.datamodel.Hierarchical Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of advanced-gwt Show documentation

The set of useful GWT components

There is a newer version: 2.0.9

/*
 * Copyright 2008-2012 Sergey Skladchikov
 *
 * Licensed 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.gwt.advanced.client.datamodel;

/**
 * This is a hierarchical grid data model interface.
 *
 * @author Sergey Skladchikov
 * @since 1.0.0
 */
public interface Hierarchical extends Editable {
    /**
     * This method adds a new submodel into the cell.
     *
     * @param rowNumber    is a row number.
     * @param columnNumber is a column number.
     * @param model        is a submodel to be added, can be null. If so it removes any model
     *                     from the specified cell if it's added.
     * @throws IllegalArgumentException if row or column numebr is out of range.
     */
    void addSubgridModel(int rowNumber, int columnNumber, GridDataModel model)
            throws IllegalArgumentException;

    /**
     * This method gets a submodel beloging to the specified cell. It returns null
     * if there is no such submodel.
     *
     * @param rowNumber    is a row number.
     * @param columnNumber is a column number.
     * @return a submodel.
     * @throws IllegalArgumentException if row or column numebr is out of range.
     */
    GridDataModel getSubgridModel(int rowNumber, int columnNumber) throws IllegalArgumentException;

    /**
     * This method sets expanded flag for the specified cell.
     *
     * @param row      is a row number.
     * @param column   is a column number.
     * @param expanded is an expanded flag value.
     */
    void setExpanded(int row, int column, boolean expanded);

    /**
     * This method checks whether the specified cell is expanded.
     *
     * @param row    is a row number.
     * @param column is a column number.
     * @return an expanded falg value.
     */
    boolean isExpanded(int row, int column);
}