Class gui.CaretManager
Defined in: CaretManager.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
gui.CaretManager(sessionController, viewport)
The caret manager is responsible for creating a caret as UI representation
of a member's cursor.
|
| Field Attributes | Field Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
|
destroy(callback,)
|
|
| <inner> |
getCaret(memberId)
|
| <inner> | |
| <inner> |
Get the horizontal offset of the local caret from the
left edge of the screen (in pixels).
|
|
registerCursor(cursor, caretAvatarInitiallyVisible, blinkOnRangeSelect)
|
|
| <inner> |
removeCaret(memberId)
|
Class Detail
gui.CaretManager(sessionController, viewport)
The caret manager is responsible for creating a caret as UI representation
of a member's cursor.
If the caret is for the local member, then the manager will control the
caret's current focus, and ensure the caret stays visible after every local
operation.
- Parameters:
- {!gui.SessionController} sessionController
- {!gui.Viewport} viewport
Field Detail
{?gui.Caret}
getCaret
{!Array.}
getCarets
Method Detail
{undefined}
destroy(callback,)
- Parameters:
- {!function(!Error=)} callback,
- passing an error object in case of error
- Returns:
- {undefined}
<inner>
{?gui.Caret}
getCaret(memberId)
- Parameters:
- {!string} memberId
- Returns:
- {?gui.Caret}
<inner>
{!Array.}
getCarets()
- Returns:
- {!Array.}
<inner>
{!number|undefined}
getLocalCaretXOffsetPx()
Get the horizontal offset of the local caret from the
left edge of the screen (in pixels).
- Returns:
- {!number|undefined}
{!gui.Caret}
registerCursor(cursor, caretAvatarInitiallyVisible, blinkOnRangeSelect)
- Parameters:
- {!ops.OdtCursor} cursor
- {!boolean} caretAvatarInitiallyVisible
- Set to false to hide the associated avatar
- {!boolean} blinkOnRangeSelect
- Specify that the caret should blink if a non-collapsed range is selected
- Returns:
- {!gui.Caret}
<inner>
{undefined}
removeCaret(memberId)
- Parameters:
- {!string} memberId
- Returns:
- {undefined}
