Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Public Member Functions | Static Public Attributes
Spinner Class Reference
Inheritance diagram for Spinner:

Public Member Functions

 Spinner ()
 
void run ()
 
void paint (Graphics g)
 
Dimension getMaximumSize ()
 
Dimension getMinimumSize ()
 
Dimension getPreferredSize ()
 
void start ()
 
void stop ()
 
boolean isStarted ()
 

Static Public Attributes

static final String SPINNER_ICON = "spinner.png"
 
static final int delay = 40
 
static final int IMG_OFFSET = 15
 

Detailed Description

A spinner primvides an animation to indicate that an operation in the system is currently progress. When not spinner, the spinner is in a stopped state and shows a stopped icon to indicate that no operation is in progress. The spinner image itself is a sequence of frames; the first being the stopped image and those preceeding it being the animation steps of the spinner.

Author
Marc McIntyre mmcin.nosp@m.tyre.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Definition at line 33 of file Spinner.java.

Constructor & Destructor Documentation

Spinner ( )
inline

Constructs a spinner object.

Returns
the spinner object

Definition at line 54 of file Spinner.java.

Member Function Documentation

Dimension getMaximumSize ( )
inline

Returns the maximum size of the spinner object

Returns
the maximum size

Definition at line 131 of file Spinner.java.

Dimension getMinimumSize ( )
inline

Returns the maximum size of the spinner object

Returns
the minimum size

Definition at line 139 of file Spinner.java.

Dimension getPreferredSize ( )
inline

Returns the preferred size of the spinner object

Returns
the preferred size

Definition at line 147 of file Spinner.java.

boolean isStarted ( )
inline

Returns TRUE is the spinner is current animating

Returns
TRUE is the spinner is current animating
See Also
start()
stop()

Definition at line 184 of file Spinner.java.

void paint ( Graphics  g)
inline

Paints the component. there are no components to paint so we explicity paint the stopped spinner state when paint is called.

Parameters
gthe graphics that we are paintint to

Definition at line 118 of file Spinner.java.

void run ( )
inline

The run method of this Thread.

Definition at line 87 of file Spinner.java.

void start ( )
inline

Starts the animation of the spinner

See Also
stop()
isStarted()

Definition at line 156 of file Spinner.java.

void stop ( )
inline

Stops the animation of the spinner

See Also
start()
isStarted()

Definition at line 169 of file Spinner.java.

Field Documentation

final int delay = 40
static

The delay between each animation operation

Definition at line 38 of file Spinner.java.

final int IMG_OFFSET = 15
static

The offset which each aniation frame occurs in the image

Definition at line 40 of file Spinner.java.

final String SPINNER_ICON = "spinner.png"
static

The spinner icon

Definition at line 36 of file Spinner.java.

The documentation for this class was generated from the following file: