NextApp Echo3 Extras
v3.0.b4

nextapp.echo.extras.app
Class TransitionPane

java.lang.Object
  extended by nextapp.echo.app.Component
      extended by nextapp.echo.extras.app.TransitionPane
All Implemented Interfaces:
java.io.Serializable, nextapp.echo.app.Pane, nextapp.echo.app.PaneContainer, nextapp.echo.app.RenderIdSupport

public class TransitionPane
extends nextapp.echo.app.Component
implements nextapp.echo.app.Pane, nextapp.echo.app.PaneContainer

TransitionPane 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). May contain zero or one child components. May contain Pane components as children.

See Also:
Serialized Form

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.
 
Fields inherited from class nextapp.echo.app.Component
CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY
 
Constructor Summary
TransitionPane()
           
 
Method Summary
 int getDuration()
          Returns the transition duration, in milliseconds.
 int getType()
          Sets the transition type.
 boolean isValidChild(nextapp.echo.app.Component c)
           
 boolean isValidParent(nextapp.echo.app.Component c)
           
 void setDuration(int newValue)
          Sets the transition duration, in milliseconds.
 void setType(int newValue)
          Sets the transition type.
 
Methods inherited from class nextapp.echo.app.Component
add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf
 
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 milliseconds.

Returns:
the transition duration

getType

public int getType()
Sets the transition type.

Returns:
the transition type

isValidChild

public boolean isValidChild(nextapp.echo.app.Component c)
Overrides:
isValidChild in class nextapp.echo.app.Component
See Also:
Component.isValidChild(nextapp.echo.app.Component)

isValidParent

public boolean isValidParent(nextapp.echo.app.Component c)
Overrides:
isValidParent in class nextapp.echo.app.Component
See Also:
Component.isValidParent(nextapp.echo.app.Component)

setDuration

public void setDuration(int newValue)
Sets the transition duration, in milliseconds.

Parameters:
newValue - the new transition duration

setType

public void setType(int newValue)
Sets the transition type.

Parameters:
newValue - the new transition type

NextApp Echo3 Extras
v3.0.b4