diff options
Diffstat (limited to 'libjava/java/awt/Cursor.java')
| -rw-r--r-- | libjava/java/awt/Cursor.java | 158 |
1 files changed, 133 insertions, 25 deletions
diff --git a/libjava/java/awt/Cursor.java b/libjava/java/awt/Cursor.java index 80f28e6ed73..79b1d6c52ed 100644 --- a/libjava/java/awt/Cursor.java +++ b/libjava/java/awt/Cursor.java @@ -1,39 +1,126 @@ -/* Copyright (C) 2000 Free Software Foundation +/* Copyright (C) 1999, 2000, 2002 Free Software Foundation - This file is part of libgcj. +This file is part of GNU Classpath. -This software is copyrighted work licensed under the terms of the -Libgcj License. Please consult the file "LIBGCJ_LICENSE" for -details. */ +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. -package java.awt; +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., 59 Temple Place, Suite 330, Boston, MA +02111-1307 USA. + +As a special exception, if you link this library with other files to +produce an executable, this library does not by itself cause the +resulting executable to be covered by the GNU General Public License. +This exception does not however invalidate any other reasons why the +executable file might be covered by the GNU General Public License. */ -/* A somewhat incomplete placeholder. */ +package java.awt; + +/** + * This class represents various predefined cursor types. + * + * @author Aaron M. Renn (arenn@urbanophile.com) + */ public class Cursor implements java.io.Serializable { - public static final int DEFAULT_CURSOR = 0, - CROSSHAIR_CURSOR = 1, - TEXT_CURSOR = 2, - WAIT_CURSOR = 3, - SW_RESIZE_CURSOR = 4, - SE_RESIZE_CURSOR = 5, - NW_RESIZE_CURSOR = 6, - NE_RESIZE_CURSOR = 7, - N_RESIZE_CURSOR = 8, - S_RESIZE_CURSOR = 9, - W_RESIZE_CURSOR = 10, - E_RESIZE_CURSOR = 11, - HAND_CURSOR = 12, - MOVE_CURSOR = 13, - CUSTOM_CURSOR = 0xFFFFFFFF; + /** + * 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 W edge of window decorations. + */ + public static final int W_RESIZE_CURSOR = 10; + + /** + * Cursor used over E edge of window decorations. + */ + public static final int E_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; + + public static final int CUSTOM_CURSOR = 0xFFFFFFFF; private static final int PREDEFINED_COUNT = 14; protected static Cursor[] predefined = new Cursor[PREDEFINED_COUNT]; protected String name; + + /** + * @serial The numeric id of this cursor. + */ int type; + /** + * Initializes a new instance of <code>Cursor</code> with the specified + * type. + * + * @param type The cursor type. + */ public Cursor(int type) { if (type < 0 || type >= PREDEFINED_COUNT) @@ -43,14 +130,25 @@ public class Cursor implements java.io.Serializable } /** This constructor is used internally only. - * Application code should call Toolkit.createCustomCursor(). - */ + * Application code should call Toolkit.createCustomCursor(). + */ protected Cursor(String name) { this.name = name; this.type = CUSTOM_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) { if (type < 0 || type >= PREDEFINED_COUNT) @@ -67,11 +165,21 @@ public class Cursor implements java.io.Serializable return null; } + /** + * Returns an instance of the system default cursor type. + * + * @return The system default cursor. + */ public static Cursor getDefaultCursor() { - return getPredefinedCursor(0); + return getPredefinedCursor(DEFAULT_CURSOR); } + /** + * Returns the numeric type identifier for this cursor. + * + * @return The cursor id. + */ public int getType() { return type; |