DocumentWindow.java

package org.esa.snap.netbeans.docwin;

import org.openide.windows.TopComponent;

/*
 * Represents a document window.
 * <p>
 * This interface is usually implemented by classes derived from {@code TopComponent}. A document window is usually
 * opened from a document data or node context and keeps a reference to the document data or node.
 * <p>
 * A single document/node type may have multiple possible document window types.
 * There can be any number of document window instances for a single document/node. If a document is closed,
 * associated document windows will be closed as well.
 * <p>
 * Only none or a single document window can be selected at a given time. Note that the selection of document windows
 * is independent from the activation of non-document {@code TopComponent} windows. But if a {@code TopComponent}
 * implementing the {@code DocumentWindow} interface is activated, it will always also be the
 * {@link #isSelected() selected} one.
 *
 * @param <D> The document type
 * @param <V> The view type.
 * @author Norman Fomferra
 * @since 1.0
 */
public interface DocumentWindow<D, V> extends NotifiableComponent {
    /**
     * @return The associated document data or node.
     */
    D getDocument();

    /**
     * @return The associated view.
     */
    V getView();

    /**
     * @return The {@code TopComponent} for this window.
     */
    TopComponent getTopComponent();

    /**
     * @return {@code true} if this is window is selected.
     */
    boolean isSelected();

    /**
     * Requests that this document window shall be the only selected one. If it succeeds it will cause any previously
     * selected document window to become deselected.
     */
    void requestSelected();

    /**
     * Called when this component was selected.
     */
    void componentSelected();

    /**
     * Called when this component was deselected.
     */
    void componentDeselected();

    /**
     * Called when the document is about to be closed.
     * Usually this method closes this window and releases associated resources.
     */
    void documentClosing();
}