Expand all

ve.ui.AuthorListPopupTool

Extends

Constructor

new ve.ui.AuthorListPopupTool(toolGroup, [config]) #

UserInterface AuthorListPopupTool

Parameters:

Name Type Attributes Description
toolGroup OO.ui.ToolGroup
config Object optional
Source:
UserInterface AuthorListPopupTool

Methods

changeName() #

Notify the server of a name change

Source:
Notify the server of a name change

onPopupToggle() #

Source:

onSelfItemChange(value) #

Handle change events from the user's authorItem

Parameters:

Name Type Description
value string
Source:
Handle change events from the user's authorItem

onSelfItemChangeColor(color) #

Handle change color events from the user's authorItem

Parameters:

Name Type Description
color string
Source:
Handle change color events from the user's authorItem

onSurfaceChange(oldSurface, newSurface) #

Handle surfaceChange event fromt the toolbar

Parameters:

Name Type Description
oldSurface ve.dm.Surface | null

Old surface
newSurface ve.dm.Surface | null

New surface
Source:
Handle surfaceChange event fromt the toolbar

onSynchronizerAuthorDisconnect(authorId) #

Called when the synchronizer receives a remote author disconnect

Parameters:

Name Type Description
authorId number

The author ID
Source:
Called when the synchronizer receives a remote author disconnect

onSynchronizerAuthorUpdate(authorId) #

Called when the synchronizer receives a remote author selection or name change

Parameters:

Name Type Description
authorId number

The author ID
Source:
Called when the synchronizer receives a remote author selection or name change

setup(surface) #

Setup the popup which a specific surface

Parameters:

Name Type Description
surface ve.ui.Surface
Source:
Setup the popup which a specific surface

updateAuthorCount() #

Update the user count

Source:
Update the user count