1/*
2 * Copyright (c) 2003, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26
27package java.awt;
28
29/**
30 * A class that describes the pointer position.
31 * It provides the {@code GraphicsDevice} where the pointer is and
32 * the {@code Point} that represents the coordinates of the pointer.
33 * <p>
34 * Instances of this class should be obtained via
35 * {@link MouseInfo#getPointerInfo}.
36 * The {@code PointerInfo} instance is not updated dynamically as the mouse
37 * moves. To get the updated location, you must call
38 * {@link MouseInfo#getPointerInfo} again.
39 *
40 * @see MouseInfo#getPointerInfo
41 * @author Roman Poborchiy
42 * @since 1.5
43 */
44public class PointerInfo {
45
46    private final GraphicsDevice device;
47    private final Point location;
48
49    /**
50     * Package-private constructor to prevent instantiation.
51     */
52    PointerInfo(final GraphicsDevice device, final Point location) {
53        this.device = device;
54        this.location = location;
55    }
56
57    /**
58     * Returns the {@code GraphicsDevice} where the mouse pointer was at the
59     * moment this {@code PointerInfo} was created.
60     *
61     * @return {@code GraphicsDevice} corresponding to the pointer
62     * @since 1.5
63     */
64    public GraphicsDevice getDevice() {
65        return device;
66    }
67
68    /**
69     * Returns the {@code Point} that represents the coordinates of the pointer
70     * on the screen. See {@link MouseInfo#getPointerInfo} for more information
71     * about coordinate calculation for multiscreen systems.
72     *
73     * @return coordinates of mouse pointer
74     * @see MouseInfo
75     * @see MouseInfo#getPointerInfo
76     * @since 1.5
77     */
78    public Point getLocation() {
79        return location;
80    }
81}
82