org.noos.xing.mydoggy.ToolWindowTab Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mydoggy-api

MyDoggy-Api contains the application program interface of MyDoggy to manage every aspects of the framework.

There is a newer version: 1.6.0

package org.noos.xing.mydoggy;

import java.awt.*;

/**
 * Every toolwindow can be considered as a special JTabbedPane and so it can contain more than one component.
 * A ToolWindowTab represents a tab in this special JTabbedPane. Is is described by a title, an icon and a component.
 * A tab can be selected or not.
 *
 * @author Angelo De Caro ([email protected])
 * @since 1.3.0
 */
public interface ToolWindowTab extends Dockable {

    /**
     * Returns the owner ot this tab.
     *
     * @return the owner ot this tab.
     * @since 1.4.0
     */
    ToolWindow getOwner();

    /**
     * This method is used to set the component for the tab.
     *
     * @param component the new component.
     * @see #getComponent() ()
     * @since 1.3.0
     */
    void setComponent(Component component);

    /**
     * Returns whether this tab could be close using the ui.
     *
     * @return true if this content can be closed using the ui, false otherwise.
     * @see #setCloseable(boolean)
     * @since 1.3.0
     */
    boolean isCloseable();

    /**
     * Sets the closeable property of this tab.
     *
     * @param closeable true if this content can be closed using the ui, false otherwise.
     * @see #isCloseable()
     * @since 1.3.0
     */
    void setCloseable(boolean closeable);

    /**
     * Returns whether this tab could be minimized using the ui.
     *
     * @return true if this content can be minimized using the ui, false otherwise.
     * @since 1.5.0
     */
    boolean isMinimizable();

    /**
     * Sets the minimizable property of this tab.
     *
     * @param minimizable true if this content can be minimized using the ui, false otherwise.
     * @see #isMinimizable()
     * @since 1.5.0
     */
    void setMinimizable(boolean minimizable);

    /**
     * Returns the dockable that this tab is accomodating,  null if no dockable is accomodated.
     *
     * @return the dockable that this tab is accomodating,  null if no dockable is accomodated.
     * @see ToolWindow#addToolWindowTab(Dockable)
     * @since 1.4.0
     */
    Dockable getDockableDelegator();
}