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 44‑1.
Figure 44‑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 44‑52 lists actuate.viewer.ScrollPanel functions.
Table 44‑52 actuate.viewer.ScrollPanel functions
Function | Description |
| Returns whether mouse scrolling is enabled |
| Returns whether mouse panning is enabled |
| Enables mouse scrolling |
| Enables panning |
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( ));
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( ));
setMouseScrollingEnabled
Syntax
void ScrollPanel.setMouseScrollingEnabled(boolean enabled)
Enables mouse scrolling for this scroll panel.
Parameter
enabled
Boolean.
Example
To disable mouse scrolling for sPanel, use code similar to the following:
sPanel.setMouseScrollingEnabled(false);
setPanInOutEnabled
Syntax
void ScrollPanel.setPanInOutEnabled(boolean enabled)
Enables panning in and out for this scroll panel.
Parameter
enabled
Boolean.
Example
To disable panning for the sPanel object, use code similar to the following:
sPanel.setPanInOutEnabled(false);
