bibliothek.gui.dock.station.toolbar.ToolbarContainerConverterCallback Maven / Gradle / Ivy
/*
* Bibliothek - DockingFrames
* Library built on Java/Swing, allows the user to "drag and drop"
* panels containing any Swing-Component the developer likes to add.
*
* Copyright (C) 2012 Herve Guillaume, Benjamin Sigg
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Herve Guillaume
* [email protected]
* FR - France
*
* Benjamin Sigg
* [email protected]
* CH - Switzerland
*/
package bibliothek.gui.dock.station.toolbar;
import bibliothek.gui.Dockable;
import bibliothek.gui.dock.ToolbarContainerDockStation;
import bibliothek.gui.dock.station.StationChildHandle;
import bibliothek.gui.dock.station.support.DockablePlaceholderList;
import bibliothek.util.FrameworkOnly;
/**
* An interface allowing a {@link ToolbarContainerConverter} to call some
* internal methods of {@link ToolbarContainerDockStation}.
*
* @author Benjamin Sigg
* @author Herve Guillaume
*/
@FrameworkOnly
public interface ToolbarContainerConverterCallback{
/**
* Creates a new {@link StationChildHandle} for dockable, the
* new handle must not be added to any collection.
*
* @param dockable
* the element to wrap
* @return the new {@link StationChildHandle}, must not be null
*/
public StationChildHandle wrap( Dockable dockable );
/**
* Called before dockable is added to the list of dockables.
*
* @param dockable
* the new element, not null
*/
public void adding( StationChildHandle dockable );
/**
* Called after dockable was added to the list of dockables.
*
* @param dockable
* the new element, not null
*/
public void added( StationChildHandle dockable );
/**
* Replaces the list of dockables.
*
* @param list
* the new list of dockables, not null
*/
public void setDockables( DockablePlaceholderList list );
/**
* Called after {@link #setDockables(DockablePlaceholderList)} and after all
* children have been stored in list.
*
* @param list
* the list whose creation was finished
*/
public void finished( DockablePlaceholderList list );
}