org.eclipse.jface.dialogs
Class ControlAnimator

java.lang.Object
  org.eclipse.jface.dialogs.ControlAnimator

public class ControlAnimator

extends Object

ControlAnimator provides a simple implementation to display or hide a control. Other animations will be written as subclasses of this class. By setting the animator in the method Policy.setAnimator(ControlAnimator) a new type of animator can be plugged into JFace.

This class is not intended to be extended by clients.

Since:

3.2

Field Summary

static int	CLOSED A constant denoting the CLOSED animation state of a control (value is 0)
static int	CLOSING A constant denoting the CLOSING animation state of a control (value is 3)
static int	OPEN A constant denoting the OPEN animation state of a control (value is 2)
static int	OPENING A constant denoting the OPENING animation state of a control (value is 1)

Constructor Summary

ControlAnimator()

Method Summary

int	getAnimationState() Returns the current state of the control.
void	setAnimationState(int state) Sets the state of the control and whether or not it should be visible.
void	setVisible(boolean visible, Control control) Displays or hides the given control.

Methods inherited from class java.lang.Object

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

Field Detail

CLOSED

public static final int CLOSED

A constant denoting the CLOSED animation state of a control (value is 0)

See Also:

Constant Field Values

OPENING

public static final int OPENING

A constant denoting the OPENING animation state of a control (value is 1)

See Also:

Constant Field Values

OPEN

public static final int OPEN

A constant denoting the OPEN animation state of a control (value is 2)

See Also:

Constant Field Values

CLOSING

public static final int CLOSING

A constant denoting the CLOSING animation state of a control (value is 3)

See Also:

Constant Field Values

Constructor Detail

ControlAnimator

public ControlAnimator()

Method Detail

setVisible

public void setVisible(boolean visible,
                       Control control)

Displays or hides the given control.

Parameters:

visible - true if the control should be shown, and false otherwise.

control - the control to be displayed or hidden.

setAnimationState

public void setAnimationState(int state)

Sets the state of the control and whether or not it should be visible. The value should be one of the following: OPENING, OPEN, CLOSING, or CLOSED

Parameters:

state - the desired state of the control

getAnimationState

public int getAnimationState()

Returns the current state of the control.

Returns:

the current state of the control: OPENING, OPEN, CLOSING, or CLOSED