Show/hide the frame list.
This module is part of the Sozi player embedded in each presentation.
- Source:
Members
(inner) animator :module:player/Animator.Animator
An animator to open/close the frame list.
Type:
- Source:
(inner) currentOffset :number
The current location of the frame list with respect to the left border of the viewport.
1 represents the width of the frame list.
Type:
- number
- Source:
(inner, constant) DURATION_MS :number
The duration of the open/close animation of the frame list.
Type:
- number
- Source:
(inner) endOffset :number
The start location of the frame list with respect to the left border of the viewport.
1 represents the width of the frame list.
Type:
- number
- Source:
(inner) frameList :HTMLElement
The HTML element that contains the frame list.
Type:
- HTMLElement
- Source:
(inner) isOpen :boolean
The current open status of the frame list.
Type:
- boolean
- Source:
(inner) links :Array.<HTMLAnchorElement>
The HTML links to each frame in the frame list.
Type:
- Array.<HTMLAnchorElement>
- Source:
(inner) player :module:player/Player.Player
The current Sozi player.
Type:
- Source:
(inner) startOffset :number
The start location of the frame list with respect to the left border of the viewport.
1 represents the width of the frame list.
Type:
- number
- Source:
Methods
(static) close()
Close the frame list.
- Source:
(static) init(p)
Initialize the frame list management.
This function creates an animator
to manage the open/close animations and registers its step
even handler.
It registers a frameChange event handler
to highlight the current frame title in the frame list.
It also registers mouse and keyboard events related to the frame list.
Parameters:
| Name | Type | Description |
|---|---|---|
p |
module:player/Player.Player | The current Sozi player. |
- Source:
(static) open()
Open the frame list.
- Source:
(static) toggle()
Toggle the open/closed status of the frame list.
- Source:
(inner) moveTo(offset)
Move the frame list to the given location, with an animation.
1 represents the width of the frame list.
Parameters:
| Name | Type | Description |
|---|---|---|
offset |
number | The target location. |
- Source:
(inner) onAnimatorStep(progress)
Perform an animation step while moving the frame list.
This function is called by the current animator.
Parameters:
| Name | Type | Description |
|---|---|---|
progress |
number | The current progress indicator, between 0 and 1. |
- Source:
Listens to Events:
(inner) onFrameChange()
Highlight the current frame in the frame list.
- Source:
Listens to Events:
(inner) onKeyPress(evt)
Process a keypress event related to the frame list.
If enabled by the presentation, pressing the key T will toggle the open/close status of the frame list.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
KeyboardEvent | The DOM event representing the keypress. |
- Source:
Listens to Events:
- event:keypress
(inner) onMouseDown(button)
Process a mouse-down event.
If enabled by the presentation, pressing the middle mouse button will toggle the open/close status of the frame list.
Parameters:
| Name | Type | Description |
|---|---|---|
button |
number | The index of the button that was pressed. |
- Source:
Listens to Events:
(inner) onMouseOut(evt)
Process a mouse-out event.
When the mouse cursor moves out of the frame list area, this function closes it.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
MouseEvent | The DOM event representing the mouse gesture. |
- Source:
Listens to Events:
- event:mouseout
(inner) onTouchStart(evt)
Process a touch event on touch devices.
Closes the Frame List on any touch outside of the list itself.
Parameters:
| Name | Type | Description |
|---|---|---|
evt |
TouchEvent | the touch event. |
- Source:
Listens to Events:
- event:touchstart
(inner) setCurrentOffset(offset)
Set the location of the frame list with respect to the left border of the viewport.
1 represents the width of the frame list.
Parameters:
| Name | Type | Description |
|---|---|---|
offset |
number | The new location. |
- Source: