pane.js

hasFocus: function()

Checks if window has focus

Returns

(Boolean)

increaseUnreadMessages: function()

Increases unread message count in window title by one.

reduceUnreadMessages: function( num )

Reduce unread message count in window title by `num`.

Parameters

clearUnreadMessages: function()

Clear unread message count in window title.

renderUnreadMessages: function( count )

Update window title to show message count.

Parameters

onFocus: function()

Window focus event handler.

onBlur: function()

Window blur event handler.

addTab: function( roomJid, roomName, roomType )

Add a tab to the chat pane.

Parameters

getTab: function( roomJid )

Get tab by JID.

Parameters

Returns

removeTab: function( roomJid )

Remove tab element.

Parameters

setActiveTab: function( roomJid )

Set the active tab.

Add CSS classname `active` to the choosen tab and remove `active` from all other.

Parameters

increaseUnreadMessages: function( roomJid )

Increase unread message count in a tab by one.

Parameters

Uses

• Window.increaseUnreadMessages

clearUnreadMessages: function( roomJid )

Clear unread message count in a tab.

Parameters

Uses

• Window.reduceUnreadMessages

tabClick: function( e )

Tab click event: show the room associated with the tab and stops the event from doing the default.

tabClose: function()

Tab close (click) event: Leave the room (groupchat) or simply close the tab (chat).

Parameters

Returns

allTabsClosed: function()

All tabs closed event: Disconnect from service.  Hide sound control.

TODO: Handle window close

Returns

fitTabs: function()

Fit tab size according to window size

adminMessage: function( subject, message )

Display admin message

Parameters

Triggers

candy:view.chat.admin-message using {subject, message}

infoMessage: function( roomJid, subject, message )

Display info message.  This is a wrapper for onInfoMessage to be able to disable certain info messages.

Parameters

onInfoMessage: function( roomJid, subject, message )

Display info message.  Used by infoMessage and several other functions which do not wish that their info message can be disabled (such as kick/ban message or leave/join message in private chats).

Parameters

init: function()

Register handler and enable or disable sound and status messages.

show: function()

Show toolbar.

hide: function()

Hide toolbar.

update: function( roomJid )

Update toolbar for specific room

playSound: function()

Play sound (default method).

onPlaySound: function()

Sound play event handler.  Uses native (HTML5) audio if supported

Don’t call this method directly.  Call `playSound()` instead.  `playSound()` will only call this method if sound is enabled.

onSoundControlClick: function()

Sound control click event handler.

Toggle sound (overwrite `playSound()`) and handle cookies.

onAutoscrollControlClick: function()

Autoscroll control event handler.

Toggle autoscroll

onStatusMessageControlClick: function()

Status message control event handler.

Toggle status message

Update usercount element with count.

Parameters

show: function( html, showCloseControl, showSpinner )

Display modal window

Parameters

hide: function( callback )

Hide modal window

Parameters

showSpinner: function()

Show loading spinner

hideSpinner: function()

Hide loading spinner

showCloseControl: function()

Show a close button

hideCloseControl: function()

Hide the close button

showLoginForm: function( message, presetJid )

Show the login form modal

Parameters

showEnterPasswordForm: function( roomJid, roomName, message )

Shows a form for entering room password

Parameters

showNicknameConflictForm: function( roomJid )

Shows a form indicating that the nickname is already taken and for chosing a new nickname

Parameters

showError: function( message, replacements )

Show modal containing error message

Parameters

show: function( event, content )

Show a tooltip on event.currentTarget with content specified or content within the target’s attribute data-tooltip.

On mouseleave on the target, hide the tooltip.

Parameters

init: function()

Initialize context menu and setup mouseleave handler.

show: function( elem, roomJid, user )

Show context menu (positions it according to the window height/width)

Parameters

Uses

getMenuLinks for getting menulinks the user has access to Candy.Util.getPosLeftAccordingToWindowBounds for positioning Candy.Util.getPosTopAccordingToWindowBounds for positioning

Triggers

candy:view.roster.after-context-menu using {roomJid, user, elements}

getMenuLinks: function( roomJid, user, elem )

Extends initialMenuLinks with menu links gathered from candy:view.roster.contextmenu

Parameters

Triggers

candy:view.roster.context-menu using {roomJid, user, elem}

Returns

initialMenuLinks: function()

Returns initial menulinks.  The following are initial

• Private Chat
• Ignore
• Unignore
• Kick
• Ban
• Change Subject

Returns

showEmoticonsMenu: function( elem )

Shows the special emoticons menu

Parameters

Returns

init: function( roomJid, roomName, roomType )

Initialize a new room and inserts the room html into the DOM

Parameters

Uses

• Candy.Util.jidToId
• Candy.View.Pane.Chat.addTab
• getPane

