org.gwt.advanced.client.datamodel.DataModelCallbackHandler 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 callback handler interface.
 * It describes the method to be invoked by the data model during different user activities.
 *
 * @author Sergey Skladchikov
 * @since 1.0.0
 */
public interface DataModelCallbackHandler {
    /**
     * This method should synchronize the data saved in the model with the persistent storage
     * repository.
     * NOTE: you must take into account the fact that other grid controls can rise other evets during
     * synchronization. It's better to lock them and unlock when synchronization is finished. Otherwise
     * viewed content may be incorrect.

     * To do lock / unlock operations, use {@link org.gwt.advanced.client.ui.widget.GridPanel#lock()} and
     * {@link org.gwt.advanced.client.ui.widget.GridPanel#unlock()} methods accordingly. Note, the unlock
     * method also redraws the panel.
     *
     * @param model is a model to be used for additional parameters.
     */
    void synchronize(T model);
}