Module org.controlsfx.controls

Package impl.org.controlsfx.tools.rectangle.change

Class ToSouthChangeStrategy

java.lang.Object

impl.org.controlsfx.tools.rectangle.change.ToSouthChangeStrategy

All Implemented Interfaces:

Rectangle2DChangeStrategy

public class ToSouthChangeStrategy
extends Object

A strategy which enlarges an existing rectangle to the south.

Constructor Summary

Constructors

Constructor	Description
ToSouthChangeStrategy(Rectangle2D original, boolean ratioFixed, double ratio, double maxX, double maxY)	Creates a new change strategy which enlarges the specified original rectangle to the northeast.
ToSouthChangeStrategy(Rectangle2D original, boolean ratioFixed, double ratio, Rectangle2D bounds)	Creates a new change strategy which enlarges the specified original rectangle to the south.

Method Summary

Modifier and Type	Method	Description
protected void	afterEndHook(Point2D point)	Called after the change ends at the specified point.
protected void	beforeBeginHook(Point2D point)	Called before the change begins at the specified point.
Rectangle2D	beginChange(Point2D point)	Begins the change at the specified point.
Rectangle2D	continueChange(Point2D point)	Continues the change to the specified point.
protected Rectangle2D	doBegin(Point2D point)	Begins the change at the specified point.
protected Rectangle2D	doContinue(Point2D point)	Continues the change to the specified point.
protected Rectangle2D	doEnd(Point2D point)	Ends the change at the specified point.
Rectangle2D	endChange(Point2D point)	Ends the change at the specified point.
protected Edge2D	getFixedEdge()	Returns the edge which is fixed during the change.
protected double	getRatio()	The current ratio.
protected boolean	isRatioFixed()	Indicates whether the ratio is fixed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToSouthChangeStrategy

public ToSouthChangeStrategy(Rectangle2D original,
                             boolean ratioFixed,
                             double ratio,
                             Rectangle2D bounds)

Creates a new change strategy which enlarges the specified original rectangle to the south. The given ratio is enforced when indicated by ratioFixed.

Parameters:

original - the original rectangle

ratioFixed - indicates whether the rectangle's ratio will be fixed to the ratio

ratio - the possibly fixed ratio of the rectangle created by this strategy

bounds - the bounds within which the rectangle can be resized

ToSouthChangeStrategy

public ToSouthChangeStrategy(Rectangle2D original,
                             boolean ratioFixed,
                             double ratio,
                             double maxX,
                             double maxY)

Creates a new change strategy which enlarges the specified original rectangle to the northeast. The given ratio is enforced when indicated by ratioFixed.

Parameters:

original - the original rectangle

ratioFixed - indicates whether the rectangle's ratio will be fixed to the ratio

ratio - the possibly fixed ratio of the rectangle created by this strategy

maxX - the maximal x-coordinate of the right edge of the created rectangles; must be greater than or equal to the previous rectangle's width

maxY - the maximal y-coordinate of the lower edge of the created rectangles; must be greater than or equal to the previous rectangle's height

Method Detail

getFixedEdge

protected Edge2D getFixedEdge()

Returns the edge which is fixed during the change. Called once when the change begins.

Returns:

the edge which is fixed during the change

doBegin

protected final Rectangle2D doBegin(Point2D point)

Begins the change at the specified point.

Parameters:

point - a point

Returns:

the new rectangle

doContinue

protected Rectangle2D doContinue(Point2D point)

Continues the change to the specified point. Must not be called before a call to Rectangle2DChangeStrategy.beginChange(javafx.geometry.Point2D).

Parameters:

point - a point

Returns:

the new rectangle

doEnd

protected final Rectangle2D doEnd(Point2D point)

Ends the change at the specified point. Must not be called before a call to Rectangle2DChangeStrategy.beginChange(javafx.geometry.Point2D).

Parameters:

point - a point

Returns:

the new rectangle

isRatioFixed

protected final boolean isRatioFixed()

Indicates whether the ratio is fixed. If so, the ratio can be accessed with getRatio().

Returns:

true if the ratio is fixed; false otherwise

getRatio

protected final double getRatio()

The current ratio. Can only be called without exception when isRatioFixed() returns true.

Returns:

the current ratio

beginChange

public final Rectangle2D beginChange(Point2D point)

Begins the change at the specified point.

Specified by:

beginChange in interface Rectangle2DChangeStrategy

Parameters:

point - a point

Returns:

the new rectangle

continueChange

public final Rectangle2D continueChange(Point2D point)

Continues the change to the specified point. Must not be called before a call to Rectangle2DChangeStrategy.beginChange(javafx.geometry.Point2D).

Specified by:

continueChange in interface Rectangle2DChangeStrategy

Parameters:

point - a point

Returns:

the new rectangle

endChange

public final Rectangle2D endChange(Point2D point)

Ends the change at the specified point. Must not be called before a call to Rectangle2DChangeStrategy.beginChange(javafx.geometry.Point2D).

Specified by:

endChange in interface Rectangle2DChangeStrategy

Parameters:

point - a point

Returns:

the new rectangle

beforeBeginHook

protected void beforeBeginHook(Point2D point)

Called before the change begins at the specified point.

Parameters:

point - a point

afterEndHook

protected void afterEndHook(Point2D point)

Called after the change ends at the specified point.

Parameters:

point - a point