com.alee.extended.tab.StructureData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation

WebLaF UI components

The newest version!

/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.extended.tab;

import java.awt.*;

/**
 * Base interface for visual parts within {@link com.alee.extended.tab.WebDocumentPane}.
 *
 * @param  {@link DocumentData} type
 * @author Mikle Garin
 * @see How to use WebDocumentPane
 * @see com.alee.extended.tab.WebDocumentPane
 */
public interface StructureData
{
    /**
     * Returns actual {@link Component} behind this {@link StructureData}.
     *
     * @return actual {@link Component} behind this {@link StructureData}
     */
    public Component getComponent ();

    /**
     * Returns closest {@link PaneData}.
     * It is most commonly used to select default active {@link PaneData}.
     *
     * @return closest {@link PaneData}
     */
    public PaneData findClosestPane ();

    /**
     * Returns current {@link DocumentPaneState} for this {@link StructureData}.
     * Might return {@code null} when last side's document is dragged or moved or something is splitted/merged.
     *
     * @return current {@link DocumentPaneState} for this {@link StructureData}
     * @see DocumentPaneState
     */
    public DocumentPaneState getDocumentPaneState ();
}