You are not logged in. Log in | Register

Edit
page

New
page

Print
page

Page last modified 19:04, 22 Feb 2010 by shirly

Page Notifications Off

Redirect

Gigya's Developer Documentation > Wildfire Sharing Tool > API Reference > Configuration Parameters > UI Parameters

UI Parameters

From $1

1. UIConfig
1. 1.1. mixNetworks
  1. 1.1.1. Setting mixNetworks:
  2. 1.1.2. The outcome:
2. 1.2. enableMyEmailField
  1. 1.2.1. Setting enableMyEmailField:
  2. 1.2.2. The outcome:
2. showPost
3. showBookmark
4. showEmail
5. showDesktop
6. lang
1. 6.1. Currently Supported Languages:
7. localConfig
8. networksToShow, networksToHide
9. bookmarksToShow, bookmarksToHide
10. customNetworks
1. 10.1. Defining Custom Network Button:
11. nowmode
12. outsideColor

1. UIConfig
1. 1.1. mixNetworks
  1. 1.1.1. Setting mixNetworks:
  2. 1.1.2. The outcome:
2. 1.2. enableMyEmailField
  1. 1.2.1. Setting enableMyEmailField:
  2. 1.2.2. The outcome:
2. showPost
3. showBookmark
4. showEmail
5. showDesktop
6. lang
1. 6.1. Currently Supported Languages:
7. localConfig
8. networksToShow, networksToHide
9. bookmarksToShow, bookmarksToHide
10. customNetworks
1. 10.1. Defining Custom Network Button:
11. nowmode
12. outsideColor

UIConfig

An XML string that provide detailed control over the look and feel of Wildfire by overriding the default UI configuration.

Wildfire uses a hierarchical xml to allow a flexible and highly configurable design.
Using this XML you can control fonts, colors, sizes, gradients, frames, roundness of corners for almost any graphic element in Wildfire's UI.

An Example UIConfig:

UIConfig: '<config><display showEmail="true" useTransitions="true" showBookmark="true" codeBoxHeight="auto" 
            showCodeBox="true" showCloseButton="false" networksWithCodeBox=""></display>
            <body><background frame-color="#BFBFBF" background-color="#FFFFFF" gradient-color-begin="#ffffff" 
            gradient-color-end="#F4F4F4" corner-roundness="4;4;4;4"></background><controls color="#202020" 
            corner-roundness="4;4;4;4" gradient-color-begin="#EAEAEA" gradient-color-end="#F4F4F4" bold="false">
            <snbuttons type="textUnder" frame-color="#D5D5D5" over-frame-color="#60BFFF" color="#808080" 
            gradient-color-begin="#FFFFFF" gradient-color-end="d4d6d7" size="10" bold="false" down-frame-color="#60BFFF" 
            down-gradient-color-begin="#6DDADA" over-gradient-color-end="#6DDADA" down-gradient-color-end="#F4F4F4" 
            over-color="#52A4DA" down-color="#52A4DA" over-bold="false">
            <more frame-color="#A4DBFF" over-frame-color="#A4DBFF" 
            gradient-color-begin="#F4F4F4" gradient-color-end="#BBE4FF" over-gradient-color-begin="#A4DBFF" 
            over-gradient-color-end="#F4F4F4"></more><previous frame-color="#BBE4FF" over-frame-color="#A4DBFF" 
            gradient-color-begin="#FFFFFF" gradient-color-end="#A4DBFF" over-gradient-color-begin="#A4DBFF" 
            over-gradient-color-end="#F4F4F4"></previous></snbuttons><textboxes frame-color="#CACACA" color="#757575" 
            gradient-color-begin="#ffffff" bold="false"><codeboxes color="#757575" frame-color="#DFDFDF"
            background-color="#FFFFFF" gradient-color-begin="#ffffff" gradient-color-end="#FFFFFF" size="10"></codeboxes>
            <inputs frame-color="#CACACA" color="#757575" gradient-color-begin="#F4F4F4" gradient-color-end="#ffffff">
            </inputs><dropdowns list-item-over-color="#52A4DA" frame-color="#CACACA"></dropdowns></textboxes>
            <buttons frame-color="#CACACA" gradient-color-begin="#F4F4F4" gradient-color-end="#CACACA" color="#000000" 
            bold="false" over-frame-color="#60BFFF" over-gradient-color-begin="#BBE4FF" down-gradient-color-begin="#BBE4FF" 
            over-gradient-color-end="#FFFFFF" down-gradient-color-end="#ffffff">
            <post-buttons frame-color="#CACACA" gradient-color-end="#CACACA"></post-buttons></buttons>
            <listboxes frame-color="#CACACA" corner-roundness="4;4;4;4" gradient-color-begin="#F4F4F4" 
            gradient-color-end="#FFFFFF"></listboxes>
            <checkboxes checkmark-color="#00B600" frame-color="#D5D5D5" corner-roundness="3;3;3;3" 
            gradient-color-begin="#F4F4F4" gradient-color-end="#FFFFFF"></checkboxes>
            <servicemarker gradient-color-begin="#ffffff" gradient-color-end="#D5D5D5"></servicemarker>
            <tooltips color="#6D5128" gradient-color-begin="#FFFFFF" gradient-color-end="#FFE4BB" size="10" 
            frame-color="#FFDBA4"></tooltips></controls>
            <texts color="#202020"><headers color="#202020"></headers><messages color="#202020"></messages>
            <links color="#52A4DA" underline="false" over-color="#353535" down-color="#353535" down-bold="false"></links>
            </texts></body></config>'

