org.netbeans.api.visual.widget

Class BirdViewController

java.lang.Object

org.netbeans.api.visual.widget.BirdViewController

public final class BirdViewController
extends Object

This class controls a bird view created for a specific scene. The bird is tracking mouse-cursor over the main scene view. You can specify a separate zoom-factor and you can enable and disable it by calling show and hide methods.

When a bird view is enabled then it consumes all events of a main scene view therefore you cannot do anything except watch the scene with bird view.

Since:

2.7

Method Summary

Modifier and Type	Method and Description
void	hide() Disables the bird view.
void	setWindowSize(Dimension size) Sets a size of the bird view window.
void	setZoomFactor(double zoomFactor) Sets a zoom factor of the bird view.
void	show() Enables the bird view.

Methods inherited from class java.lang.Object

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

Method Detail

setZoomFactor

public void setZoomFactor(double zoomFactor)

Sets a zoom factor of the bird view.

Parameters:

zoomFactor - the zoom factor

Since:

2.7

setWindowSize

public void setWindowSize(Dimension size)

Sets a size of the bird view window.

Parameters:

size - the window size

Since:

2.7

show

public void show()

Enables the bird view. It means that the bird view window will be visible while a mouse cursor is over the visible area of the main scene view.

Note: Has to be invoked after Scene.createView method.

Note: An user has to initially move cursor over the visible area of the main scene view to show the window up for the first time after the method call.

Since:

2.7

hide

public void hide()

Disables the bird view. It means the bird view window is hidden and the main scene view is not blocked for events.

Since:

2.7