com.wordpress.tipsforjava.swing
[Java] Class ComponentMover

java.lang.Object
  java.awt.event.MouseAdapter
      com.wordpress.tipsforjava.swing.ComponentMover

public class ComponentMover
extends MouseAdapter

This class allows you to move a Component by using a mouse. The Component moved can be a high level Window (ie. Window, Frame, Dialog) in which case the Window is moved within the desktop. Or the Component can belong to a Container in which case the Component is moved within the Container. When moving a Window, the listener can be added to a child Component of the Window. In this case attempting to move the child will result in the Window moving. For example, you might create a custom "Title Bar" for an undecorated Window and moving of the Window is accomplished by moving the title bar only. Multiple components can be registered as "window movers". Components can be registered when the class is created. Additional components can be added at any time using the registerComponent() method.

Authors:

Rob Camick

Darryl Burke

autoscrolls

private boolean autoscrolls

changeCursor

private boolean changeCursor

destination

private Component destination

destinationClass

private Class destinationClass

destinationComponent

private Component destinationComponent

dragInsets

private Insets dragInsets

location

private Point location

originalCursor

private Cursor originalCursor

pressed

private Point pressed

snapSize

private Dimension snapSize

source

private Component source

ComponentMover

public ComponentMover()

Constructor for moving individual components. The components must be regisetered using the registerComponent() method.

ComponentMover

public ComponentMover(Class destinationClass, Component... components)

Constructor to specify a Class of Component that will be moved when drag events are generated on a registered child component. The events will be passed to the first ancestor of this specified class.

Parameters:

destinationClass - the Class of the ancestor component

component - the Components to be registered for forwarding drag events to the ancestor Component.

ComponentMover

public ComponentMover(Component destinationComponent, Component... components)

Constructor to specify a parent component that will be moved when drag events are generated on a registered child component.

Parameters:

destinationComponent - the component drage events should be forwareded to

components - the Components to be registered for forwarding drag events to the parent component to be moved

deregisterComponent

public void deregisterComponent(Component... components)

Remove listeners from the specified component

Parameters:

component - the component the listeners are removed from

getDragDistance

private int getDragDistance(int larger, int smaller, int snapSize)

getDragInsets

public Insets getDragInsets()

Get the drag insets

Returns:

the drag insets

getSnapSize

public Dimension getSnapSize()

Get the snap size

Returns:

the snap size

isChangeCursor

public boolean isChangeCursor()

Get the change cursor property

Returns:

the change cursor property

mouseDragged

de
	public
public void mouseDragged(MouseEvent e)

Move the component to its new location. The dragged Point must be in the destination coordinates.

mousePressed

de
	public
public void mousePressed(MouseEvent e)

Setup the variables used to control the moving of the component: source - the source component of the mouse event destination - the component that will ultimately be moved pressed - the Point where the mouse was pressed in the destination component coordinates.

mouseReleased

de
	public
public void mouseReleased(MouseEvent e)

Restore the original state of the Component

registerComponent

public void registerComponent(Component... components)

Add the required listeners to the specified component

Parameters:

component - the component the listeners are added to

setChangeCursor

public void setChangeCursor(boolean changeCursor)

Set the change cursor property

Parameters:

changeCursor - when true the cursor will be changed to the Cursor.MOVE_CURSOR while the mouse is pressed

setDragInsets

public void setDragInsets(Insets dragInsets)

Set the drag insets. The insets specify an area where mouseDragged events should be ignored and therefore the component will not be moved. This will prevent these events from being confused with a MouseMotionListener that supports component resizing.

Parameters:

dragInsets

setSnapSize

public void setSnapSize(Dimension snapSize)

Set the snap size. Forces the component to be snapped to the closest grid position. Snapping will occur when the mouse is dragged half way.

setupForDragging

private void setupForDragging(MouseEvent e)

Groovy Documentation