com.jidesoft.docking.event
Interface DockableFrameDropListener

All Superinterfaces:

EventListener

public interface DockableFrameDropListener
extends EventListener

A listener that listens to any possible docking actions during drag-n-drop of a dockable frame. You can use this listener to prevent a dockable frame being docked to a certain target by return false in the isDockingAllowed method. The isDockingAllowed is called every time before it displays a rectangle outline to indicate the docking position.

Method Summary

boolean

isDockingAllowed(DockableFrame source, Component target, int side) Checks if the source dockable frame can be docked on the target component at the specified side.

Method Detail

isDockingAllowed

boolean isDockingAllowed(DockableFrame source,
                         Component target,
                         int side)

Checks if the source dockable frame can be docked on the target component at the specified side.

Parameters:

source - the dockable frame to be docked.

target - the target component that will accept the docked dockable frame. The target component can be a DockableFrame, a Workspace, a DockedFrameContainer or a ContainerContainerDivider.

side - one of the values DOCK_SIDE_... as defined in DockContext. If the target is an instance of ContainerContainerDivider, the side will be -1.

Returns:

true or false. If true, the docking is allowed. Otherwise it's not allowed to be docked.