Class actuate.viewer.ScrollPanel

Description

A container for a scrolling content panel in a viewer, which includes the scroll panel control, as shown in Figure 4-1.

Figure 4-1

Scroll panel control

A ScrollPanel object enhances the viewer with scroll controls, such as mouse wheel scrolling.

Constructor

Syntax

actuate.Viewer.ScrollPanel( )

Constructs a new ScrollPanel object for the parent viewer enabled scroll controls.

Function summary

Table 4-52 lists actuate.viewer.ScrollPanel functions.

Table 4-52

actuate.viewer.ScrollPanel functions

Function	Description
getMouseScrollingEnabled( )	Returns whether mouse scrolling is enabled
getPanInOutEnabled( )	Returns whether mouse panning is enabled
getScrollControlEnabled( )	Returns whether scrolling is enabled
setMouseScrollingEnabled( )	Enables mouse scrolling
setPanInOutEnabled( )	Enables panning
setScrollControlEnabled( )	Enables scrolling

actuate.viewer.ScrollPanel.getMouseScrollingEnabled

Syntax

boolean ScrollPanel.getMouseScrollingEnabled( )

Returns true when mouse scrolling is enabled.

Returns

Boolean.

Example

This example displays an alert with the mouse scrolling status of a scroll panel:

alert("Mouse scrolling enabled: " + sPanel.getMouseScrollingEnabled( ));

actuate.viewer.ScrollPanel.getPanInOutEnabled

Syntax

boolean ScrollPanel.getPanInOutEnabled( )

Returns true when panning in and out is enabled.

Returns

Boolean.

Example

This example displays an alert with the panning in and out status of a scroll panel:

alert("Panning enabled: " + scrollPanel.getPanInOutEnabled( ));

actuate.viewer.ScrollPanel.getScrollControlEnabled

Syntax

boolean ScrollPanel.getScrollControlEnabled( )

Returns true when scrolling is enabled.

Returns

Boolean.

Example

This example displays an alert box with the scrolling status of a scroll panel:

alert("Scrolling enabled: " + sPanel.getScrollControlEnabled( ));

actuate.viewer.ScrollPanel.setMouseScrollingEnabled

Syntax

void ScrollPanel.setMouseScrollingEnabled(boolean enabled)

Enables mouse scrolling for this scroll panel.

Parameters

enabled

Boolean.

Example

To disable mouse scrolling for sPanel, use code similar to the following:

sPanel.setMouseScrollingEnabled(false);

actuate.viewer.ScrollPanel.setPanInOutEnabled

Syntax

void ScrollPanel.setPanInOutEnabled(boolean enabled)

Enables panning in and out for this scroll panel.

Parameters

enabled

Boolean.

Example

To disable panning for the sPanel object, use code similar to the following:

sPanel.setPanInOutEnabled(false);

actuate.viewer.ScrollPanel.setScrollControlEnabled

Syntax

void ScrollPanel.setScrollControlEnabled(boolean enabled)

Enables scrolling for this scroll panel.

Parameters

enabled

Boolean.

Example

To disable scrolling for sPanel, use code similar to the following:

sPanel.setScrollControlEnabled(false);

Copyright Actuate Corporation 2012