Class Index | File Index

Classes


Class gui.CaretManager


Defined in: CaretManager.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
gui.CaretManager(sessionController)
The caret manager is responsible for creating a caret as UI representation of a member's cursor.
Field Summary
Field Attributes Field Name and Description
 
 
Method Summary
Method Attributes Method Name and Description
<inner>  
 
destroy(callback,)
<inner>  
<inner>  
<inner>  
getCaret(memberId)
<inner>  
<inner>  
<inner>  
 
registerCursor(cursor, caretAvatarInitiallyVisible, blinkOnRangeSelect)
<inner>  
removeCaret(memberId)
<inner>  
Class Detail
gui.CaretManager(sessionController)
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
Field Detail
{?gui.Caret} getCaret

{!Array.} getCarets
Method Detail
<inner> {undefined} blurLocalCaret()
Returns:
{undefined}

{undefined} destroy(callback,)
Parameters:
{!function(!Error=)} callback,
passing an error object in case of error
Returns:
{undefined}

<inner> {undefined} ensureLocalCaretVisible(info)
Parameters:
{!{memberId:string}} info
Returns:
{undefined}

<inner> {undefined} focusLocalCaret()
Returns:
{undefined}

<inner> {?gui.Caret} getCaret(memberId)
Parameters:
{!string} memberId
Returns:
{?gui.Caret}

<inner> {!Array.} getCarets()
Returns:
{!Array.}

<inner> {undefined} hideLocalCaret()
Returns:
{undefined}

<inner> {undefined} refreshLocalCaretBlinking(cursor)
Parameters:
{!ops.OdtCursor} cursor
Returns:
{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}

<inner> {undefined} showLocalCaret()
Returns:
{undefined}

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Jul 17 2014 23:45:40 GMT+0200 (MESZ)