summaryrefslogtreecommitdiff
path: root/java/awt/Cursor.java
blob: 11e015b22701b3e9bd1fea7ac6c336da15c2b9fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/* Cursor.java -- Mouse pointer class
   Copyright (C) 1999 Free Software Foundation, Inc.

This file is part of the non-peer AWT libraries of GNU Classpath.

This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Library General Public License as published 
by the Free Software Foundation, either version 2 of the License, or
(at your option) any later verion.

This library 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 Library General Public License for more details.

You should have received a copy of the GNU Library General Public License
along with this library; if not, write to the Free Software Foundation
Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307 USA. */


package java.awt;

/**
  * This class represents various predefined cursor types.
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public class Cursor implements java.io.Serializable
{

/*
 * Static Variables
 */

/**
  * Constant for the system default cursor type
  */
public static final int DEFAULT_CURSOR = 0;

/**
  * Constant for a cross-hair cursor.
  */
public static final int CROSSHAIR_CURSOR = 1;

/**
  * Constant for a cursor over a text field.
  */
public static final int TEXT_CURSOR = 2;

/**
  * Constant for a cursor to display while waiting for an action to complete.
  */
public static final int WAIT_CURSOR = 3;

/**
  * Cursor used over SW corner of window decorations.
  */
public static final int SW_RESIZE_CURSOR = 4;

/**
  * Cursor used over SE corner of window decorations.
  */
public static final int SE_RESIZE_CURSOR = 5;

/**
  * Cursor used over NW corner of window decorations.
  */
public static final int NW_RESIZE_CURSOR = 6;

/**
  * Cursor used over NE corner of window decorations.
  */
public static final int NE_RESIZE_CURSOR = 7;

/**
  * Cursor used over N edge of window decorations.
  */
public static final int N_RESIZE_CURSOR = 8;

/**
  * Cursor used over S edge of window decorations.
  */
public static final int S_RESIZE_CURSOR = 9;

/**
  * Cursor used over E edge of window decorations.
  */
public static final int E_RESIZE_CURSOR = 10;

/**
  * Cursor used over W edge of window decorations.
  */
public static final int W_RESIZE_CURSOR = 11;

/**
  * Constant for a hand cursor.
  */
public static final int HAND_CURSOR = 12;

/**
  * Constant for a cursor used during window move operations.
  */
public static final int MOVE_CURSOR = 13;

// Serialization constant
private static final long serialVersionUID = 8028237497568985504L;

/*************************************************************************/

/*
 * Instance Variables
 */

/**
  * @serial The numeric id of this cursor.
  */
private int type;

/*************************************************************************/

/*
 * Static Methods
 */

/**
  * Returns an instance of the system default cursor type.
  *
  * @return The system default cursor.
  */
public static Cursor
getDefaultCursor()
{
  return(new Cursor(DEFAULT_CURSOR));
}

/*************************************************************************/

/**
  * Returns an instance of <code>Cursor</code> for one of the specified
  * predetermined types.
  *
  * @param type The type contant from this class.
  *
  * @return The requested predefined cursor.
  *
  * @exception IllegalArgumentException If the constant is not one of the
  * predefined cursor type constants from this class.
  */
public static Cursor
getPredefinedCursor(int type) throws IllegalArgumentException
{
  if ((type < DEFAULT_CURSOR) || (type > MOVE_CURSOR))
    throw new IllegalArgumentException("Bad predefined cursor type: " + type);

  return(new Cursor(type));
}

/*************************************************************************/

/*
 * Constructors
 */

/**
  * Initializes a new instance of <code>Cursor</code> with the specified
  * type.
  *
  * @param type The cursor type.
  */
public
Cursor(int type)
{
  this.type = type;
}

/*************************************************************************/

/**
  * Instance Variables
  */

/**
  * Returns the numeric type identifier for this cursor.
  *
  * @return The cursor id.
  */
public int
getType()
{
  return(type);
}

} // class Cursor