org.xith3d.ui.hud.utils
Class CursorSet

java.lang.Object
  org.xith3d.ui.hud.utils.CursorSet

public class CursorSet
extends java.lang.Object

A CursorSet holds references to Cursors for all different Cursor.Types. They can be null, which means, that the default system cursor is used.

Constructor Summary

CursorSet()
Default no-arg constructor.

CursorSet(CursorSet template)
Constructor.

Method Summary

CursorSet	clone() Returns a new CursorSet based on this CursorSet.
Cursor	get(Cursor.Type cursorType) Returns the Cursor for the given cursor type.
Cursor	getCrosshair() Return the Cursor for the CROSSHAIR cursor.
Cursor	getHelpCursor() Return the Cursor for the HELP cursor.
Cursor	getPointer1() Return the Cursor for the (default) POINTER1 cursor.
Cursor	getPointer2() Return the Cursor for the POINTER2 cursor.
Cursor	getTextCursor() Return the Cursor for the TEXT cursor.
Cursor	getWaitCursor() Return the Cursor for the WAIT cursor.
void	set(Cursor.Type type, Cursor cursor) Sets the Cursor for the given cursor.
void	set(CursorSet template) Sets the CursorSet based on the given template CursorSet.
void	setCrosshair(Cursor cursor) Sets the Cursor for the CROSSHAIR cursor.
void	setHelpCursor(Cursor cursor) Sets the Cursor for the HELP cursor.
void	setPointer1(Cursor cursor) Sets the Cursor for the (default) POINTER1 cursor.
void	setPointer2(Cursor cursor) Sets the Cursor for the POINTER2 cursor.
void	setTextCursor(Cursor cursor) Sets the Cursor for the TEXT cursor.
void	setWaitCursor(Cursor cursor) Sets the Cursor for the WAIT cursor.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CursorSet

public CursorSet(CursorSet template)

Constructor. Creates a new CursorSet based on the given template CursorSet.

Parameters:

template - the template CursorSet to use

CursorSet

public CursorSet()

Default no-arg constructor.

Method Detail

set

public final void set(Cursor.Type type,
                      Cursor cursor)

Sets the Cursor for the given cursor.

Parameters:

type - the Cursor.Type to use

cursor - the Cursor to use

get

public final Cursor get(Cursor.Type cursorType)

Returns the Cursor for the given cursor type.

Parameters:

cursorType - the Cursor.Type

Returns:

the Cursor

setPointer1

public final void setPointer1(Cursor cursor)

Sets the Cursor for the (default) POINTER1 cursor.

Parameters:

cursor - the Cursor to use

getPointer1

public final Cursor getPointer1()

Return the Cursor for the (default) POINTER1 cursor.

Returns:

the Cursor for the (default) POINTER1 cursor

setPointer2

public final void setPointer2(Cursor cursor)

Sets the Cursor for the POINTER2 cursor.

Parameters:

cursor - the Cursor to use

getPointer2

public final Cursor getPointer2()

Return the Cursor for the POINTER2 cursor.

Returns:

the Cursor for the POINTER2 cursor

setCrosshair

public final void setCrosshair(Cursor cursor)

Sets the Cursor for the CROSSHAIR cursor.

Parameters:

cursor - the Cursor to use

getCrosshair

public final Cursor getCrosshair()

Return the Cursor for the CROSSHAIR cursor.

Returns:

the Cursor for the CROSSHAIR cursor

setTextCursor

public final void setTextCursor(Cursor cursor)

Sets the Cursor for the TEXT cursor.

Parameters:

cursor - the Cursor to use

getTextCursor

public final Cursor getTextCursor()

Return the Cursor for the TEXT cursor.

Returns:

the Cursor for the TEXT cursor

setWaitCursor

public final void setWaitCursor(Cursor cursor)

Sets the Cursor for the WAIT cursor.

Parameters:

cursor - the Cursor to use

getWaitCursor

public final Cursor getWaitCursor()

Return the Cursor for the WAIT cursor.

Returns:

the Cursor for the WAIT cursor

setHelpCursor

public final void setHelpCursor(Cursor cursor)

Sets the Cursor for the HELP cursor.

Parameters:

cursor - the Cursor to use

getHelpCursor

public final Cursor getHelpCursor()

Return the Cursor for the HELP cursor.

Returns:

the Cursor for the HELP cursor

set

public void set(CursorSet template)

Sets the CursorSet based on the given template CursorSet.

Parameters:

template - the template CursorSet to use

clone

public final CursorSet clone()

Returns a new CursorSet based on this CursorSet.

Overrides:

clone in class java.lang.Object