Triggers

candy:view.room.after-add using {roomJid, type, element}

Returns

show: function( roomJid )

Show a specific room and hides the other rooms (if there are any)

Parameters

Triggers

candy:view.room.after-show using {roomJid, element} candy:view.room.after-hide using {roomJid, element}

setSubject: function( roomJid, subject )

Called when someone changes the subject in the channel

Triggers

candy:view.room.after-subject-change using {roomJid, element, subject}

Parameters

close: function( roomJid )

Close a room and remove everything in the DOM belonging to this room.

NOTICE: There’s a rendering bug in Opera when all rooms have been closed.  (Take a look in the source for a more detailed description)

Triggers

candy:view.room.after-close using {roomJid}

Parameters

appendToMessagePane: function( roomJid, html )

Append a new message to the message pane.

Parameters

sliceMessagePane: function( roomJid )

Slices the message pane after the max amount of messages specified in the Candy View options (limit setting).

This is done to hopefully prevent browsers from getting slow after a certain amount of messages in the DOM.

The slice is only done when autoscroll is on, because otherwise someone might lose exactly the message he want to look for.

Parameters

scrollToBottom: function( roomJid )

Scroll to bottom wrapper for onScrollToBottom to be able to disable it by overwriting the function.

Parameters

Uses

• onScrollToBottom

onScrollToBottom: function( roomJid )

Scrolls to the latest message received/sent.

Parameters

onScrollToStoredPosition: function( roomJid )

When autoscroll is off, the position where the scrollbar is has to be stored for each room, because it otherwise goes to the top in the message window.

Parameters

setFocusToForm: function( roomJid )

Set focus to the message input field within the message form.

Parameters

setUser: function( roomJid, user )

Sets or updates the current user in the specified room (called by <Candy.View.Pane.Roster.update>) and set specific informations (roles and affiliations) on the room tab (chat-pane).

Parameters

getUser: function( roomJid )

Get the current user in the room specified with the jid

Parameters

Returns

ignoreUser: function( roomJid, userJid )

Ignore specified user and add the ignore icon to the roster item of the user

Parameters

unignoreUser: function( roomJid, userJid )

Unignore an ignored user and remove the ignore icon of the roster item.

Parameters

addIgnoreIcon: function( roomJid, userJid )

Add the ignore icon to the roster item of the specified user

Parameters

removeIgnoreIcon: function( roomJid, userJid )

Remove the ignore icon to the roster item of the specified user

Parameters

getPane: function( roomJid, subPane )

Get the chat room pane or a subPane of it (if subPane is specified)

Parameters

changeDataUserJidIfUserIsMe: function( roomId, user )

Changes the room’s data-userjid attribute if the specified user is the current user.

Parameters

open: function( roomJid, roomName, switchToRoom, isNoConferenceRoomJid )

Opens a new private room

Parameters

Triggers

candy:view.private-room.after-open using {roomJid, type, element}

setStatus: function( roomJid, status )

Set offline or online status for private rooms (when one of the participants leaves the room)

Parameters

changeNick: function changeNick( roomJid, user )

Changes the nick for every private room opened with this roomJid.

Parameters

update: function( roomJid, user, action, currentUser )

Called by Candy.View.Observer.Presence.update to update the roster if needed.  Adds/removes users from the roster list or updates informations on their items (roles, affiliations etc.)

TODO: Refactoring, this method has too much LOC.

Parameters

Triggers

candy:view.roster.before-update using {roomJid, user, action, element} candy:view.roster.after-update using {roomJid, user, action, element}

userClick: function()

Click handler for opening a private room

showJoinAnimation: function( user, userId, roomId, roomJid, currentUser )

Shows join animation if needed

FIXME: Refactor.  Part of this will be done by the big room improvements

joinAnimation: function( elementId )

Animates specified elementId on join

Parameters

leaveAnimation: function( elementId )

Leave animation for specified element id and removes the DOM element on completion.

Parameters

changeNick: function( roomId, user )

Change nick of an existing user in the roster

UserId has to be recalculated from the user because at the time of this call, the user is already set with the new jid & nick.

Parameters

submit: function( event )

on submit handler for message field sends the message to the server and if it’s a private chat, shows the message immediately because the server doesn’t send back those message.

Parameters

Triggers

candy:view.message.before-send using {message}

FIXME: as everywhere, `roomJid` might be slightly incorrect in this case

• maybe rename this as part of a refactoring.

show: function( roomJid, name, message, xhtmlMessage, timestamp )

Show a message in the message pane

Parameters

Triggers

candy:view.message.before-show using {roomJid, name, message} candy.view.message.before-render using {template, templateData} candy:view.message.after-show using {roomJid, name, message, element}