Class jabberwerx.ui.MucView

A view for a MUC room pane.

This class provides the following events:

jabberwerx.ui.JWView

Class Summary
Constructor Attributes	Constructor Name and Description
	jabberwerx.ui.MucView(mucRoom) Creates a new MucView with the given MUCRoom.

Field Summary
Field Attributes	Field Name and Description
<static>	jabberwerx.ui.MucView.defaultOccupantsListSize The default size for the occupants list in the MucView.
<static>	jabberwerx.ui.MucView.occupantsListSizeInvalidError Error thrown when the requested occupants list size is not valid (not a positive integer).

Fields borrowed from class jabberwerx.ui.JWView:: jq

Method Summary
Method Attributes	Method Name and Description
	clearHistory() Clears the MessageHistory pane.
	createDOM(doc) Creates the DOM for MucView consisting of a RosterView, a title area (room name and subject), a MessageHistory and a TextInput widget.
	destroy() Destroys this MucView.
	height(h, noupdate) Overloads jabberwerx.ui.JWView's height.
	occupantsListSize(size) Retrieves or changes the size (width) of the occupants list.
	setTabControl(tab) Sets or clears the tab control.
	update() Triggers an update of this MucView.
	width(w, noupdate) Overloads jabberwerx.ui.JWView's width.

Methods borrowed from class jabberwerx.ui.JWView:: destroyDOM, dimensions, hide, parent, persistOptions, remove, render, restoreDOM, restoreRender, restoreUpdate, shouldBeSavedWithGraph, show, wasUnserialized, willBeSerialized
Methods borrowed from class jabberwerx.JWModel:: applyEvent, event
Methods borrowed from class jabberwerx.JWBase:: getClassName, graphUnserialized, init, invocation, shouldBeSerializedInline, toString

Class Detail

jabberwerx.ui.MucView(mucRoom)

Creates a new MucView with the given MUCRoom.

Parameters:
{jabberwerx.MUCRoom} mucRoom: The MUC room associated with this muc view.

Throws:
{TypeError}: if {mucRoom} is not valid

Field Detail

<static> {Number} jabberwerx.ui.MucView.defaultOccupantsListSize

The default size for the occupants list in the MucView.

<static> jabberwerx.ui.MucView.occupantsListSizeInvalidError

Error thrown when the requested occupants list size is not valid (not a positive integer).

Method Detail

clearHistory()

Clears the MessageHistory pane.

{jQuery} createDOM(doc)

Creates the DOM for MucView consisting of a RosterView, a title area (room name and subject), a MessageHistory and a TextInput widget.

Parameters:
{Document} doc: The document to use for creating content.

Returns:: {jQuery} The element containing the widgets.

destroy()

Destroys this MucView. This unbinds all of the bound events this object has.

{Number|jabberwerx.ui.JWView} height(h, noupdate)

Overloads jabberwerx.ui.JWView's height. If setting the height, this makes sure the MessageHistory pane takes up the remaining space.

Parameters:
{Number|String} h Optional: The new height (or undefined to retrieve the current height)
{Boolean} noupdate Optional: true if the view should NOT be updated

Returns:: {Number|jabberwerx.ui.JWView} The current height (if retrieving); or this jabberwerx.ui.JWView (if changing)

See:: jabberwerx.ui.JWView#dimensions

{Number|jabberwerx.ui.MucView} occupantsListSize(size)

Retrieves or changes the size (width) of the occupants list.

Parameters:
size

Throws:
{jabberwerx.ui.MucView.occupantsListSizeInvalidError}: If {size} is specified but is not a positive number

Returns:: {Number|jabberwerx.ui.MucView} The current tab size (if getting), or this MucView (if setting)

setTabControl(tab)

Sets or clears the tab control. This method overrides the mixin jabberwerx.ui.Tabbable#setTabControl to set the label, and bind events for updating when the MUCRoom receives a broadcast or a a subject changed event.

Parameters:
{jabberwerx.ui.TabbedView.Tab} tab Optional: The new tab, or null if being removed from a tabbed view.

update()

Triggers an update of this MucView. This goes through all of the widgets associated with this view and calls their updates.

{Number|jabberwerx.ui.JWView} width(w, noupdate)

Overloads jabberwerx.ui.JWView's width. If setting the width, this makes sure that new width gets propogated to the underlining widgets.

Parameters:
{Number|String} w Optional: The new width (or undefined to retrieve the current width)
{Boolean} noupdate Optional: true if the view should NOT be updated

Returns:: {Number|jabberwerx.ui.JWView} The current width (if retrieving); or this jabberwerx.ui.JWView (if changing)

See:: jabberwerx.ui.JWView#dimensions

Classes

Class jabberwerx.ui.MucView