Class ScrollBar

A widget which implements a canonical scroll bar.

Hierarchy (view full)

Widget
- ScrollBar

Index

Constructors

constructor

Properties

_maximum _orientation _page _pageRequested _pressData _repeatTimer _stepRequested _thumbMoved _value node

Constructors

constructor

new ScrollBar(options?): ScrollBar
Construct a new scroll bar.
Parameters
- options: ScrollBar.IOptions = {}
  The options for initializing the scroll bar.
Returns ScrollBar
Overrides Widget.constructor
- Defined in widgets/src/scrollbar.ts:31

Properties

`Private` _maximum

_maximum: number = 100

`Private` _orientation

_orientation: ScrollBar.Orientation

`Private` _page

_page: number = 10

`Private` _pageRequested

_pageRequested: Signal<ScrollBar, "decrement" | "increment"> = ...

`Private` _pressData

_pressData: null | IPressData = null

`Private` _repeatTimer

_repeatTimer: number = -1

`Private` _stepRequested

_stepRequested: Signal<ScrollBar, "decrement" | "increment"> = ...

`Private` _thumbMoved

_thumbMoved: Signal<ScrollBar, number> = ...

`Private` _value

_value: number = 0

`Readonly` node

node: HTMLElement

Get the DOM node owned by the widget.

Accessors

dataset

get dataset(): DOMStringMap
The dataset for the widget's DOM node.

Returns DOMStringMap
Inherited from Widget.dataset
- Defined in widgets/src/widget.ts:163

decrementNode

get decrementNode(): HTMLDivElement
The scroll bar decrement button node.

Notes
Modifying this node directly can lead to undefined behavior.

Returns HTMLDivElement
- Defined in widgets/src/scrollbar.ts:210

disposed

get disposed(): ISignal<this, void>
A signal emitted when the widget is disposed.

Returns ISignal<this, void>
Inherited from Widget.disposed
- Defined in widgets/src/widget.ts:90

hiddenMode

get hiddenMode(): HiddenMode
Get the method for hiding the widget.

Returns HiddenMode
Inherited from Widget.hiddenMode
- Defined in widgets/src/widget.ts:170
set hiddenMode(value): void
Set the method for hiding the widget.
Parameters
- value: HiddenMode
Returns void
Inherited from Widget.hiddenMode
- Defined in widgets/src/widget.ts:177

id

get id(): string
Get the id of the widget's DOM node.

Returns string
Inherited from Widget.id
- Defined in widgets/src/widget.ts:149
set id(value): void
Set the id of the widget's DOM node.
Parameters
- value: string
Returns void
Inherited from Widget.id
- Defined in widgets/src/widget.ts:156

incrementNode

get incrementNode(): HTMLDivElement
The scroll bar increment button node.

Notes
Modifying this node directly can lead to undefined behavior.

Returns HTMLDivElement
- Defined in widgets/src/scrollbar.ts:222

isAttached

get isAttached(): boolean
Test whether the widget's node is attached to the DOM.

Returns boolean
Inherited from Widget.isAttached
- Defined in widgets/src/widget.ts:109

isDisposed

get isDisposed(): boolean
Test whether the widget has been disposed.

Returns boolean
Inherited from Widget.isDisposed
- Defined in widgets/src/widget.ts:102

isHidden

get isHidden(): boolean
Test whether the widget is explicitly hidden.

Returns boolean
Inherited from Widget.isHidden
- Defined in widgets/src/widget.ts:116

isVisible

get isVisible(): boolean
Test whether the widget is visible.

Notes
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

Returns boolean
Inherited from Widget.isVisible
- Defined in widgets/src/widget.ts:127

layout

get layout(): null | Layout
Get the layout for the widget.

Returns null | Layout
Inherited from Widget.layout
- Defined in widgets/src/widget.ts:243
set layout(value): void
Set the layout for the widget.

Notes
The layout is single-use only. It cannot be changed after the first assignment.

The layout is disposed automatically when the widget is disposed.
Parameters
- value: null | Layout
Returns void
Inherited from Widget.layout
- Defined in widgets/src/widget.ts:256

maximum

get maximum(): number
Get the maximum value of the scroll bar.

Returns number
- Defined in widgets/src/scrollbar.ts:175
set maximum(value): void
Set the maximum value of the scroll bar.

Notes
The max size will be clamped to the range [0, Infinity].
Parameters
- value: number
Returns void
- Defined in widgets/src/scrollbar.ts:185

orientation

get orientation(): ScrollBar.Orientation
Get the orientation of the scroll bar.

