SceneAnimator (Visual Library API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.api.visual 2.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.api.visual.animator
Class SceneAnimator

java.lang.Object
  org.netbeans.api.visual.animator.SceneAnimator

public final class SceneAnimator
extends Object
extends Object

Manages all animations on a scene. An animation can be registered and started by calling Animator.start method. The class contains a few built-in animators: preferredLocation, preferredBounds, background, foreground, zoomFactor.

Constructor Summary

SceneAnimator(Scene scene)
          Creates a scene animator.

Method Summary

void animateBackgroundColor(Widget widget, Color targetBackgroundColor)
          Starts backgroundColor animation for a specified widget.

void animateForegroundColor(Widget widget, Color targetForegroundColor)
          Starts foregroundColor animation for a specified widget.

void animatePreferredBounds(Widget widget, Rectangle targetPreferredBounds)
          Starts preferredBounds animation for a specified widget.

void animatePreferredLocation(Widget widget, Point targetPreferredLocation)
          Starts preferredLocation animation for a specified widget.

void animateZoomFactor(double targetZoomFactor)
          Starts zoomFactor animation.

Animator getColorAnimator()
          Returns the color animator which animates background and foreground colors of all widgets in the scene.

Animator getPreferredBoundsAnimator()
          Returns the preferred bounds animator which animates preferred bounds of all widgets in the scene.

Animator getPreferredLocationAnimator()
          Returns the preferred location animator which animates preferred location of all widgets in the scene.

Scene getScene()
          Returns an assigned scene.

double getTargetZoomFactor()
          Returns a target zoom factor.

Animator getZoomAnimator()
          Returns the zoom animator.

boolean isAnimatingBackgroundColor(Widget widget)
          Returns whether a backgroundColor animator for a specified widget is running.

boolean isAnimatingForegroundColor(Widget widget)
          Returns whether a foregroundColor animator for a specified widget is running.

boolean isAnimatingPreferredBounds(Widget widget)
          Returns whether a preferredBounds animator for a specified widget is running.

boolean isAnimatingPreferredLocation(Widget widget)
          Returns whether a preferredLocation animator for a specified widget is running.

boolean isAnimatingZoomFactor()
          Returns whether a zoomFactor animator is running.

Methods inherited from class java.lang.Object

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

Constructor Summary
`SceneAnimator(Scene scene)` Creates a scene animator.

Method Summary
`void`	`animateBackgroundColor(Widget widget, Color targetBackgroundColor)` Starts backgroundColor animation for a specified widget.
`void`	`animateForegroundColor(Widget widget, Color targetForegroundColor)` Starts foregroundColor animation for a specified widget.
`void`	`animatePreferredBounds(Widget widget, Rectangle targetPreferredBounds)` Starts preferredBounds animation for a specified widget.
`void`	`animatePreferredLocation(Widget widget, Point targetPreferredLocation)` Starts preferredLocation animation for a specified widget.
`void`	`animateZoomFactor(double targetZoomFactor)` Starts zoomFactor animation.
`Animator`	`getColorAnimator()` Returns the color animator which animates background and foreground colors of all widgets in the scene.
`Animator`	`getPreferredBoundsAnimator()` Returns the preferred bounds animator which animates preferred bounds of all widgets in the scene.
`Animator`	`getPreferredLocationAnimator()` Returns the preferred location animator which animates preferred location of all widgets in the scene.
`Scene`	`getScene()` Returns an assigned scene.
`double`	`getTargetZoomFactor()` Returns a target zoom factor.
`Animator`	`getZoomAnimator()` Returns the zoom animator.
`boolean`	`isAnimatingBackgroundColor(Widget widget)` Returns whether a backgroundColor animator for a specified widget is running.
`boolean`	`isAnimatingForegroundColor(Widget widget)` Returns whether a foregroundColor animator for a specified widget is running.
`boolean`	`isAnimatingPreferredBounds(Widget widget)` Returns whether a preferredBounds animator for a specified widget is running.
`boolean`	`isAnimatingPreferredLocation(Widget widget)` Returns whether a preferredLocation animator for a specified widget is running.
`boolean`	`isAnimatingZoomFactor()` Returns whether a zoomFactor animator is running.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SceneAnimator

public SceneAnimator(Scene scene)

Creates a scene animator.

Parameters:: scene -

Method Detail

getScene

public Scene getScene()

Returns an assigned scene.

Returns:: the scene

isAnimatingPreferredLocation

public boolean isAnimatingPreferredLocation(Widget widget)

Returns whether a preferredLocation animator for a specified widget is running.

Parameters:: widget - the widget
Returns:: true if running

animatePreferredLocation

public void animatePreferredLocation(Widget widget,
                                     Point targetPreferredLocation)

Starts preferredLocation animation for a specified widget.

Parameters:: widget - the widget; targetPreferredLocation - the target preferred location

isAnimatingPreferredBounds

public boolean isAnimatingPreferredBounds(Widget widget)

Returns whether a preferredBounds animator for a specified widget is running.

Parameters:: widget - the widget
Returns:: true if running

animatePreferredBounds

public void animatePreferredBounds(Widget widget,
                                   Rectangle targetPreferredBounds)

Starts preferredBounds animation for a specified widget.

Parameters:: widget - the widget; targetPreferredBounds - the target preferred bounds

isAnimatingZoomFactor

public boolean isAnimatingZoomFactor()

Returns whether a zoomFactor animator is running.

Returns:: true if running

getTargetZoomFactor

public double getTargetZoomFactor()

Returns a target zoom factor.

Returns:: the target zoom factor

animateZoomFactor

public void animateZoomFactor(double targetZoomFactor)

Starts zoomFactor animation.

Parameters:: targetZoomFactor - the target zoom factor

isAnimatingBackgroundColor

public boolean isAnimatingBackgroundColor(Widget widget)

Returns whether a backgroundColor animator for a specified widget is running.

Parameters:: widget - the widget
Returns:: true if running

animateBackgroundColor

public void animateBackgroundColor(Widget widget,
                                   Color targetBackgroundColor)

Starts backgroundColor animation for a specified widget.

Parameters:: widget - the widget; targetBackgroundColor - the target background color

isAnimatingForegroundColor

public boolean isAnimatingForegroundColor(Widget widget)

Returns whether a foregroundColor animator for a specified widget is running.

Parameters:: widget - the widget
Returns:: true if running

animateForegroundColor

public void animateForegroundColor(Widget widget,
                                   Color targetForegroundColor)

Starts foregroundColor animation for a specified widget.

Parameters:: widget - the widget; targetForegroundColor - the target foreground color

getPreferredLocationAnimator

public Animator getPreferredLocationAnimator()

Returns the preferred location animator which animates preferred location of all widgets in the scene.

Returns:: the preferred location animator
Since:: 2.2

getPreferredBoundsAnimator

public Animator getPreferredBoundsAnimator()

Returns the preferred bounds animator which animates preferred bounds of all widgets in the scene.

Returns:: the preferred bounds animator
Since:: 2.2

getZoomAnimator

public Animator getZoomAnimator()

Returns the zoom animator.

Returns:: the zoom animator
Since:: 2.2

getColorAnimator

public Animator getColorAnimator()

Returns the color animator which animates background and foreground colors of all widgets in the scene.

Returns:: the preferred location animator
Since:: 2.2