Class jabberwerx.ui.ConsoleView

A debug console view.

NOTE: ConsoleView may cause performance problems when working with many, or large, stanzas. This view should not be used in "production" clients and is provided as a convenient debugging tool.

Class Summary
Constructor Attributes	Constructor Name and Description
	jabberwerx.ui.ConsoleView(client) Creates a new ConsoleView.

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

Method Summary
Method Attributes	Method Name and Description
	clear() Clears the console log pane.
	createDOM(doc) Creates the DOM for ConsoleView consisting of a log area, a widget area and a TextInput widget.
	destroy() Destroys this ConsoleView.
	height(h, noupdate) Overrides jabberwerx.ui.JWView's height.
	text(val) Gets or sets the text in the text xml entry field.
	update() Triggers an update of this ConsoleView.
	width(w, noupdate) Overrides jabberwerx.ui.JWView's width.
	willBeSerialized() Override to persist anything in xml entry.

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

Class Detail

jabberwerx.ui.ConsoleView(client)

Creates a new ConsoleView.

Parameters:
{jabberwerx.Client} client

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

Method Detail

clear()

Clears the console log pane.

{jQuery} createDOM(doc)

Creates the DOM for ConsoleView consisting of a log area, a widget area and a TextInput widget.

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

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

destroy()

Destroys this ConsoleView. This unbinds all of the bound events.

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

Overrides jabberwerx.ui.JWView's height. Fits the console within the given height.

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.ConsoleView (if changing)

{String|jabberwerx.ui.ConsoleView} text(val)

Gets or sets the text in the text xml entry field.

If {val} is not defined, this method returns the current text in the xml entry field. Otherwise the text is changed to the value of {val}.

Parameters:
{String} val Optional: The new text to be put in the text input field.

Returns:: {String|jabberwerx.ui.ConsoleView} The current text in the text input field or this jabberwerx.ui.ConsoleView if the text is being set.

update()

Triggers an update of this ConsoleView. View completely fills its container.

Restores persisted log messages. This method is invoked once the console's DOM has been appended to its parent, ensuring propper css is in place (witdth for example).

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

Overrides jabberwerx.ui.JWView's width. Fits the console within the given width, including border and margins.

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.ConsoleView (if changing)

{Boolean} willBeSerialized()

Override to persist anything in xml entry. Super class will persist the console.

Returns:: {Boolean} Always true

Classes

Class jabberwerx.ui.ConsoleView