Returns ScrollBar.Orientation
- Defined in widgets/src/scrollbar.ts:85
set orientation(value): void
Set the orientation of the scroll bar.
Parameters
- value: ScrollBar.Orientation
Returns void
- Defined in widgets/src/scrollbar.ts:92

pageRequested

get pageRequested(): ISignal<this, "decrement" | "increment">
A signal emitted when the user clicks the scroll track.

Notes
The payload is whether a decrease or increase is requested.

Returns ISignal<this, "decrement" | "increment">
- Defined in widgets/src/scrollbar.ts:78

parent

get parent(): null | Widget
Get the parent of the widget.

Returns null | Widget
Inherited from Widget.parent
- Defined in widgets/src/widget.ts:204
set parent(value): void
Set the parent of the widget.

Notes
Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

The widget will be automatically removed from its old parent.

This is a no-op if there is no effective parent change.
Parameters
- value: null | Widget
Returns void
Inherited from Widget.parent
- Defined in widgets/src/widget.ts:219

stepRequested

get stepRequested(): ISignal<this, "decrement" | "increment">
A signal emitted when the user clicks a step button.

Notes
The payload is whether a decrease or increase is requested.

Returns ISignal<this, "decrement" | "increment">
- Defined in widgets/src/scrollbar.ts:68

thumbMoved

get thumbMoved(): ISignal<this, number>
A signal emitted when the user moves the scroll thumb.

Notes
The payload is the current value of the scroll bar.

Returns ISignal<this, number>
- Defined in widgets/src/scrollbar.ts:58

thumbNode

get thumbNode(): HTMLDivElement
The scroll bar thumb node.

Notes
Modifying this node directly can lead to undefined behavior.

Returns HTMLDivElement
- Defined in widgets/src/scrollbar.ts:246

title

get title(): Title<Widget>
The title object for the widget.

Notes
The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

Since not all widgets will use the title, it is created on demand.

The owner property of the title is set to this widget.

Returns Title<Widget>
Inherited from Widget.title
- Defined in widgets/src/widget.ts:142

trackNode

get trackNode(): HTMLDivElement
The scroll bar track node.

Notes
Modifying this node directly can lead to undefined behavior.

Returns HTMLDivElement
- Defined in widgets/src/scrollbar.ts:234

value

get value(): number
Get the current value of the scroll bar.

Returns number
- Defined in widgets/src/scrollbar.ts:112
set value(value): void
Set the current value of the scroll bar.

Notes
The value will be clamped to the range [0, maximum].
Parameters
- value: number
Returns void
- Defined in widgets/src/scrollbar.ts:122

Methods

`Private` _evtKeyDown

_evtKeyDown(event): void
Handle the 'keydown' event for the scroll bar.
Parameters
- event: KeyboardEvent
Returns void
- Defined in widgets/src/scrollbar.ts:334

`Private` _evtMouseDown

_evtMouseDown(event): void
Handle the 'mousedown' event for the scroll bar.
Parameters
- event: MouseEvent
Returns void
- Defined in widgets/src/scrollbar.ts:359

`Private` _evtMouseMove

_evtMouseMove(event): void
Handle the 'mousemove' event for the scroll bar.
Parameters
- event: MouseEvent
Returns void
- Defined in widgets/src/scrollbar.ts:487

`Private` _evtMouseUp

_evtMouseUp(event): void
Handle the 'mouseup' event for the scroll bar.
Parameters
- event: MouseEvent
Returns void
- Defined in widgets/src/scrollbar.ts:531

`Private` _moveThumb

_moveThumb(value): void
Move the thumb to the specified position.
Parameters
- value: number
Returns void
- Defined in widgets/src/scrollbar.ts:577

`Private` _onRepeat

_onRepeat(): void
A timeout callback for repeating the mouse press.

Returns void
- Defined in widgets/src/scrollbar.ts:599

`Private` _releaseMouse

_releaseMouse(): void
Release the mouse and restore the node states.

Returns void
- Defined in widgets/src/scrollbar.ts:548

activate

activate(): void
Post an 'activate-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.activate
- Defined in widgets/src/widget.ts:396

addClass

addClass(name): void
Add a class name to the widget's DOM node.
Parameters
- name: string
  The class name to add to the node.
  
  Notes
  If the class name is already added to the node, this is a no-op.
  
  The class name must not contain whitespace.
Returns void
Inherited from Widget.addClass
- Defined in widgets/src/widget.ts:326

children

children(): IterableIterator<Widget>
Create an iterator over the widget's children.

Returns IterableIterator<Widget>
A new iterator over the children of the widget.

Notes
The widget must have a populated layout in order to have children.

If a layout is not installed, the returned iterator will be empty.
Inherited from Widget.children
- Defined in widgets/src/widget.ts:283

clearFlag

