Canvas Toolkit
← Class index

CScrollArea

Widgets · extends CFrame

Implements the scroll area widget.

import { CScrollArea } from "canvas-toolkit-lib";

Declared members

static readonly ScrollBarExtent = 16;
constructor(parent?: CWidget | null);

Creates a new instance.

viewport(): CWidget;

Provides viewport behavior.

widget(): CWidget | null;

Provides widget behavior.

setWidget(widget: CWidget): CWidget | null;

Sets the widget.

revealTabFocus(widget: CWidget): void;

@internal Reveals a focused control within the scroll content.

touchScrollAreaFor(child: CWidget): CScrollArea | false | null;

@internal Touch panning starts in the viewport, including its content.

canTouchScroll(orientation: COrientation): boolean;

@internal Returns whether the viewport can be panned along this axis.

scrollX(): number;

Provides scroll x behavior.

scrollY(): number;

Provides scroll y behavior.

setScrollX(x: number): void;

Sets the scroll x.

setScrollY(y: number): void;

Sets the scroll y.

scrollTo(x: number, y: number): void;

Provides scroll to behavior.

horizontalScrollBar(): CScrollBar;

Provides horizontal scroll bar behavior.

verticalScrollBar(): CScrollBar;

Provides vertical scroll bar behavior.

setGeometry(x: number, y: number, width: number, height: number): void;

Sets the geometry.

resize(width: number, height: number): void;

Provides resize behavior.

protected frameChanged(): void;

Handles frame changed behavior.

protected wheelEvent(event: CWheelEvent): void;

Handles the wheel event.

protected updateScrollBars(): void;

Handles update scroll bars behavior.