/*
* Copyright (c) 2010, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.scene.shape;
import com.sun.javafx.geom.Path2D;
import com.sun.javafx.scene.shape.VLineToHelper;
import com.sun.javafx.sg.prism.NGPath;
import javafx.beans.property.DoubleProperty;
import javafx.beans.property.DoublePropertyBase;
Creates a vertical line path element from the current point to y.
For more information on path elements see the Path
and PathElement
classes.
Example:
import javafx.scene.shape.*;
Path path = new Path();
path.getElements().add(new MoveTo(50.0f, 0.0f));
path.getElements().add(new VLineTo(50.0f));
Since: JavaFX 2.0
/**
* Creates a vertical line path element from the current point to y.
*
* <p>For more information on path elements see the {@link Path} and
* {@link PathElement} classes.
*
* <p>Example:
<PRE>
import javafx.scene.shape.*;
Path path = new Path();
path.getElements().add(new MoveTo(50.0f, 0.0f));
path.getElements().add(new VLineTo(50.0f));
</PRE>
* @since JavaFX 2.0
*/
public class VLineTo extends PathElement {
static {
VLineToHelper.setVLineToAccessor(new VLineToHelper.VLineToAccessor() {
@Override
public void doAddTo(PathElement pathElement, Path2D path) {
((VLineTo) pathElement).doAddTo(path);
}
});
}
Creates an empty instance of VLineTo.
/**
* Creates an empty instance of VLineTo.
*/
public VLineTo() {
VLineToHelper.initHelper(this);
}
Creates an instance of VLineTo.
Params: - y – the vertical coordinate to line to
/**
* Creates an instance of VLineTo.
* @param y the vertical coordinate to line to
*/
public VLineTo(double y) {
setY(y);
VLineToHelper.initHelper(this);
}
Defines the Y coordinate.
@defaultValue 0.0
/**
* Defines the Y coordinate.
*
* @defaultValue 0.0
*/
private DoubleProperty y = new DoublePropertyBase() {
@Override
public void invalidated() {
u();
}
@Override
public Object getBean() {
return VLineTo.this;
}
@Override
public String getName() {
return "y";
}
};
public final void setY(double value) {
y.set(value);
}
public final double getY() {
return y.get();
}
public final DoubleProperty yProperty() {
return y;
}
@Override
void addTo(NGPath pgPath) {
if (isAbsolute()) {
pgPath.addLineTo(pgPath.getCurrentX(), (float)getY());
} else {
pgPath.addLineTo(pgPath.getCurrentX(), (float)(pgPath.getCurrentY() + getY()));
}
}
/*
* Note: This method MUST only be called via its accessor method.
*/
private void doAddTo(Path2D path) {
if (isAbsolute()) {
path.lineTo(path.getCurrentX(), (float)getY());
} else {
path.lineTo(path.getCurrentX(), (float)(path.getCurrentY() + getY()));
}
}
Returns a string representation of this VLineTo
object. Returns: a string representation of this VLineTo
object.
/**
* Returns a string representation of this {@code VLineTo} object.
* @return a string representation of this {@code VLineTo} object.
*/
@Override
public String toString() {
final StringBuilder sb = new StringBuilder("VLineTo[");
sb.append("y=").append(getY());
return sb.append("]").toString();
}
}