fr.inria.zvtm.engine

Class ScrollLayer

java.lang.Object

fr.inria.zvtm.engine.ScrollLayer

All Implemented Interfaces:

ComponentListener, EventListener

public class ScrollLayer
extends Object
implements ComponentListener

Add VirtualSpace content- and scale-aware scroll bars to a View.

Constructor Summary

Constructors

Constructor and Description
ScrollLayer(Camera cc) Create all elements that compose the scroll bars to control a camera.
ScrollLayer(Camera cc, Glyph[] widgets) Create all elements that compose the scroll bars to control a camera.

Method Summary

Modifier and Type	Method and Description
void	cameraUpdated() Call this method whener the controlled camera's position / altitude changes.
void	componentHidden(ComponentEvent e) For internal use.
void	componentMoved(ComponentEvent e) For internal use.
void	componentResized(ComponentEvent e) For internal use.
void	componentShown(ComponentEvent e) For internal use.
boolean	cursorInside(int cx, int cy) Tells whether the given point is inside the area containing the scroll bars or not.
void	draggingHorizontalSlider(int dx) Call this method when the horizontal slider is manipulated (e.g., dragged) through the user interface.
void	draggingVerticalSlider(int dy) Call this method when the vertical slider is manipulated (e.g., dragged) through the user interface.
void	fade(AnimationManager am, int duration, float alphaOffset) Make scroll bars fade in/out (gradually appear/disappear).
Camera	getControlledCamera() Get the camera controlled by the scroll bars.
Glyph	getDownButton() Get the glyph that represents the DOWN button.
Glyph	getHorizontalSlider() Get the glyph that represents the horizontal slider.
Glyph	getLeftButton() Get the glyph that represents the LEFT button.
Glyph	getRightButton() Get the glyph that represents the RIGHT button.
Glyph	getUpButton() Get the glyph that represents the UP button.
Glyph	getVerticalSlider() Get the glyph that represents the vertical slider.
Camera	getWidgetCamera() Get the internal camera managed by this ScrollLayer to display the scroll bar glyphs.
void	moveDown() Call this method when the DOWN button of the vertical scrollbar is actuated.
void	moveLeft() Call this method when the LEFT button of the horizontal scrollbar is actuated.
void	moveRight() Call this method when the RIGHT button of the horizontal scrollbar is actuated.
void	moveUp() Call this method when the UP button of the vertical scrollbar is actuated.
void	setMinimumSliderSize(int s) Set the minimum size of the sliders.
void	setView(View v) Set the view the controlled camera belongs to.
void	updateHorizontalScrollBar() Call this method directly if scroll bars should be updated for reasons other than changes to glyphs in the controlled camera's virtual space or changes to that camera itself.
void	updateScrollBars() Call this method directly if scroll bars should be updated for reasons other than changes to glyphs in the controlled camera's virtual space or changes to that camera itself.
void	updateVerticalScrollBar() Call this method directly if scroll bars should be updated for reasons other than changes to glyphs in the controlled camera's virtual space or changes to that camera itself.
void	virtualSpaceUpdated() Call this method whenever you add or remove objects from the virtual space containing the controlled camera.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScrollLayer

public ScrollLayer(Camera cc)

Create all elements that compose the scroll bars to control a camera.

Parameters:

cc - camera that will be controlled by these scroll bars

ScrollLayer

public ScrollLayer(Camera cc,
                   Glyph[] widgets)

Create all elements that compose the scroll bars to control a camera.

Parameters:

cc - camera that will be controlled by these scroll bars

widgets - list of widgets that should be used to represent the scrollbar components (if you want to customize their look and feel). The glyphs should not be added to any virtual space (this is taken care of internally). All glyphs should implement interface RectangularShape. Provide the glyphs in the following order: vertical scroll bar gutter, slider, up button, down button, horizontal scroll bar gutter, slider, left button, right button.

Method Detail

setView

public void setView(View v)

Set the view the controlled camera belongs to.

setMinimumSliderSize

public void setMinimumSliderSize(int s)

Set the minimum size of the sliders.

Parameters:

s - size in pixels

virtualSpaceUpdated

