com.sencha.gxt.chart.client.draw.path

Class LineToVertical

java.lang.Object

com.sencha.gxt.chart.client.draw.path.PathCommand

com.sencha.gxt.chart.client.draw.path.LineToVertical

public class LineToVertical
extends PathCommand

A PathCommand that represents a vertical line.

Field Summary

Fields inherited from class com.sencha.gxt.chart.client.draw.path.PathCommand

relative

Constructor Summary

Constructors

Constructor and Description
LineToVertical() Creates a vertical line PathCommand.
LineToVertical(double y) Creates a vertical line PathCommand using the given coordinates.
LineToVertical(double y, boolean relative) Creates a vertical line PathCommand using the given coordinates.
LineToVertical(LineToVertical vertical) Creates a copy of the given vertical line PathCommand.

Method Summary

Modifier and Type	Method and Description
void	appendTo(StringBuilder build)
LineToVertical	copy() Returns a copy of the path command.
double	getY() Returns the y-coordinate of the end point of the command.
boolean	nearEqual(PathCommand command) Determines equality of two commands using rounded values.
void	setY(double y) Sets the y-coordinate of the end point of the command.
void	toAbsolute(PrecisePoint currentPoint, PrecisePoint movePoint) Converts the path commands to absolute coordinates using the given frame of reference and the last move.
List<PathCommand>	toCurve(PrecisePoint currentPoint, PrecisePoint movePoint, PrecisePoint curvePoint, PrecisePoint quadraticPoint) Converts the PathCommand to a CurveTo command.
String	toString()

Methods inherited from class com.sencha.gxt.chart.client.draw.path.PathCommand

isRelative, setRelative

Methods inherited from class java.lang.Object

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

Constructor Detail

LineToVertical

public LineToVertical()

Creates a vertical line PathCommand. Defaults to absolute.

LineToVertical

public LineToVertical(double y)

Creates a vertical line PathCommand using the given coordinates. Defaults to absolute.

Parameters:

y - the y-coordinate of the end point of the line

LineToVertical

public LineToVertical(double y,
                      boolean relative)

Creates a vertical line PathCommand using the given coordinates.

Parameters:

y - the y-coordinate of the end point of the line

relative - true if the command is relative

LineToVertical

public LineToVertical(LineToVertical vertical)

Creates a copy of the given vertical line PathCommand.

Parameters:

vertical - the command to be copied

Method Detail

copy

public LineToVertical copy()

Description copied from class: PathCommand

Returns a copy of the path command.

Specified by:

copy in class PathCommand

Returns:

a copy of the path command

getY

public double getY()

Returns the y-coordinate of the end point of the command.

Returns:

the y-coordinate of the end point of the command

nearEqual

public boolean nearEqual(PathCommand command)

Description copied from class: PathCommand

Determines equality of two commands using rounded values.

Specified by:

nearEqual in class PathCommand

Parameters:

command - the command to compare

Returns:

true if equal and false otherwise

setY

public void setY(double y)

Sets the y-coordinate of the end point of the command.

Parameters:

y - the y-coordinate of the end point of the command

toAbsolute

public void toAbsolute(PrecisePoint currentPoint,
                       PrecisePoint movePoint)

Description copied from class: PathCommand

Converts the path commands to absolute coordinates using the given frame of reference and the last move.

Overrides:

toAbsolute in class PathCommand

Parameters:

currentPoint - frame of reference

movePoint - last move point

toCurve

public List<PathCommand> toCurve(PrecisePoint currentPoint,
                                 PrecisePoint movePoint,
                                 PrecisePoint curvePoint,
                                 PrecisePoint quadraticPoint)

Description copied from class: PathCommand

Converts the PathCommand to a CurveTo command. If a MoveTo no conversion takes place, but the current move point is updated.

Specified by:

toCurve in class PathCommand

Parameters:

currentPoint - the current point of the path

movePoint - the frame of reference for the path

curvePoint - the frame of reference for the Bézier

quadraticPoint - the beginning of the last quadratic curve

Returns:

the converted command

toString

public String toString()

Overrides:

toString in class Object

appendTo

public void appendTo(StringBuilder build)

Specified by:

appendTo in class PathCommand