bibliothek.gui.dock.station.toolbar.group.ToolbarGroupDropInfo 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.group;
import bibliothek.gui.DockStation;
import bibliothek.gui.Dockable;
import bibliothek.gui.dock.ToolbarGroupDockStation;
import bibliothek.gui.dock.displayer.DisplayerCombinerTarget;
import bibliothek.gui.dock.station.StationDropOperation;
import bibliothek.gui.dock.station.support.CombinerTarget;
/**
* This class contains and computes information about a drag and drop action.
* Especially, where the {@link Dockable} should be inserted into which
* {@link DockStation}
*
* @author Herve Guillaume
* @param
* the kind of station using this {@link ToolbarGroupDropInfo}
*/
public abstract class ToolbarGroupDropInfo implements StationDropOperation{
/** The {@link Dockable} which is inserted */
private final Dockable dragDockable;
/**
* The {@link Dockable} which received the dockable (WARNING: this can be
* different to his original dock parent!)
*/
private final ToolbarGroupDockStation stationHost;
/** the column into which to insert the {@link #dragDockable} */
private int column;
/** the row into which to insert the {@link #dragDockable} or -1 */
private int line;
/** whether the operation will change the location of a {@link Dockable} */
private boolean effect;
/**
* Creates a new drop info.
* @param dockable the item that is dropped
* @param station the station onto which dockable is dropped
* @param column the column into which dockable is dropped, this may be an existing
* column or a new column
* @param line the row in which dockable will appear, a value of -1 indicates that
* the item will appear in a new column
* @param effect whether the operation has any effect
*/
public ToolbarGroupDropInfo( Dockable dockable, ToolbarGroupDockStation station, int column, int line, boolean effect ){
this.dragDockable = dockable;
this.stationHost = station;
this.column = column;
this.line = line;
this.effect = effect;
}
@Override
public Dockable getItem(){
return dragDockable;
}
@Override
public ToolbarGroupDockStation getTarget(){
return stationHost;
}
/**
* Tells whether executing this operation will results in any changes of the layout.
* @return whether this operation has an effect
*/
public boolean hasEffect(){
return effect;
}
/**
* Gets the column into which {@link #getItem() the item} is inserted.
* @return the index of the column, this may be an existing column or a new column
*/
public int getColumn(){
return column;
}
/**
* Gets the line into which {@link #getItem() the item} is inserted. A value of -1 indicates
* that a new column is to be created.
* @return the line or -1
*/
public int getLine(){
return line;
}
@Override
public CombinerTarget getCombination(){
// not supported by this kind of station
return null;
}
@Override
public DisplayerCombinerTarget getDisplayerCombination(){
// not supported by this kind of station
return null;
}
@Override
public boolean isMove(){
return getItem().getDockParent() == getTarget();
}
@Override
public String toString(){
return this.getClass().getSimpleName() + '@'
+ Integer.toHexString(hashCode());
}
}