Class gui.SessionView
Defined in: SessionView.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
gui.SessionView(viewOptions, localMemberId, session, sessionConstraints, caretManager, selectionViewManager)
TODO: We really don't want to let SessionView be aware of localMemberId,
so eventually we'll need to refactor this.
|
| Method Attributes | Method Name and Description |
|---|---|
| <inner> |
createAvatarInfoNodeMatch(nodeName, memberId, pseudoClass)
|
| <inner> |
destroy(callback)
|
|
destroy(callback,)
|
|
| <inner> |
getAvatarInfoStyle(nodeName, memberId, pseudoClass)
|
|
getCaret(memberid)
|
|
|
Hide member avatars above the cursor
|
|
|
Hide edit information markers displayed near edited paragraphs
|
|
| <inner> |
highlightEdit(element, memberId, timestamp)
|
| <inner> | |
| <inner> |
onAnnotationAdded(info)
|
| <inner> |
onCursorAdded(cursor)
|
| <inner> |
onCursorMoved(cursor)
|
| <inner> |
onCursorRemoved(memberid)
|
| <inner> |
onParagraphChanged(info)
|
| <inner> | |
| <inner> |
renderMemberData(member)
|
| <inner> |
setAvatarInfoStyle(memberId, name, color)
|
| <inner> |
setCaretAvatarVisibility(visible)
Updates the visibility on all existing avatars
|
| <inner> |
setEditInfoMarkerVisibility(visible)
Updates the visibility on all existing editInfo entries
|
|
Show member avatars above the cursor
|
|
|
Show edit information markers displayed near edited paragraphs
|
Class Detail
gui.SessionView(viewOptions, localMemberId, session, sessionConstraints, caretManager, selectionViewManager)
TODO: We really don't want to let SessionView be aware of localMemberId,
so eventually we'll need to refactor this. It is only here so that the id can
be matched with the memberids for which CSS is generated, to generate the same CSS
for shadow cursors.
- Parameters:
- {!gui.SessionViewOptions} viewOptions
- {string} localMemberId
- {!ops.Session} session
- {!gui.SessionConstraints} sessionConstraints
- {!gui.CaretManager} caretManager
- {!gui.SelectionViewManager} selectionViewManager
Method Detail
<inner>
{!string}
createAvatarInfoNodeMatch(nodeName, memberId, pseudoClass)
- Parameters:
- {!string} nodeName
- {!string} memberId
- {!string} pseudoClass
- Returns:
- {!string}
<inner>
{undefined}
destroy(callback)
- Parameters:
- {!function(!Error=)} callback
- Returns:
- {undefined}
{undefined}
destroy(callback,)
- Parameters:
- {!function(!Error=)} callback,
- passing an error object in case of error
- Returns:
- {undefined}
<inner>
{?Node}
getAvatarInfoStyle(nodeName, memberId, pseudoClass)
- Parameters:
- {!string} nodeName
- {!string} memberId
- {string} pseudoClass
- Returns:
- {?Node}
{?gui.Caret}
getCaret(memberid)
- Parameters:
- {!string} memberid
- Returns:
- {?gui.Caret}
{!ops.Session}
getSession()
- Returns:
- {!ops.Session}
{undefined}
hideCaretAvatars()
Hide member avatars above the cursor
- Returns:
- {undefined}
{undefined}
hideEditInfoMarkers()
Hide edit information markers displayed near edited paragraphs
- Returns:
- {undefined}
<inner>
{undefined}
highlightEdit(element, memberId, timestamp)
- Parameters:
- {!Element} element
- {!string} memberId
- {!number} timestamp
- Returns:
- {undefined}
<inner>
{!HTMLStyleElement}
newStyleSheet()
- Returns:
- {!HTMLStyleElement}
<inner>
{undefined}
onAnnotationAdded(info)
- Parameters:
- {!{memberId: !string|annotation: !Element}} info
- Returns:
- {undefined}
<inner>
{undefined}
onCursorAdded(cursor)
- Parameters:
- {!ops.OdtCursor} cursor
- Returns:
- {undefined}
<inner>
{undefined}
onCursorMoved(cursor)
- Parameters:
- {!ops.OdtCursor} cursor
- Returns:
- {undefined}
<inner>
{undefined}
onCursorRemoved(memberid)
- Parameters:
- {!string} memberid
- Returns:
- {undefined}
<inner>
{undefined}
onParagraphChanged(info)
- Parameters:
- {!{paragraphElement:!Element|memberId:string|timeStamp:number}} info
- Returns:
- {undefined}
<inner>
{undefined}
refreshHighlights()
- Returns:
- {undefined}
<inner>
{undefined}
renderMemberData(member)
- Parameters:
- {!ops.Member} member
- Returns:
- {undefined}
<inner>
{undefined}
setAvatarInfoStyle(memberId, name, color)
- Parameters:
- {!string} memberId
- {!string} name
- {!string} color
- Returns:
- {undefined}
<inner>
{undefined}
setCaretAvatarVisibility(visible)
Updates the visibility on all existing avatars
- Parameters:
- {!boolean} visible
- Returns:
- {undefined}
<inner>
{undefined}
setEditInfoMarkerVisibility(visible)
Updates the visibility on all existing editInfo entries
- Parameters:
- {!boolean} visible
- Returns:
- {undefined}
{undefined}
showCaretAvatars()
Show member avatars above the cursor
- Returns:
- {undefined}
{undefined}
showEditInfoMarkers()
Show edit information markers displayed near edited paragraphs
- Returns:
- {undefined}
