com.alee.extended.tab.DocumentPaneTransferInfo 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

There is a newer version: 1.2.14

package com.alee.extended.tab;

import com.alee.api.annotations.NotNull;

import java.io.Serializable;

/**
 * Class containing information about {@link WebDocumentPane} drag operation.
 *
 * @author nsofronov
 * @author Mikle Garin
 * @see How to use WebDocumentPane
 * @see WebDocumentPane
 */
public class DocumentPaneTransferInfo implements Serializable
{
    /**
     * {@link WebDocumentPane} unique ID.
     */
    @NotNull
    protected final String documentPaneId;

    /**
     * Whether or not source {@link WebDocumentPane} allows drag between panes.
     */
    @NotNull
    protected final Boolean dragBetweenPanesEnabled;

    /**
     * Constructs new drag operation information.
     *
     * @param documentPane source {@link WebDocumentPane}
     */
    public DocumentPaneTransferInfo ( @NotNull final WebDocumentPane documentPane )
    {
        this.documentPaneId = documentPane.getId ();
        this.dragBetweenPanesEnabled = documentPane.isDragBetweenPanesEnabled ();
    }

    /**
     * Returns {@link WebDocumentPane} unique identifier.
     *
     * @return {@link WebDocumentPane} unique identifier
     */
    @NotNull
    public String getDocumentPaneId ()
    {
        return documentPaneId;
    }

    /**
     * Returns whether or not source {@link WebDocumentPane} allows drag between panes.
     *
     * @return true if source {@link WebDocumentPane} allows drag between panes, false otherwise
     */
    public boolean isDragBetweenPanesEnabled ()
    {
        return dragBetweenPanesEnabled;
    }
}