java.awt

Class Point

Implemented Interfaces:
Cloneable, Serializable

public class Point
extends Point2D
implements Serializable

This class represents a point on the screen using cartesian coordinates. Remember that in screen coordinates, increasing x values go from left to right, and increasing y values go from top to bottom.

There are some public fields; if you mess with them in an inconsistent manner, it is your own fault when you get invalid results. Also, this class is not threadsafe.

Since:
1.0
See Also:
Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.geom.Point2D

Point2D.Double, Point2D.Float

Field Summary

int
x
The x coordinate.
int
y
The y coordinate.

Constructor Summary

Point()
Initializes a new instance of Point representing the coordinates (0, 0).
Point(int x, int y)
Initializes a new instance of Point with the specified coordinates.
Point(Point p)
Initializes a new instance of Point with coordinates identical to the coordinates of the specified point.

Method Summary

boolean
equals(Object obj)
Tests whether or not this object is equal to the specified object.
Point
getLocation()
Returns the location of this point.
double
getX()
Get the x coordinate.
double
getY()
Get the y coordinate.
void
move(int x, int y)
Sets this object's coordinates to the specified values.
void
setLocation(double x, double y)
Sets this object's coordinates to the specified values.
void
setLocation(int x, int y)
Sets this object's coordinates to the specified values.
void
setLocation(Point p)
Sets this object's coordinates to match those of the specified point.
String
toString()
Returns a string representation of this object.
void
translate(int dx, int dy)
Changes the coordinates of this point such that the specified dx parameter is added to the existing X coordinate and dy is added to the existing Y coordinate.

Methods inherited from class java.awt.geom.Point2D

clone, distance, distance, distance, distanceSq, distanceSq, distanceSq, equals, getX, getY, hashCode, setLocation, setLocation

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

x

public int x
The x coordinate.

y

public int y
The y coordinate.

Constructor Details

Point

public Point()
Initializes a new instance of Point representing the coordinates (0, 0).
Since:
1.1

Point

public Point(int x,
             int y)
Initializes a new instance of Point with the specified coordinates.
Parameters:
x - the X coordinate
y - the Y coordinate

Point

public Point(Point p)
Initializes a new instance of Point with coordinates identical to the coordinates of the specified point.
Parameters:
p - the point to copy the coordinates from
Throws:
NullPointerException - if p is null

Method Details

equals

public boolean equals(Object obj)
Tests whether or not this object is equal to the specified object. This will be true if and only if the specified object is an instance of Point2D and has the same X and Y coordinates.
Overrides:
equals in interface Point2D
Parameters:
obj - the object to test against for equality
Returns:
true if the specified object is equal

getLocation

public Point getLocation()
Returns the location of this point. A pretty useless method, as this is already a point.
Returns:
a copy of this point
Since:
1.1

getX

public double getX()
Get the x coordinate.
Overrides:
getX in interface Point2D
Returns:
the value of x, as a double

getY

public double getY()
Get the y coordinate.
Overrides:
getY in interface Point2D
Returns:
the value of y, as a double

move

public void move(int x,
                 int y)
Sets this object's coordinates to the specified values. This method is identical to the setLocation(int, int) method.
Parameters:
x - the new X coordinate
y - the new Y coordinate

setLocation

public void setLocation(double x,
                        double y)
Sets this object's coordinates to the specified values. This method rounds to the nearest integer coordinates by adding 0.5 and calling Math.floor(double).
Overrides:
setLocation in interface Point2D
Parameters:
x - the new X coordinate
y - the new Y coordinate

setLocation

public void setLocation(int x,
                        int y)
Sets this object's coordinates to the specified values. This method is identical to the move() method.
Parameters:
x - the new X coordinate
y - the new Y coordinate

setLocation

public void setLocation(Point p)
Sets this object's coordinates to match those of the specified point.
Parameters:
p - the point to copy the coordinates from
Throws:
NullPointerException - if p is null
Since:
1.1

toString

public String toString()
Returns a string representation of this object. The format is: getClass().getName() + "[x=" + x + ",y=" + y + ']'.
Overrides:
toString in interface Object
Returns:
a string representation of this object

translate

public void translate(int dx,
                      int dy)
Changes the coordinates of this point such that the specified dx parameter is added to the existing X coordinate and dy is added to the existing Y coordinate.
Parameters:
dx - the amount to add to the X coordinate
dy - the amount to add to the Y coordinate

Point.java -- represents a point in 2-D space Copyright (C) 1999, 2002, 2006 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath 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 for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.