clearFlag(flag): void
Clear the given widget flag.

Notes
This will not typically be called directly by user code.
Parameters
- flag: Flag
Returns void
Inherited from Widget.clearFlag
- Defined in widgets/src/widget.ts:506

close

close(): void
Send a 'close-request' message to the widget.

Notes
This is a simple convenience method for sending the message.

Returns void
Inherited from Widget.close
- Defined in widgets/src/widget.ts:406

contains

contains(widget): boolean
Test whether a widget is a descendant of this widget.
Parameters
- widget: Widget
  The descendant widget of interest.
Returns boolean
true if the widget is a descendant, false otherwise.
Inherited from Widget.contains
- Defined in widgets/src/widget.ts:296

dispose

dispose(): void
Dispose of the widget and its descendant widgets.

Notes
It is unsafe to use the widget after it has been disposed.

All calls made to this method after the first are a no-op.

Returns void
Inherited from Widget.dispose
- Defined in widgets/src/widget.ts:55

fit

fit(): void
Post a 'fit-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.fit
- Defined in widgets/src/widget.ts:386

handleEvent

handleEvent(event): void
Handle the DOM events for the scroll bar.
Parameters
- event: Event
  The DOM event sent to the scroll bar.
  
  Notes
  This method implements the DOM EventListener interface and is called in response to events on the scroll bar's DOM node.
  
  This should not be called directly by user code.
Returns void
- Defined in widgets/src/scrollbar.ts:263

hasClass

hasClass(name): boolean
Test whether the widget's DOM node has the given class name.
Parameters
- name: string
  The class name of interest.
Returns boolean
true if the node has the class, false otherwise.
Inherited from Widget.hasClass
- Defined in widgets/src/widget.ts:312

hide

hide(): void
Hide the widget and make it hidden to its parent widget.

Notes
This causes the isHidden property to be true.

If the widget is explicitly hidden, this is a no-op.

Returns void
Inherited from Widget.hide
- Defined in widgets/src/widget.ts:445

`Protected` notifyLayout

notifyLayout(msg): void
Invoke the message processing routine of the widget's layout.
Parameters
- msg: Message
  The message to dispatch to the layout.
  
  Notes
  This is a no-op if the widget does not have a layout.
  
  This will not typically be called directly by user code.
Returns void
Inherited from Widget.notifyLayout
- Defined in widgets/src/widget.ts:604

`Protected` onActivateRequest

onActivateRequest(msg): void
A message handler invoked on an 'activate-request' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onActivateRequest
- Defined in widgets/src/widget.ts:654

`Protected` onAfterAttach

onAfterAttach(msg): void
A message handler invoked on an 'after-attach' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onAfterAttach
- Defined in widgets/src/widget.ts:702

`Protected` onAfterDetach

onAfterDetach(msg): void
A method invoked on an 'after-detach' message.
Parameters
- msg: Message
Returns void
Overrides Widget.onAfterDetach
- Defined in widgets/src/scrollbar.ts:295

`Protected` onAfterHide

onAfterHide(msg): void
A message handler invoked on an 'after-hide' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onAfterHide
- Defined in widgets/src/widget.ts:686

`Protected` onAfterShow

onAfterShow(msg): void
A message handler invoked on an 'after-show' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onAfterShow
- Defined in widgets/src/widget.ts:670

`Protected` onBeforeAttach

onBeforeAttach(msg): void
A method invoked on a 'before-attach' message.
Parameters
- msg: Message
Returns void
Overrides Widget.onBeforeAttach
- Defined in widgets/src/scrollbar.ts:287

`Protected` onBeforeDetach

onBeforeDetach(msg): void
A message handler invoked on a 'before-detach' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onBeforeDetach
- Defined in widgets/src/widget.ts:710

`Protected` onBeforeHide

onBeforeHide(msg): void
A message handler invoked on a 'before-hide' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onBeforeHide
- Defined in widgets/src/widget.ts:678

`Protected` onBeforeShow

onBeforeShow(msg): void
A message handler invoked on a 'before-show' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onBeforeShow
- Defined in widgets/src/widget.ts:662

`Protected` onChildAdded

onChildAdded(msg): void
A message handler invoked on a 'child-added' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ChildMessage
Returns void
Inherited from Widget.onChildAdded
- Defined in widgets/src/widget.ts:726

`Protected` onChildRemoved

onChildRemoved(msg): void
A message handler invoked on a 'child-removed' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ChildMessage
Returns void
Inherited from Widget.onChildRemoved
- Defined in widgets/src/widget.ts:734

`Protected` onCloseRequest

onCloseRequest(msg): void
A message handler invoked on a 'close-request' message.

