org.drombler.commons.docking.spi.DockingArea Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of drombler-commons-docking-spi Show documentation

Drombler Commons - Docking - SPI provides some utility classes and frameworks to help building a client side docking framework.

There is a newer version: 1.0

Show newest version

/*
 *         COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Notice
 *
 * The contents of this file are subject to the COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL)
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.opensource.org/licenses/cddl1.txt
 *
 * The Original Code is Drombler.org. The Initial Developer of the
 * Original Code is Florian Brunner (Sourceforge.net user: puce).
 * Copyright 2012 Drombler.org. All Rights Reserved.
 *
 * Contributor(s): .
 */
package org.drombler.commons.docking.spi;

/**
 * An abstract Docking Area.
 *
 * Note: The interface might change in future versions.
 *
 * @param  the type of the Docking Area
 * @author puce
 */
public interface DockingArea> {

    /**
     * Sets the parent {@link DockingAreaManager}, which manages this Docking Area.
     *
     * @param parentDockingAreaManager the parent DockingAreaManager, which manages this Docking Area
     */
    void setParentManager(DockingAreaManager parentDockingAreaManager);

    /**
     * Gets the position of the Docking Area.
     *
     * @return the position of the Docking Area
     */
    int getPosition();

    /**
     * Flag which indicates if the Docking Area is or should currently be shown.
     *
     * @return true, if the Docking Area is or should currently be shown, else false
     */
    boolean isVisual();
}

Related Artifacts