public void virtualSpaceUpdated()

Call this method whenever you add or remove objects from the virtual space containing the controlled camera. It should also be called when the position or size of glyphs in that virtual space change (in case these modifications change the bounds of the smallest region of the virtual space containing all glyphs).

cameraUpdated

public void cameraUpdated()

Call this method whener the controlled camera's position / altitude changes. (as a result of actions others than scroll bar manipulations).

updateScrollBars

public void updateScrollBars()

Call this method directly if scroll bars should be updated for reasons other than changes to glyphs in the controlled camera's virtual space or changes to that camera itself.

See Also:

cameraUpdated(), virtualSpaceUpdated(), updateVerticalScrollBar(), updateHorizontalScrollBar()

updateVerticalScrollBar

public void updateVerticalScrollBar()

Call this method directly if scroll bars should be updated for reasons other than changes to glyphs in the controlled camera's virtual space or changes to that camera itself.

See Also:

cameraUpdated(), virtualSpaceUpdated(), updateScrollBars(), updateHorizontalScrollBar()

updateHorizontalScrollBar

public void updateHorizontalScrollBar()

Call this method directly if scroll bars should be updated for reasons other than changes to glyphs in the controlled camera's virtual space or changes to that camera itself.

See Also:

cameraUpdated(), virtualSpaceUpdated(), updateScrollBars(), updateVerticalScrollBar()

cursorInside

public boolean cursorInside(int cx,
                            int cy)

Tells whether the given point is inside the area containing the scroll bars or not.

Parameters:

cx - provide projected JPanel coordinates of the associated view, not virtual space coordinates

cy - provide projected JPanel coordinates of the associated view, not virtual space coordinates

getWidgetCamera

public Camera getWidgetCamera()

Get the internal camera managed by this ScrollLayer to display the scroll bar glyphs.

Returns:

the camera that should be added in the view in to create the scroll bar layer.

getControlledCamera

public Camera getControlledCamera()

Get the camera controlled by the scroll bars.

draggingHorizontalSlider

public void draggingHorizontalSlider(int dx)

Call this method when the horizontal slider is manipulated (e.g., dragged) through the user interface.

Parameters:

dx - the horizontal translation that will be applied to the slider (negative values translate it left, positive values right)

draggingVerticalSlider

public void draggingVerticalSlider(int dy)

Call this method when the vertical slider is manipulated (e.g., dragged) through the user interface.

Parameters:

dy - the vertical translation that will be applied to the slider (negative values translate it down, positive values up)

moveUp

public void moveUp()

Call this method when the UP button of the vertical scrollbar is actuated.

moveDown

public void moveDown()

Call this method when the DOWN button of the vertical scrollbar is actuated.

moveLeft

public void moveLeft()

Call this method when the LEFT button of the horizontal scrollbar is actuated.

moveRight

public void moveRight()

Call this method when the RIGHT button of the horizontal scrollbar is actuated.

getVerticalSlider

public Glyph getVerticalSlider()

Get the glyph that represents the vertical slider.

getHorizontalSlider

public Glyph getHorizontalSlider()

Get the glyph that represents the horizontal slider.

getUpButton

public Glyph getUpButton()

Get the glyph that represents the UP button.

getDownButton

public Glyph getDownButton()

Get the glyph that represents the DOWN button.

getLeftButton

public Glyph getLeftButton()

Get the glyph that represents the LEFT button.

getRightButton

public Glyph getRightButton()

Get the glyph that represents the RIGHT button.

fade

public void fade(AnimationManager am,
                 int duration,
                 float alphaOffset)
          throws ClassCastException

Make scroll bars fade in/out (gradually appear/disappear). Make sure glyphs used to represent scrollbar widgets implement the Translucent interface.

Throws:

ClassCastException

componentHidden

public void componentHidden(ComponentEvent e)

For internal use.

Specified by:

componentHidden in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)

For internal use.

Specified by:

componentMoved in interface ComponentListener

componentResized

public void componentResized(ComponentEvent e)

For internal use.

Specified by:

componentResized in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)

For internal use.

Specified by:

componentShown in interface ComponentListener