org.nuiton.jaxx.runtime.swing

Class ComponentResizer

java.lang.Object

java.awt.event.MouseAdapter

org.nuiton.jaxx.runtime.swing.ComponentResizer

All Implemented Interfaces:

MouseListener, MouseMotionListener, MouseWheelListener, EventListener

public class ComponentResizer
extends MouseAdapter

The ComponentResizer allows you to resize a component by dragging a border of the component.

Since:

2.5.10

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Component,String>	authorizedDirectionByComponent
static String	DIRECTION_BOTH
static String	DIRECTION_HORIZONTAL
static String	DIRECTION_VERTICAL
protected static int	EAST
protected static int	NORTH
protected static int	SOUTH
protected static int	WEST

Constructor Summary

Constructors

Constructor and Description
ComponentResizer() Convenience contructor.
ComponentResizer(Component... components) Convenience contructor.
ComponentResizer(Insets dragInsets, Component... components) Convenience contructor.
ComponentResizer(Insets dragInsets, Dimension snapSize, Component... components) Create a ComponentResizer.

Method Summary

Modifier and Type	Method and Description
protected void	changeBounds(Component source, int direction, Rectangle bounds, Point pressed, Point current)
void	deregisterComponent(Component... components) Remove listeners from the specified component
Insets	getDragInsets() Get the drag insets
Dimension	getMaximumSize() Get the components maximum size.
Dimension	getMinimumSize() Get the components minimum size.
Dimension	getSnapSize() Get the snap size.
void	mouseDragged(MouseEvent e) Resize the component ensuring location and size is within the bounds of the parent container and that the size is within the minimum and maximum constraints.
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e) Restore the original state of the Component
void	registerComponent(Component... components) Add the required listeners to the specified component
void	registerComponent(String authorizedDirection, Component... components)
void	setDragInsets(Insets dragInsets) Set the drag dragInsets.
void	setMaximumSize(Dimension maximumSize) Specify the maximum size for the component.
void	setMinimumSize(Dimension minimumSize) Specify the minimum size for the component.
void	setSnapSize(Dimension snapSize) Control how many pixels a border must be dragged before the size of the component is changed.

Methods inherited from class java.awt.event.MouseAdapter

mouseClicked, mouseWheelMoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DIRECTION_VERTICAL

public static final String DIRECTION_VERTICAL

See Also:

Constant Field Values

DIRECTION_HORIZONTAL

public static final String DIRECTION_HORIZONTAL

See Also:

Constant Field Values

DIRECTION_BOTH

public static final String DIRECTION_BOTH

See Also:

Constant Field Values

NORTH

protected static final int NORTH

See Also:

Constant Field Values

WEST

protected static final int WEST

See Also:

Constant Field Values

SOUTH

protected static final int SOUTH

See Also:

Constant Field Values

EAST

protected static final int EAST

See Also:

Constant Field Values

authorizedDirectionByComponent

protected final Map<Component,String> authorizedDirectionByComponent

Constructor Detail

ComponentResizer

public ComponentResizer()

Convenience contructor. All borders are resizable in increments of a single pixel. Components must be registered separately.

ComponentResizer

public ComponentResizer(Component... components)

Convenience contructor. All borders are resizable in increments of a single pixel. Components can be registered when the class is created or they can be registered separately afterwards.

Parameters:

components - components to be automatically registered

ComponentResizer

public ComponentResizer(Insets dragInsets,
                        Component... components)

Convenience contructor. Eligible borders are resisable in increments of a single pixel. Components can be registered when the class is created or they can be registered separately afterwards.

Parameters:

dragInsets - Insets specifying which borders are eligible to be resized.

components - components to be automatically registered

ComponentResizer

public ComponentResizer(Insets dragInsets,
                        Dimension snapSize,
                        Component... components)

Create a ComponentResizer.

Parameters:

dragInsets - Insets specifying which borders are eligible to be resized.

snapSize - Specify the dimension to which the border will snap to when being dragged. Snapping occurs at the halfway mark.

components - components to be automatically registered

Method Detail

getDragInsets

public Insets getDragInsets()

Get the drag insets

Returns:

the drag insets

setDragInsets

public void setDragInsets(Insets dragInsets)

Set the drag dragInsets. The insets specify an area where mouseDragged events are recognized from the edge of the border inwards. A value of 0 for any size will imply that the border is not resizable. Otherwise the appropriate drag cursor will appear when the mouse is inside the resizable border area.

Parameters:

dragInsets - Insets to control which borders are resizeable.

getMaximumSize

public Dimension getMaximumSize()

Get the components maximum size.

Returns:

the maximum size

setMaximumSize

public void setMaximumSize(Dimension maximumSize)

Specify the maximum size for the component. The component will still be constrained by the size of its parent.

Parameters:

maximumSize - the maximum size for a component.

getMinimumSize

public Dimension getMinimumSize()

Get the components minimum size.

Returns:

the minimum size

setMinimumSize

public void setMinimumSize(Dimension minimumSize)

Specify the minimum size for the component. The minimum size is constrained by the drag insets.

Parameters:

minimumSize - the minimum size for a component.

deregisterComponent

public void deregisterComponent(Component... components)

Remove listeners from the specified component

Parameters:

components - the component the listeners are removed from

registerComponent

public void registerComponent(Component... components)

Add the required listeners to the specified component

Parameters:

components - the component the listeners are added to

registerComponent

public void registerComponent(String authorizedDirection,
                              Component... components)

getSnapSize

public Dimension getSnapSize()

Get the snap size.

Returns:

the snap size.

setSnapSize

public void setSnapSize(Dimension snapSize)

Control how many pixels a border must be dragged before the size of the component is changed. The border will snap to the size once dragging has passed the halfway mark.

Parameters:

snapSize - Dimension object allows you to separately spcify a horizontal and vertical snap size.

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

Overrides:

mouseMoved in class MouseAdapter

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

Overrides:

mouseEntered in class MouseAdapter

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

Overrides:

mouseExited in class MouseAdapter

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class MouseAdapter

mouseReleased

public void mouseReleased(MouseEvent e)

Restore the original state of the Component

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class MouseAdapter

mouseDragged

public void mouseDragged(MouseEvent e)

Resize the component ensuring location and size is within the bounds of the parent container and that the size is within the minimum and maximum constraints. All calculations are done using the bounds of the component when the resizing started.

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class MouseAdapter

changeBounds

protected void changeBounds(Component source,
                            int direction,
                            Rectangle bounds,
                            Point pressed,
                            Point current)