com.vaadin.v7.client.widget.escalator.SpacerUpdater Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vaadin-compatibility-client Show documentation

Vaadin 7 compatibility package for Vaadin 8

There is a newer version: 8.27.3

Show newest version

/*
 * Copyright (C) 2000-2024 Vaadin Ltd
 *
 * This program is available under Vaadin Commercial License and Service Terms.
 *
 * See  for the full
 * license.
 */
package com.vaadin.v7.client.widget.escalator;

import com.vaadin.v7.client.widget.escalator.RowContainer.BodyRowContainer;

/**
 * An interface that handles the display of content for spacers.
 * 
 * The updater is responsible for making sure all elements are properly
 * constructed and cleaned up.
 *
 * @since 7.5.0
 * @author Vaadin Ltd
 * @see Spacer
 * @see BodyRowContainer
 */
public interface SpacerUpdater {

    /** A spacer updater that does nothing. */
    public static final SpacerUpdater NULL = new SpacerUpdater() {
        @Override
        public void init(Spacer spacer) {
            // NOOP
        }

        @Override
        public void destroy(Spacer spacer) {
            // NOOP
        }
    };

    /**
     * Called whenever a spacer should be initialized with content.
     *
     * @param spacer
     *            the spacer reference that should be initialized
     */
    void init(Spacer spacer);

    /**
     * Called whenever a spacer should be cleaned.
     * 
     * The structure to clean up is the same that has been constructed by
     * {@link #init(Spacer)}.
     *
     * @param spacer
     *            the spacer reference that should be destroyed
     */
    void destroy(Spacer spacer);
}