Most UIConfig attributes may be configured using the Advanced Setup Wizards.

You may export and import the UIConfig from and to the Advanced Wizard using the the following buttons (located in the middle of the Wizard):

Import&Export-Themes-buttons.gif

Some of the UIConfig attributes may not be configured using the Wizards:

mixNetworks

Boolean attribute, part of the "display" element of the UIConfig. When mixNetworks is set to "true" Wildfire will display all the icons of "Post", "Bookmark", "email" and "Desktop" networks mixed on a single frame. The single frame would have a "Quick post" title. By default, wildfire presents the network icons in four different tabs: "Post", "Bookmark", "email" and "Desktop".

Setting mixNetworks:

UIConfig: '<config><display mixNetworks="true" ... ></display></config>'

The outcome:

enableMyEmailField

Boolean attribute, part of the "display" element of the UIConfig. When enableMyEmailField is set to "true" Wildfire will display a "My email" field for the user to enter his email address (in the Email tab).

Setting enableMyEmailField:

UIConfig: '<config><display showEmail="true" enableMyEmailField="true" ... ></display></config>'

The outcome:

showPost

A boolean parameter. The value of this parameter determines whether the "Post" tab is available on Wildfire UI. By default, the "Post" tab is available (the default value is "true").

showBookmark

A boolean parameter. The value of this parameter determines whether the "Bookmark" tab is available on Wildfire UI. By default, the "Bookmark" tab is available (the default value is "true").

showEmail

A boolean parameter. The value of this parameter determines whether the "Email " tab is available on Wildfire UI. By default, the "Email" tab is available (the default value is "true").

showDesktop

A boolean parameter. The value of this parameter determines whether the "Desktop" tab is available on Wildfire UI. By default, the "Desktp" tab is not available (the default value is "false"). Assigning "true" to this parameter, results in having the "Desktop" tab available on Wildfire UI, as shown in the screen shot below:

lang

By assigning a two character language code to this parameter Wildfire can render in that language.
English ("en") is the default if no other language is specified or the specified code is not supported.

Currently Supported Languages:

Language	Language Code
English	en
Chinese (Hong Kong)	zh-hk
Chinese (Taiwan)	zh-tw
Czech	cs
Danish	da
Dutch	nl
Finnish	fi
French	fr
German	de
Greek	el
Hungarian	hu
Italian	it
Japanese	ja
Korean	ko
Norwegian	no
Polish	pl
Portuguese	pt
Portuguese (Brazil)	pt-br
Russian	ru
Spanish	es
Spanish (Mexican)	es-mx
Swedish	sv

Note:
If you are using AS2 you have to manually load the language specific version of wildfire.swf file. To do that append _ and the language code to the wildfire swf name.
For example, to load the Mexican Spanish version of wildfire in AS2 change the line:

mcWF.loadMovie('http://cdn.gigya.com/WildFire/swf/wildfire.swf','get');

to:

mcWF.loadMovie('http://cdn.gigya.com/WildFire/swf/wildfire_es-mx.swf','get');

localConfig

An XML string for setting UI configuration, which overrides the configuration set by the UIConfig parameter. This can be helpful when building a complex UI configuration that has to be slightly different in different situations. The localConfig parameter allows setting only the differences while the main configuration remains unchanged.

networksToShow, networksToHide

