bibliothek.gui.dock.station.toolbar.group
Class ToolbarGroupDropInfo

java.lang.Object
  extended by bibliothek.gui.dock.station.toolbar.group.ToolbarGroupDropInfo
Type Parameters:
S - the kind of station using this ToolbarGroupDropInfo
All Implemented Interfaces:
bibliothek.gui.dock.station.StationDropOperation

public abstract class ToolbarGroupDropInfo
extends Object
implements bibliothek.gui.dock.station.StationDropOperation

This class contains and computes information about a drag and drop action. Especially, where the Dockable should be inserted into which DockStation

Author:
Herve Guillaume

Constructor Summary
ToolbarGroupDropInfo(bibliothek.gui.Dockable dockable, ToolbarGroupDockStation station, int column, int line, boolean effect)
          Creates a new drop info.
 
Method Summary
 int getColumn()
          Gets the column into which the item is inserted.
 bibliothek.gui.dock.station.support.CombinerTarget getCombination()
           
 bibliothek.gui.dock.displayer.DisplayerCombinerTarget getDisplayerCombination()
           
 bibliothek.gui.Dockable getItem()
           
 int getLine()
          Gets the line into which the item is inserted.
 ToolbarGroupDockStation getTarget()
           
 boolean hasEffect()
          Tells whether executing this operation will results in any changes of the layout.
 boolean isMove()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface bibliothek.gui.dock.station.StationDropOperation
destroy, draw, execute
 

Constructor Detail

ToolbarGroupDropInfo

public ToolbarGroupDropInfo(bibliothek.gui.Dockable dockable,
                            ToolbarGroupDockStation station,
                            int column,
                            int line,
                            boolean effect)
Creates a new drop info.

Parameters:
dockable - the item that is dropped
station - the station onto which dockable is dropped
column - the column into which dockable is dropped, this may be an existing column or a new column
line - the row in which dockable will appear, a value of -1 indiciates that the item will appear in a new column
effect - whether the operation has any effect
Method Detail

getItem

public bibliothek.gui.Dockable getItem()
Specified by:
getItem in interface bibliothek.gui.dock.station.StationDropOperation

getTarget

public ToolbarGroupDockStation getTarget()
Specified by:
getTarget in interface bibliothek.gui.dock.station.StationDropOperation

hasEffect

public boolean hasEffect()
Tells whether executing this operation will results in any changes of the layout.

Returns:
whether this operation has an effect

getColumn

public int getColumn()
Gets the column into which the item is inserted.

Returns:
the index of the column, this may be an existing column or a new column

getLine

public int getLine()
Gets the line into which the item is inserted. A value of -1 indicates that a new column is to be created.

Returns:
the line or -1

getCombination

public bibliothek.gui.dock.station.support.CombinerTarget getCombination()
Specified by:
getCombination in interface bibliothek.gui.dock.station.StationDropOperation

getDisplayerCombination

public bibliothek.gui.dock.displayer.DisplayerCombinerTarget getDisplayerCombination()
Specified by:
getDisplayerCombination in interface bibliothek.gui.dock.station.StationDropOperation

isMove

public boolean isMove()
Specified by:
isMove in interface bibliothek.gui.dock.station.StationDropOperation

toString

public String toString()
Overrides:
toString in class Object