nextapp.echo2.extras.app
Class TransitionPane

java.lang.Object
  Component
      nextapp.echo2.extras.app.TransitionPane

public class TransitionPane
extends Component

A container pane which displays a single child pane or component, rendering an animated transition effect when its content is changed (when the child is removed and a new one is added). WARNING: This component is EXPERIMENTAL. The API is VERY LIKELY to change. But you're going to use it anyway, aren't you?

Field Summary

static int	DEFAULT_DURATION Default duration time, 350ms.
static java.lang.String	PROPERTY_DURATION
static java.lang.String	PROPERTY_TYPE
static int	TYPE_BLIND_BLACK_IN A horizontal blind effect with a black background.
static int	TYPE_BLIND_BLACK_OUT A horizontal blind effect with a black background.
static int	TYPE_CAMERA_PAN_DOWN Transition setting describing a visual effect where the viewing area pans to up to realize the new content.
static int	TYPE_CAMERA_PAN_LEFT Transition setting describing a visual effect where the viewing area pans to the left to realize the new content.
static int	TYPE_CAMERA_PAN_RIGHT Transition setting describing a visual effect where the viewing area pans to the right to realize the new content.
static int	TYPE_CAMERA_PAN_UP Transition setting describing a visual effect where the viewing area pans up to realize the new content.
static int	TYPE_FADE Fades to new content over old content.
static int	TYPE_FADE_TO_BLACK Fades to black, fades in new content.
static int	TYPE_FADE_TO_WHITE Fades to white, fades in new content.
static int	TYPE_IMMEDIATE_REPLACE Transition setting indicating new content should immediately final int replace old content with no visual effect.

Constructor Summary

TransitionPane()

Method Summary

int	getDuration() Returns the transition duration, in milleseconds.
int	getType() Sets the transition type.
boolean	isValidChild(Component c)
boolean	isValidParent(Component c)
void	setDuration(int newValue) Sets the transition duration, in milleseconds.
void	setType(int newValue) Sets the transition type.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_IMMEDIATE_REPLACE

public static final int TYPE_IMMEDIATE_REPLACE

Transition setting indicating new content should immediately final int replace old content with no visual effect.

See Also:

Constant Field Values

TYPE_CAMERA_PAN_LEFT

public static final int TYPE_CAMERA_PAN_LEFT

Transition setting describing a visual effect where the viewing area pans to the left to realize the new content. Old content exits to the right side of the screen. New content enters from the left side of the screen.

See Also:

Constant Field Values

TYPE_CAMERA_PAN_RIGHT

public static final int TYPE_CAMERA_PAN_RIGHT

Transition setting describing a visual effect where the viewing area pans to the right to realize the new content. Old content exits to the left side of the screen. New content enters from the right side of the screen.

See Also:

Constant Field Values

TYPE_CAMERA_PAN_UP

public static final int TYPE_CAMERA_PAN_UP

Transition setting describing a visual effect where the viewing area pans up to realize the new content. Old content exits to the bottom of the screen. New content enters from the top of the screen.

See Also:

Constant Field Values

TYPE_CAMERA_PAN_DOWN

public static final int TYPE_CAMERA_PAN_DOWN

Transition setting describing a visual effect where the viewing area pans to up to realize the new content. Old content exits to the top of the screen. New content enters from the bottom of the screen.

See Also:

Constant Field Values

TYPE_BLIND_BLACK_IN

public static final int TYPE_BLIND_BLACK_IN

A horizontal blind effect with a black background. Top of blinds rotate inward.

See Also:

Constant Field Values

TYPE_BLIND_BLACK_OUT

public static final int TYPE_BLIND_BLACK_OUT

A horizontal blind effect with a black background. Top of blinds rotate outward.

See Also:

Constant Field Values

TYPE_FADE_TO_BLACK

public static final int TYPE_FADE_TO_BLACK

Fades to black, fades in new content.

See Also:

Constant Field Values

TYPE_FADE_TO_WHITE

public static final int TYPE_FADE_TO_WHITE

Fades to white, fades in new content.

See Also:

Constant Field Values

TYPE_FADE

public static final int TYPE_FADE

Fades to new content over old content.

See Also:

Constant Field Values

PROPERTY_TYPE

public static final java.lang.String PROPERTY_TYPE

See Also:

Constant Field Values

PROPERTY_DURATION

public static final java.lang.String PROPERTY_DURATION

See Also:

Constant Field Values

DEFAULT_DURATION

public static final int DEFAULT_DURATION

Default duration time, 350ms.

See Also:

Constant Field Values

Constructor Detail

TransitionPane

public TransitionPane()

Method Detail

getDuration

public int getDuration()

Returns the transition duration, in milleseconds.

Returns:

the transition duration

getType

public int getType()

Sets the transition type.

Returns:

the transition type

isValidChild

public boolean isValidChild(Component c)

See Also:

nextapp.echo2.app.Component#isValidChild(nextapp.echo2.app.Component)

isValidParent

public boolean isValidParent(Component c)

See Also:

nextapp.echo2.app.Component#isValidParent(nextapp.echo2.app.Component)

setDuration

public void setDuration(int newValue)

Sets the transition duration, in milleseconds.

Parameters:

newValue - the new transition duration

setType

public void setType(int newValue)

Sets the transition type.

Parameters:

newValue - the new transition type