Class Index Minimal

Classes


Namespace jabberwerx.ui

Cisco AJAX XMPP Library is an easy to use, AJAX-based XMPP client. This namespace contains UI-oriented views and controls.

To use these features you must have an account on a jabber server.

Configuration

In addition to those options available by jabberwerx, the following configuration options are available:

Name Default Description
themeName "default" The name of the theme to use.

To set any of these options, create an object called jabberwerx_ui_config in the global namespace, like this:

 jabberwerx_ui_config = {
     themeName: "default"
 };

This code must be evaluated before including this file, jabberwerx.ui.js.

Themeing

The images and css used to generate the tabbed chat and group chat UI are found themes/default/images and themes/default/css. You may edit these files directly, or make a copy of the default directory, and make your edits there. To use your theme, set the themeName property of jabberwerx_ui_config to the name of the copied directory.

Namespace Summary
Constructor Attributes Constructor Name and Description
 

Cisco AJAX XMPP Library is an easy to use, AJAX-based XMPP client.

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

Singleton instance of the Emoticons type.

<static>  
jabberwerx.ui.version

JabberWerx.UI Version

Method Summary
Method Attributes Method Name and Description
<static>  
jabberwerx.ui.getDateDisplayString(date)

Generates a quick human-readable form of a Date.

<static>  
jabberwerx.ui.getThemeImageURL(fileName)

Returns the url for a passed image, given the currently configured theme.

<static>  
jabberwerx.ui.getThemeURL()

Returns the url for the currently configured theme folder.

Namespace Detail
jabberwerx.ui

Cisco AJAX XMPP Library is an easy to use, AJAX-based XMPP client. This namespace contains UI-oriented views and controls.

  • Control to view/change your own presence
  • Presence View for a specific Contact
  • Roster View
  • Chat 1:1 View
  • MUC Room View
  • Tabbed View (to contain 1:1 and MUC views)

To use these features you must have an account on a jabber server.

Configuration

In addition to those options available by jabberwerx, the following configuration options are available:

Name Default Description
themeName "default" The name of the theme to use.

To set any of these options, create an object called jabberwerx_ui_config in the global namespace, like this:

 jabberwerx_ui_config = {
     themeName: "default"
 };

This code must be evaluated before including this file, jabberwerx.ui.js.

Themeing

The images and css used to generate the tabbed chat and group chat UI are found themes/default/images and themes/default/css. You may edit these files directly, or make a copy of the default directory, and make your edits there. To use your theme, set the themeName property of jabberwerx_ui_config to the name of the copied directory.

Field Detail
<static> {jabberwerx.ui.Emoticons} jabberwerx.ui.emoticons

Singleton instance of the Emoticons type.


Defined in: </clearcase/jetty-7.0.1/jobs/VTG_CAXL_8.6 Build/workspace/vtg_caxl_8.6/build/dist/VTG-CAXL-debug-8.6.1.28927/src/model/Emoticons.js>.

<static> jabberwerx.ui.version

JabberWerx.UI Version

Method Detail
<static> {String} jabberwerx.ui.getDateDisplayString(date)

Generates a quick human-readable form of a Date. The generated string does not include the date unless {date}'s year/month/day are different from the current date's year/month/day.

Parameters:
{Date} date
The date to display
Returns:
{String} The displayable string for {date}

<static> {String} jabberwerx.ui.getThemeImageURL(fileName)

Returns the url for a passed image, given the currently configured theme.

Parameters:
{String} fileName
The name of an image file living inside the current theme's images folder.
Returns:
The url for a passed image, given the currently configured theme.

<static> {String} jabberwerx.ui.getThemeURL()

Returns the url for the currently configured theme folder.

Returns:
The url for the currently configured theme folder.

Documentation generated by JsDoc Toolkit 2.0.1 on Thu Aug 18 2011 10:58:50 GMT+0100 (IST)