This pair of parameters allow you to set which social-network buttons are displayed on Wildfire "Post" tab, and also determine the order. Each parameter is set with a comma separated string of network names.
Valid network names include:
myspace, friendster, facebook, orkut, bebo, tagged, wordpress, blogger, hi5, livespaces, piczo, freewebs, livejournal, blackplanet, myyearbook, typepad, xanga, multiply, igoogle, netvibes, pageflakes, migente, vox, yahoo, ameba, livedoor, eons, overblog and myyaru.
In addition networksToShow can include a * to indicate any other network supported by Wildfire.
For example: if you specify "myspace,facebook,*" as the value of networksToShow and "hi5,vox" as the value of networksToHide you will end up with myspace and facebook first, followed by all the other supported networks with the exception of hi5 and vox.

Note - If the current user has already posted to a certain social-network, this social-network will be displayed first (the position of this destination site will precede the list, which is predefined in networksToShow), so as to provide an improved user experience.

bookmarksToShow, bookmarksToHide

This pair of parameters allow you to set which social-bookmarking-sites buttons are displayed on Wildfire "Bookmark" tab, and also determine the order. Each parameter is set with a comma separated string of network names. These pair of parameters have similar logic to the networksToShow and networksToHide pair of parameters.
Valid bookmark networks include:
delicious, digg, twitter, friendfeed, googlebookmarks, myaol, stumbleupon, facebookshare, linkedin, yahoobookmarks, yahoomyweb, ivebookmarks, technorati, plaxo, slashdot, reddit, faves, newsvine, fark, mixx, misterwong, ask, wikio, propeller, currenttv, simpy, yardbarker, blinklist, diigo, sphinn, backflip, dropjack, segnalo, linkagogo, kaboodle, buzzup, rawsugar, magnolia, tailrank, Hyves.

Note - If the current user have already bookmarked using certain social-bookmarking-sites, this social-bookmarking-sites will be shown first (prior to the list defined in bookmarksToShow) for better user experience.

customNetworks

This parameter allows you to add new custom network buttons to Wildfire.

When the user presses your custom button the regular NetworkButtonClicked Event will be fired.

Defining Custom Network Button:

The custom network buttons are defined using an XML string, in the following format:

customNetworks: '<nets><net id="customnet1" name="Network 1 Display Name" iconURL="http://www.quarktet.com/Icon-small.jpg" service="POST" 
/><net id="customnet2" name="Network 2 Display Name" iconURL="http://www.quarktet.com/Icon-small.jpg" service="BOOKMARK" 
/></nets>'

Where:

<net /> defines a single network button.

Each button is defined using the following properties:

ID - Identifies the network button. The new button ID, may be used in: networksToShow, networksToHide, bookmarksToShow, bookmarksToHide parameters.
Name - The caption of the button
Icon URL - URL to the icon to be displayed on the button.
Service - Will determine on which tab to locate the button. Possible values: "POST", "BOOKMARK".
openURL - If this parameter is not empty, Wildfire will open the URL when the user presses the button.

nowmode

A boolean parameter. Assigning "true" to this parameter, forces wildfire not to use the wmode parameter.

A bug in FireFox leads to a situation where when using wmode (which Wildfire uses by default for transparency) input from non English US keyboards is interpreted as if it came from an English US keyboard. This means that for example a German keyboard that has the @ sign on the Alt-Gr+Q key combination will produce the @ sign only when shift+2 is pressed.

The downside of using this setting is that you can not use transparent background. If you don’t need a transparent background you should set nowmode to "true". When setting nowmode to "true" you can and probably should also use the outsideColor described next.

outsideColor

When using rounded corners, you may use this parameter to set the color of the area outside the corneres so that it matches the backrgound of your page. The default is #ffffff (white).

Retrieved from "http://wiki.gigya.com/055_Wildfire_API/055_API_reference/005_Configuration_Parameters/20_UI_Parameters"

Tags:

Edit tags

Files (0)

UI Parameters

From $1

Table of contents

UIConfig

mixNetworks

Setting mixNetworks:

The outcome:

enableMyEmailField

Setting enableMyEmailField:

The outcome:

showPost

showBookmark

showEmail

showDesktop

lang

Currently Supported Languages:

localConfig

networksToShow, networksToHide

bookmarksToShow, bookmarksToHide

customNetworks

Defining Custom Network Button:

nowmode

outsideColor

Table of contents

Recent pages

UI Parameters

From $1

Table of contents

UIConfig

mixNetworks

Setting mixNetworks:

The outcome:

enableMyEmailField

Setting enableMyEmailField:

The outcome:

showPost

showBookmark

showEmail

showDesktop

lang

Currently Supported Languages:

localConfig

networksToShow, networksToHide

bookmarksToShow, bookmarksToHide

customNetworks

Defining Custom Network Button:

nowmode

outsideColor

Table of contents