Class Index | Minimal

Classes


Class jabberwerx.ui.MUCSearchView


Extends jabberwerx.ui.JWView.

View for displaying MUC search.

This view displays the XDataForm received from the server, both the search criteria and the results.

Class Summary
Constructor Attributes Constructor Name and Description
 
jabberwerx.ui.MUCSearchView(controller, muc)

Creates a MUCSearchView object.

Field Summary
Field Attributes Field Name and Description
<static>  
jabberwerx.ui.MUCSearchView.ACTION_SUBMITTED

Returned as part of the event object in the actionComplete event

 

The MUCController passed in to the constructor.

 
muc

The muc component passed in the constructor.

Fields borrowed from class jabberwerx.ui.JWView:
jq
Method Summary
Method Attributes Method Name and Description
 
createDOM(doc)

Creates the DOM for MUCSearchView.

 

Destroys this view.

 

Returns the size of the criteria view (usually this is the height).

 
hide()

Hides the form in the document.

 

Sets the size of the criteria view (usually this is the height).

 
show()

Shows the form if hidden in the document.

 

Updates view based on server response.

Methods borrowed from class jabberwerx.ui.JWView:
destroyDOM, dimensions, height, parent, persistOptions, remove, render, restoreDOM, restoreRender, restoreUpdate, shouldBeSavedWithGraph, wasUnserialized, width, 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.MUCSearchView(controller, muc)

Creates a MUCSearchView object.

Parameters:
{jabberwerx.MUCController} controller
The MUC controller used to search.
{jabberwerx.JID|String} muc
The MUC server to search against.
Throws:
{TypeError}
if {controller} isn't a MUCController
{jabberwerx.JID.InvalidJIDError}
if {muc} is not an instance of jabberwerx.JID and cannot be converted to one.
Field Detail
<static> {String} jabberwerx.ui.MUCSearchView.ACTION_SUBMITTED

Returned as part of the event object in the actionComplete event


{jabberwerx.MUCController} controller

The MUCController passed in to the constructor.


muc

The muc component passed in the constructor.

Method Detail
{Element} createDOM(doc)

Creates the DOM for MUCSearchView.

Parameters:
{Element} doc
Element for embedding the view
Returns:
{Element} The generated element to display

destroy()

Destroys this view.


{Number} getCriteriaViewSize()

Returns the size of the criteria view (usually this is the height).

Returns:
{Number} Size of the criteria view.

hide()

Hides the form in the document.


setCriteriaViewSize(size)

Sets the size of the criteria view (usually this is the height).

Parameters:
{Number} size
The new size of the criteria view.

show()

Shows the form if hidden in the document.


{Boolean} update()

Updates view based on server response. Adjusts heights for the view elements based on server response. If error is received, the height for the XDataForm element is reduced to accomodate error element. Also sets the dimensions for XDataFormView .

Returns:
{Boolean} true if the view is updatable

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Apr 02 2014 13:23:43 GMT-0600 (MDT)