Notes
The default implementation unparents or detaches the widget.
Parameters
- msg: Message
Returns void
Inherited from Widget.onCloseRequest
- Defined in widgets/src/widget.ts:616

`Protected` onFitRequest

onFitRequest(msg): void
A message handler invoked on a 'fit-request' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from Widget.onFitRequest
- Defined in widgets/src/widget.ts:646

`Protected` onResize

onResize(msg): void
A message handler invoked on a 'resize' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ResizeMessage
Returns void
Inherited from Widget.onResize
- Defined in widgets/src/widget.ts:630

`Protected` onUpdateRequest

onUpdateRequest(msg): void
A method invoked on an 'update-request' message.
Parameters
- msg: Message
Returns void
Overrides Widget.onUpdateRequest
- Defined in widgets/src/scrollbar.ts:303

processMessage

processMessage(msg): void
Process a message sent to the widget.
Parameters
- msg: Message
  The message sent to the widget.
  
  Notes
  Subclasses may reimplement this method as needed.
Returns void
Inherited from Widget.processMessage
- Defined in widgets/src/widget.ts:518

removeClass

removeClass(name): void
Remove a class name from the widget's DOM node.
Parameters
- name: string
  The class name to remove from the node.
  
  Notes
  If the class name is not yet added to the node, this is a no-op.
  
  The class name must not contain whitespace.
Returns void
Inherited from Widget.removeClass
- Defined in widgets/src/widget.ts:340

setFlag

setFlag(flag): void
Set the given widget flag.

Notes
This will not typically be called directly by user code.
Parameters
- flag: Flag
Returns void
Inherited from Widget.setFlag
- Defined in widgets/src/widget.ts:496

setHidden

setHidden(hidden): void
Show or hide the widget according to a boolean value.
Parameters
- hidden: boolean
  true to hide the widget, or false to show it.
  
  Notes
  This is a convenience method for hide() and show().
Returns void
Inherited from Widget.setHidden
- Defined in widgets/src/widget.ts:472

show

show(): void
Show the widget and make it visible to its parent widget.

Notes
This causes the isHidden property to be false.

If the widget is not explicitly hidden, this is a no-op.

Returns void
Inherited from Widget.show
- Defined in widgets/src/widget.ts:418

testFlag

testFlag(flag): boolean
Test whether the given widget flag is set.

Notes
This will not typically be called directly by user code.
Parameters
- flag: Flag
Returns boolean
Inherited from Widget.testFlag
- Defined in widgets/src/widget.ts:486

toggleClass

toggleClass(name, force?): boolean
Toggle a class name on the widget's DOM node.
Parameters
- name: string
  The class name to toggle on the node.
- Optional force: boolean
  Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.
Returns boolean
true if the class is now present, false otherwise.

Notes
The class name must not contain whitespace.
Inherited from Widget.toggleClass
- Defined in widgets/src/widget.ts:358

update

update(): void
Post an 'update-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.update
- Defined in widgets/src/widget.ts:376

Class ScrollBar

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ScrollBar

Properties

Private _maximum

Private _orientation

Private _page

Private _pageRequested

Private _pressData

Private _repeatTimer

Private _stepRequested

Private _thumbMoved

Private _value

Readonly node

Accessors

dataset

Returns DOMStringMap

decrementNode

Returns HTMLDivElement

disposed

Returns ISignal<this, void>

hiddenMode

Returns HiddenMode

Parameters

Returns void

id

Returns string

Parameters

Returns void

incrementNode

Returns HTMLDivElement

isAttached

Returns boolean

isDisposed

Returns boolean

isHidden

Returns boolean

isVisible

Returns boolean

layout

Returns null | Layout

Parameters

Returns void

maximum

Returns number

Parameters

Returns void

orientation

Returns ScrollBar.Orientation

Parameters

Returns void

page

Returns number

Parameters

Returns void

pageRequested

Returns ISignal<this, "decrement" | "increment">

parent

Returns null | Widget

Parameters

Returns void

stepRequested

Returns ISignal<this, "decrement" | "increment">

thumbMoved

Returns ISignal<this, number>

thumbNode

Returns HTMLDivElement

title

Returns Title<Widget>

trackNode

Returns HTMLDivElement

value

`Private` _maximum

`Private` _orientation

`Private` _page

`Private` _pageRequested

`Private` _pressData

`Private` _repeatTimer

`Private` _stepRequested

`Private` _thumbMoved

`Private` _value

`Readonly` node

`Private` _evtKeyDown

`Private` _evtMouseDown

`Private` _evtMouseMove

`Private` _evtMouseUp

`Private` _moveThumb

`Private` _onRepeat

`Private` _releaseMouse