WebSquare.uiplugin.multiselect

MultiSelect. Allows the end user to make multiple selections. Provides a UI similar to the SelectBox which supports single selection, but supports multiple selection.

Type

uiplugin

Property Summary

appearance: Selection item display method
class: Same as the class property in HTML. The class defined in the CSS file or style block can be applied. Multiple classes can be defined with being divided by blank space.
dataListAutoRefresh: Automatically updates the DataList bound with the SelectBox upon execution of addItem or deleteItem.
defaultClass: Default class to apply.
disabled: Opening direction.
displaymessage: Displays the result message upon a validation failure by validate(); API. [default: false, true]
escape: Converts <>&" characters into HTML Escape characters.
id: Component ID
invalidMessage: Message to display upon a failure by the validate API. Valid only in case of displaymessage="true".
invalidMessageFunc: Name of the user-defined function that will generate a message upon a validation failure by the validation API.
mandatory: Allows reading only. [default:false, true]
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
ref: Model instance binding information
separator: Separator to divide multiple selections
tabIndex: The focusing order by the Tab key.
tooltip: Text to be displayed upon the end user’s hovering the mouse over the component.
tooltipLocaleRef: Text key of the tooltip in case the tooltip text is provided in multiple languages.
useItemLocale: Supports multi-language in the selection item list.
useLocale: Multilanguage support
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property
validator: Name of the validation function

Event Summary

onblur: Triggered when the focus is lost.
onchange: Triggered upon a change in an inputted or selected value.
onclick: Triggered upon clicking the component.
ondblclick: Triggered upon double-clicking the component.
onfocus: Triggered upon the component being focused.
onviewchange: Triggered when the value on the list is changed through keyboard input or mouse clicking.

Method Summary

addClass( className ): Adds a CSS class to the component.
addItem( value , label , index , refresh ): Adds the first item.
bind( eventType , function ): Dynamically allocate an event and the handler function to the component.
changeClass( oldClassName , newClassName ): Changes the class currently applied to the corresponding WebSquare component. (Supported in all WebSquare components.)
deleteItem( index ): Deletes the item of the corresponding index.
deleteSelectedItems( ): Deletes the selected item.
focus( ): Focuses the WebSquare component.
getAllValue( ): Returns the value of al item values.
getDisabled( ): Returns the current value of the disabled property.
getGenerator( ): In case generated by the Generator component, returns the parent Generator object that created the component itself.
getID( ): Returns the ID of the WebSquare component.
getIdxValue( index ): Returns the value of the corresponding index.
getInitStyle( CSS ): Returns the initial style of the WebSquare component.
getItemCount( ): Returns the number of the items on the list.
getOpacity( ): Returns the opacity of the WebSquare component. (Supported in all WebSquare components.)
getOriginalID( ): Returns the originalID of the WebSquare component. (Supported in all WebSquare components.)
getPluginName( ): Returns the name of the WebSquare component.
getPosition( positionName ): Returns the position (left and top) of the WebSquare component. (Supported in all WebSquare components.)
getReadOnly( ): Returns the current value of the readOnly property.
getScope( ): For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
getScopeWindow( ): For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
getSelectedIndex( separator ): Returns the index of the selected item. Multiple items are separated by the specified separator when being returned.
getSize( sizeName ): Sets the size (width and height) of the WebSquare component. (Supported in all WebSquare components.)
getStyle( propertyName ): Returns the CSS setting of the WebSquare component.
getStyleValue( style ): [deprecated]
getText( separator ): Returns the label of the currently selected item.
getTitle( ): Returns the title of the WebSquare component.
getUdcHome( ): Returns the path of the UDC file including the file name in which the UDC object is defined. (Supported in all WebSquare components.)
getUdcRoot( ): Returns the path of the UDC file in which the UDC object is defined. (Supported in all WebSquare components.)
getUserData( key ): Returns the value set by setUserData or directly defined by the user in the XML file.
getValue( separator ): Returns the value of the selected item.
hasClass( className ): Checks whether the WebSquare component has a certain class.
hide( ): Hides the WebSquare component. (Supported in all WebSquare components.)
removeClass( className ): Removes a class from the WebSquare component. (Supported in all WebSquare components.)
setDisabled( disabled ): Sets the disabled property of the WebSquare component.
setEventPause( evList , flag ): Pauses the event.
setInitStyle( property ): Restores the initial style of the WebSquare component.
setOpacity( value ): Sets the opacity in the WebSquare component. (Supported in all WebSquare components.)
setPosition( left , top , mode ): Sets the position (left, top) of the WebSquare component.
setReadOnly( readOnly ): Sets the readOnly proprety of the WebSquare component.
setRef( path ): Sets the ref property.
setSelectedIndex( idx ): Selects/Unselects (or toggles) the item of the given index.
setSize( width , height ): Sets the size (width, height) of the WebSquare component.
setStyle( propertyName , value ): Sets the style of the specified property.
setText( label ): Selects the item matching with the received label.
setUserData( key , value ): Sets random data in the WebSquare component. (Supported in all WebSquare components.)
setValue( value ): Select an item that contains the same value as the received value, and applies the selected item to the model.
show( displayType ): Shows the WebSquare component on the page. (Supported in all WebSquare components.)
toggleClass( className ): Adds or removes a CSS class to or from a WebSquare component. (Supported in all WebSquare components.)
trigger( type , array ): Triggers the specified event in the WebSquare component.
unbind( type , function ): Removes the specified event from the WebSquare component.
unbindRef( ): Releases the ref binding.
validate( ): Validates the component according to the specified properties.
validateObject( ): Validates the component according to the specified properties.
visible( flag ): [deprecated]

Property Detail

appearance: Selection item display method
class: Same as the class property in HTML. The class defined in the CSS file or style block can be applied. Multiple classes can be defined with being divided by blank space.
WebSquare5 Engine applies different classes to different components. By defining a common class, the common class can be applied to multiple components.
dataListAutoRefresh: Automatically updates the DataList bound with the SelectBox upon execution of addItem or deleteItem. [default: false, true]
defaultClass: Default class to apply.
disabled: Disable the component. [default:false, true]
displaymessage: Displays the result message upon a validation failure by validate(); API. [default: false, true]
Default message provided by the Engine is displayed. However, using the invalidMessageFunc property, a separate message can be defined.
escape: Decodes HTML escape characters as tags.
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
invalidMessage: Message to display upon a failure by the validate API. Valid only in case of displaymessage="true".
Cannot be used with the invalidMessageFunc property at the same time.
invalidMessageFunc: Name of the user-defined function that will generate a message upon a validation failure by the validation API.
The displaymessage property must be true. Cannot be used with invalidMessage at the same time.
mandatory: Allows reading only. [default:false, true]
The validation function checks the mandatory fields.
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
ref: Model instance binding information
separator: Separator to divide multiple selections The default is blank (space). [default: " "(space)]
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
tooltip: Text to be displayed upon the end user’s hovering the mouse over the component. Provided by WebSquare, and specifies additional information of the component.
tooltipLocaleRef: Text key of the tooltip in case the tooltip text is provided in multiple languages.
When there is no text for the key, "global_undefined" will be displayed on the screen.
useItemLocale: Supports multi-language in the selection item list.
useLocale: Multilanguage support
(For more information, see the user guide.)
userData1: User-defined property. Use getUserData("userData3") to get the data.
userData2: User-defined property. Use getUserData("userData2") to get the data.
userData3: User-defined property. Use getUserData("userData3") to get the data.
validator: Name of the validation function
Runs the specified function upon blurring of the component.
The specified function is executed before the onblur event, and validates upon occurrence of blurring. The developer can change the value through the return.

Event Detail

onblur

Triggered when the focus is lost.

Parameter
name	type	description
e	Object	Event object

onchange

Triggered upon a change in an inputted or selected value.

onclick

Triggered upon clicking the component.

Parameter
name	type	description
e	Object	Event object

ondblclick

Triggered upon double-clicking the component.

Parameter
name	type	description
e	Object	Event object

onfocus

Triggered upon the component being focused.

Parameter
name	type	description
e	Object	Event object

onviewchange

Triggered when the value on the list is changed through keyboard input or mouse clicking.
In case the change was made by a script, the event will not be triggered. (Similar to the native onchange event.)

Parameter
name	type	description
info	Object	Returns an object containing oldValue, newValue, oldSelectedIndex, and newSelectedIndex.

Sample

Method Detail

addClass( className )

Adds a CSS class to the component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
className	String	Y	Name of the class to add

Sample

// (Example) // Add oddClass to input1 component. input1.addClass("oddClass");

addItem( value , label , index , refresh )

Adds an item. If the index is not specified, the item will be added as a sub-item.

Parameter
name	type	required	description
value	String	Y	Value of the item
label	String	Y	Label of the item
index	Number	N	Index of the item
refresh	Boolean	N	Automatically updates the bound DataList (instance). If undefined, the value of the dataListAutoRefresh property will be used.

Return
type	description
Number	Index of the added item

Sample

// The MultiSelect has one item only in the following example. <xf:select id="multiselect1" style="position: relative;width: 148px;height: 21px;" appearance="minimal"> <xf:choices> <xf:item> <xf:label><![CDATA[S]]></xf:label> <xf:value><![CDATA[서울]]></xf:value> </xf:item> </xf:choices> </xf:select> // Add an item without specifying an index. multiselect1.addItem( 'N', 'New York' ); // Added under "Seoul" (as the last item.) The sequence will be "Seoul", "New York" 가 된다. // (Return) 1 // Add an item with specifying the index as "0". multiselect1.addItem( 'R', 'London', 0 ); // Added to index="0" position above "Seoul". The sequence will be "London", "Seoul", "New York". // (Return) 0

bind( eventType , function )

Dynamically allocate an event and the handler function to the component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
eventType	String	Y	Event to allocate
function	Function	Y	Handler function of the event

Sample

// (Example 1) // Define a function for the onclick event of input1. input1.bind("onclick", function(e){ alert(input1.getValue();})); // (Example 2) // Define commObj.ev_click function in advance. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; // Dynamically allocate onclick event and the handler function to input1 component. input1.bind("onclick", commObj.ev_click );

changeClass( oldClassName , newClassName )

Changes the class currently applied to the corresponding WebSquare component. (Supported in all WebSquare components.)
Only the classes added by addClass can be changed.
In order to remove classes directly defined in the class propert of the WebSquare component, add the following in config.xml. // Add the following in config.xml.

Parameter
name	type	required	description
oldClassName	String	Y	Class to change
newClassName	String	Y	Class to newly use

Sample

// The class is directly defined in the inputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following in config.xml. <style> <removeDefaultClass value="true" /> </style> // Change the class. // Change tmpInputClass class to tmpInputWarninClass. input1.changeClass("tmpInputClass","tmpInputWarninClass");

deleteItem( index )

Deletes the item of the corresponding index.

Parameter
name	type	required	description
index	String	Y	Index of the item to delete

Return
type	description
Object	Deleted item info as an object

Sample

var returnValue = multiselect1.deleteItem(0); // returnValue.label is 'red'. // returnValue.value is '#ff0000'. // returnValue.xml is [XML Object]. // Check the XML string with WebSquare.xml.serialize( returnVal.xml ).

deleteSelectedItems( )

Deletes the selected item.

Sample

(Example) The first and the fourth items are selected. var returnValue1 = multiselect1.deleteSelectedItems(); The first and the fourth items will be deleted.

focus( )

Focuses the WebSquare component. (Supported in all WebSquare components.)

getAllValue( )

Returns the value of al item values. All selected items will be returned being separated by blank space.

Return
type	description
String	All item values

Sample

// (Example) // The first and the fourth items are selected. // (The item name (label) is Color, and the item value is '#000000 ~ #ffffff'.) var returnValue = multiselect1.getAllValue(); // (Return) '#ff0000 #000000 #00ff00 #0000ff ...'

getDisabled( )

Returns the current value of the disabled property. (Supported in all WebSquare components.)

Return
type	description
Boolean	Value of the disabled property

Sample

// (Example) Check the current value of the disabled property. var returnValue = componentId.getDisabled(); // (Return Example) false

getGenerator( )

In case generated by the Generator component, returns the parent Generator object that created the component itself. (Supported in all WebSquare components.)

Return
type	description
Object	Parent Generator object

Sample

// (Example) The Generator (parent) create a Trigger (child). <w2:generator id="generator1"> <w2:trigger id="trigger1" ev:onclick="scwin.trigger1_onclick"></w2:trigger></w2:generator> // In the example below, upon the end user’s clicking the Trigger 1, the generator1 object will be displayed on the console. scwin.trigger1.onclick = function(){ console.log(this.getGenerator());}

getID( )

Returns the ID of the WebSquare component. (Supported in all WebSquare components.)

Return
type	description
String	WebSquare component ID

Sample

// Upon dynamically receiving a WebSquare component, the ID can be checked as shown below. function fn_validCheck(tmpObj){ var compID = tmpObj.getID(); } // If the tmpObj in the above example has "input1" ID. // (Return) "input1"

getIdxValue( index )

Returns the value of the corresponding index.

Parameter
name	type	required	description
index	Number	Y	Index of the corresponding item

Return
type	description
String	Value of the corresponding item of the specified index

Sample

// (Example) // The first and the fourth items are selected. // The item name (label) is Color, and the item value is '#000000 ~ #ffffff'. var returnValue = multiselect1.getIdxValue(0); // (Return) '#ff0000'

getInitStyle( CSS )

Returns the initial style of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
CSS	String	N	Property (If not specified, all properties will be displayed.)

getItemCount( )

Returns the number of the items on the list.

Return
type	description
Number	Number of the selection items.

Sample

var returnValue = multiselect1.getItemCount();

getOpacity( )

Returns the opacity of the WebSquare component. (Supported in all WebSquare components.)
The Engine returns the opacity value of the CSS.

Return
type	description
Integer	Opacity

Sample

// Apply the opacity CSS to the InputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> // Return the opacity of the InputBox. var returnValue = input1.getOpacity(); // A real number between 0 and 1 will be returned. // (Return) "0.2"

getOriginalID( )

Returns the originalID of the WebSquare component. (Supported in all WebSquare components.)
The originalID is valid when the scope function is in use.
For scope="true" WFrame, component IDs inside the WFrame is changed with the prefix(wframeID + "_") being added before the ID given by the user (originalID).
The originalID means the ID before the prefix being added.

Return
type	description
String	originalID of the component

Sample

// An example of multi-WFrame page // Main page with a WFrame (main.xml) <w2:wframe id="wframe1" src="text.xml" scope="true"/> // Source page to be contained in the WFrame (text.xml) <w2:textbox id="textbox1"/> // (Example) Check the Id and the original ID in the script of text.xml // Run getID. textbox1.getID(); // "wframe1_textbox1" is returned. // Run getOriginalID. textbox1.getOriginalID(); // "textbox1" is returned.

getPluginName( )

Returns the name of the WebSquare component. (Supported in all WebSquare components.)

Return
type	description
String	Name of the WebSquare component (pluginName)

Sample

// When a common function dynamically receives a WebSQuare object as shown below, different actions can be made for each component type. var commObj = {}; commObj.fn_makeReqData = function(tmpObj){ var tmpID = tmpObj.getID(); // Component ID var tmpCompType = tmpObj.getPluginName(); // Component name if(tmpCompType == "input"){ //..Logic.. }else if(tmpCompType == "gridView"){ //..Logic .. }else{ //..Logic.. } };

getPosition( positionName )

Returns the position (left and top) of the WebSquare component. (Supported in all WebSquare components.)
When the position is set in 0%, the value will be converted into %.

Parameter
name	type	required	description
positionName	String	Y	[left, top] Position type

Return
type	description
Number	Position of the component

Sample

// CSS margin is applied to the Input component as shown below. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> // (Example) Check the top value of the InputBox. var returnValue = input1.getPosition("top"); // Position value in pixels will be returned. // (Return) 10

getReadOnly( )

Returns the current value of the readOnly property. (Supported in all WebSquare components.)

Return
type	description
Boolean	The current setting of the readOnly property

Sample

// Example to check the readOnly setting of the component. var returnValue = componentId.getReadOnly(); // (Return Example) false

getScope( )

For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
For scope="true" WFrame, null will be returned.

Return
type	description
Object	WFrame object or null

Sample

// (Example) // The main page has wframe1 which contains wframe1 which also contains wframe11. // The source page of wframe11 has textbox1. textbox1.getScope(); // (Return Example) wframe11 object

getScopeWindow( )

For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
If not a child of a scope="true" WFrame, a global window object will be returned.

Return
type	description
Object	Scope object of the WFrame or a global window object

Sample

// (Example) // The main page has wframe1 which contains wframe1 which also contains wframe11. // The source page of wframe11 has textbox1. var scope = textbox1.getScopeWindow(); scope.wframe11 === textbox1.getScope(); // true

getSelectedIndex( separator )

Returns the index of the selected item. Multiple items are separated by the specified separator when being returned.
If not specified, space will be used as the delimiter.

Parameter
name	type	required	description
separator	String	N	Separator

Return
type	description
String	String containing the index of the selected item.

Sample

// The first and the fourth items are selected. var returnValue1 = multiselect1.getSelectedIndex(","); // returnValue1 is '0,3'. var returnValue2 = multiselect1.getSelectedIndex(); // The returnValue2 is '0 3'.

getSize( sizeName )

Sets the size (width and height) of the WebSquare component. (Supported in all WebSquare components.)
If set in %, values will be converted into pixels.

Parameter
name	type	required	description
sizeName	String	Y	Size types. For calculation of each size type, see the below:

Return
type	description
Number	Size of the component

Sample

var returnValue = componentId.getSize("width"); // (Return Example) 100 // Values are in pixels. // If set in %, values will be converted into pixels.

getStyle( propertyName )

Returns the CSS setting of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
propertyName	String	Y	CSS property to return

Return
type	description
String	CSS value

Sample

// Define an Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;"></xf:input> // (Example) Check the width of the InputBox above. var returnValue = input1.getStyle("width"); // (Return) "144px"

getStyleValue( style )

[deprecated]
Use getStyle instead.
Returns the current CSS applied to the WebSquare component.

Parameter
name	type	required	description
style	String	Y	CSS property to return

Return
type	description
String	CSS value (Colors are returned in HexCode.)

getText( separator )

Returns the label of the currently selected item.
Multiple items are separated by the specified separator when being returned.
If the separator is not specified, space will be used as the separator.

Parameter
name	type	required	description
separator	String	N	Separator

Return
type	description
String	Label of the selected item

Sample

// The first and the fourth items are selected. // The item name (label) is Color, and the item value is '#000000 ~ #ffffff'. var returnValue = multiselect1.getText(','); // (Return) 'Red,Blue'

getTitle( )

Returns the title of the WebSquare component. (Supported in all WebSquare components.)

Return
type	description
String	Title

Sample

// In the following example, the Title is “Input Name”. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); // (Return Example) “Enter your name.”

getUdcHome( )

Returns the path of the UDC file including the file name in which the UDC object is defined. (Supported in all WebSquare components.)
The file name includes .xml. In order to get the file path without .xml, use getUdcRoot.
When called by a WebSquare component, not a UDC object, “undefined” will be returned.

Return
type	description
String	UDC file path (For others than the UDC, undefined will be returned.)

Sample

// Example // UDC file path is /a/b/udc.xml. // Page XML is /a/c/main.xml. // UDC ID is udc1. udc1.getUdcHome(); // (Result) /a/b/udc.xml

getUdcRoot( )

Returns the path of the UDC file in which the UDC object is defined. (Supported in all WebSquare components.)
Not contains the file name. In order to get a path including the file name, use getUdcHome.
When called by a WebSquare component, not a UDC object, “undefined” will be returned.

Return
type	description
String	UDC file path (For others than the UDC, undefined will be returned.)

Sample

// Example // UDC file path is /a/b/udc.xml. // Page XML is /a/c/main.xml. // UDC ID is udc1. udc1.getUdcHome(); // (Execution Result) /a/b/

getUserData( key )

Returns the value set by setUserData or directly defined by the user in the XML file. (Supported in all WebSquare components.)

Parameter
name	type	required	description
key	String	Y	Data key

Return
type	description
String	Value for the given key

Sample

// (Example) Setting the user property (setTest) in the InputBox <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" setTest="Hello"></xf:input> // Returns the value of the setTest property. input1.getUserData("setTest"); // (Return) "Hello" // Set 'valueTest' (key) and 'WebSquare' (data) through setUserData. input1.setUserData("valueTest","WebSquare"); // Returns the value of the setTest property. input1.getUserData("WebSquare"); // (Return) "WebSquare"

getValue( separator )

Returns the value of the selected item.
Multiple items are separated by the specified separator when being returned.
If the separator is not specified, space will be used as the separator.

Parameter
name	type	required	description
separator	String	N	Separator

Return
type	description
String	Values of the selected items

Sample

// The first and the fourth items are selected. // The item name (label) is Color, and the item value is '#000000 ~ #ffffff'. var returnValue = multiselect1.getValue(','); // (Return) '#ff0000,#0000ff'

hasClass( className )

Checks whether the WebSquare component has a certain class. (Supported in all WebSQuare components.)

Parameter
name	type	required	description
className	String	Y	Name of the class to check

Return
type	description
Boolean	Whether the class exists or not

Sample

hide( )

Hides the WebSquare component. (Supported in all WebSquare components.)
display:none; or visibility:hidden; CSS is applied.

Sample

// (Example) Hide the component. componentId.hide();

removeClass( className )

Removes a class from the WebSquare component. (Supported in all WebSquare components.)
Only the classes added by addClass can be removed.
In order to remove classes directly defined as a property of the component, add the following in config.xml. // Add the following in config.xml. <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	Name of the class to remove

Sample

// If the class is directly defined as an InputBox property. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // In the config.xml file, add the following. <style> <removeDefaultClass value="true" /> </style> // Classes can be removed by removeClass. input1.removeClass("tmpInputClass");

setDisabled( disabled )

Sets the disabled property of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
disabled	Boolean	Y	Disabled status

Sample

// Sets the disabled property in the component. componentId.setDisabled(true);

setEventPause( evList , flag )

Pauses the event. (Supported in all WebSquare components.)

Parameter
name	type	required	description
evList	String	N	List of the events to pause. (in case of null, all events of the corresponding WebSquare component is paused or restarted.)
flag	Boolean	Y	Whether to pause the event or not.

Sample

// (Example 1) // Pause the onclick event. input1.setEventPause("onclick", true); // (Example 2) // Restart the onfocus and the onblur events. input1.setEventPause("onfocus,onblur", false); // (Example 3) // Pause all events registered in input1. input1.setEventPause(null, true);

setInitStyle( property )

Restores the initial style of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
property	String	N	CSS property (If not spcified, all properties will be restored.)

Sample

// (Example) group1.setInitStyle();

setOpacity( value )

Sets the opacity in the WebSquare component. (Supported in all WebSquare components.)
The engine sets the opacity property (of CSS).

Parameter
name	type	required	description
value	Number	Y	Opacity (Real number between 0 and 1)

Sample

// (Example) Set the opacity as 0.45. componentId.setOpacity(0.45);

setPosition( left , top , mode )

Sets the position (left, top) of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
left	Number	Y	Left position value or null
top	Number	Y	Top position value or null
mode	String	N	Position setting method. [default: absolute, delta]

Sample

// (Example) Set the top position as 100px. componentId.setPosition(null, 100);

setReadOnly( readOnly )

Sets the readOnly proprety of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
readOnly	Boolean	Y	Setting of the readOnly property. (“true”: Used. “false”: Not used.)

Sample

// Set the readOnly property as true. componentId.setReadOnly(true);

setRef( path )

Sets the ref property.
Add “data:” prefix to bind with a DataCollection. If not specified, XPath of the InstanceData will be used.

Parameter
name	type	required	description
path	String	Y	Path of ref

setSelectedIndex( idx )

Selects/Unselects (or toggles) the item of the given index.

Parameter
name	type	required	description
idx	Number	Y	Index of the item to select

Sample

// The first and the fourth items are selected. Execute the below. Then, the second item will be additionally selected. multiselect1.setSelectedIndex(1);

setSize( width , height )

Sets the size (width, height) of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
width	Number	Y	Width of the component or null.
height	Number	Y	Height of the component or null.

Sample

// (Example) Set the height of the component as 100px. componentId.setSize(null,100);

setStyle( propertyName , value )

Sets the style of the specified property.

Parameter
name	type	required	description
propertyName	String	Y	Name of the style property to set
value	String	Y	Value of the style to set

Sample

// Change the width. componentId.setStyle("width", 100); // The width is in pixels, and the result will be same with that of componentId.setStyle("width", "100px");. // The width is in %, and the result will be same with that of componentId.setStyle("width", "100%");.</div> </dd> <a class="anchor" id="setText"></a> <dt class="apiname">setText( label ) </dt> <dd> <div class="pdesc">Selects the item matching with the received label. <br />Select multiple items using blank space as the separator between the labels. </div>  <table id="ptable"> <caption>Parameter</caption> <tr> <td class="header1">name</td><td class="header2">type</td><td class="header2">required</td><td class="header3">description</td> </tr> <tr> <td class="necessary">label</td><td class="row">String</td><td class="row">Y</td><td class="row">Label of the item</td> </tr> </table>  <div class="caption_sample">Sample</div> <div class="pdesc"><xmp class='js sample'> // The first and the fourth items are selected. // The item name (label) is Color, and the item value is '#000000 ~ #ffffff'. multiselect1.setText("Black"); // The first, the second, and the fourth items are selected. // When selecting multiple items, use space as the separator. var colorArr = []; colorArr[0] = "Red" ; colorArr[1] = "Blue" ; colorArr[2] = "Green" ; multiselect1.setValue(colorArr.join(" ")); // (Result) Red, Blue, and Green will be selected.

setUserData( key , value )

Sets random data in the WebSquare component. (Supported in all WebSquare components.)
Enter key values supported by the component. In case a key value not supported by the component is entered, corresponding logs will be displayed.

Parameter
name	type	required	description
key	String	Y	Data key to set
value	String	Y	Defined data value

Sample

// Set 'data' key and 'WebSquare' value in the component. componentId.setUserData("data", "WebSquare"); // The key must be supported in the component. componentId.setUserData("title", "WebSquare"); // Following logs will be displayed. // !!!WARNING - [title] can't be defined as UserData.

setValue( value )

Select an item that contains the same value as the received value, and applies the selected item to the model.

Parameter
name	type	required	description
value	String	Y	Value of the item to select

Sample

// The first and the fourth items are selected. // The item name (label) is Color, and the item value is '#000000 ~ #ffffff'. multiselect1.setValue("#000000"); // The first, the second, and the fourth items are selected. // When selecting multiple items, use space as the separator. var colorArr = []; colorArr[0] = "#ff0000" ; // Red colorArr[1] = "#0000ff" ; // Blue colorArr[2] = "#00ff00" ; // Green multiselect1.setValue(colorArr.join(" ")); // (Result) Red, Blue, and Green will be selected.

show( displayType )

Shows the WebSquare component on the page. (Supported in all WebSquare components.)
Sets the display property as specified and applies "visibility: show;" CSS.

Parameter
name	type	required	description
displayType	String	N	CSS display setting to apply.

Sample

// (Example) display: block; componentId.show(); // (Example) Restore the previous display setting. componentId.show("");

toggleClass( className )

Adds or removes a CSS class to or from a WebSquare component. (Supported in all WebSquare components.)
Removes the class from the WebSquare component.
If the WebSquare component does not have the specified class, adds the class.
Only the classes added by addClass can be removed.
In order to remove classes directly defined as a property of the component, add the following in config.xml. // Add the following in config.xml. <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	Class to add or remove

Sample

// The class is directly defined in the inputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following in config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.toggleClass("tmpInputClass"); // Add the (previously removed) tmpInputClass. input1.toggleClass("tmpInputClass");

trigger( type , array )

Triggers a certain event in the component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
type	String	Y	Event to trigger
array	Array	N	Array of parameters to send to the event handler

Sample

// (Example 1) // Trigger the onclick event in input1 component. input1.trigger("onclick"); // (Example 2) // Trigger the onviewchange event in input1, and send (1, 2) parameter to the handler function. input1.trigger("onviewchange", [1,2]);

unbind( type , function )

Removes the event from the component. (Supported in all WebSquare component.)

Parameter
name	type	required	description
type	String	N	Event to remove. (If not specified, all events of the component will be removed.)
function	Function	N	Handler function of the event to remove. (If not specified, all handler functions of the event will be removed.)

Sample

// (Example 1) // Remove all events registered in the input1 component. input1.unbind(); // (Example 2) // Remove all handler functions for the onviewchange event of the input1 component. input1.unbind("onviewchange"); // (Example 3) // Remove func1 for the onviewchange event of the input1 component. input1.unbind("onviewchange", func1);

unbindRef( )

Releases the ref binding.

validate( )

Validates the component according to the specified properties. MultiSelect checks only the mandatory input. (Related Property) mandatory="true"

Sample

// When all items are unselected, var returnValue = multiselect1.validate(); // (Return) false // In case even a single item is selected, "true" will be returned.

validateObject( )

Validates the component according to the specified properties. (Related Property) displaymessage="true" (Validation-related Properties) mandatory minlength maxLength minByteLength maxByteLength

Return
type	description
Object	object validation result object

Sample

// Set the mandatory property as shown below. <xf:select appearance="minimal" id="multiselect1" style="position: absolute;width:272px;height:64px;left:889px;top:659px;" mandatory="true"> <xf:choices> <xf:itemset nodeset="data:dataList3"> <xf:label ref="label"></xf:label> <xf:value ref="value"></xf:value> </xf:itemset> </xf:choices> </xf:select> var returnObj = multiselect.validateObject(); // (Return - When there is no value) returnObj will be returned. returnObj.callerId = "multiselect" returnObj.type = "mandatory" returnObj.value = "" // (Return - When there is a value) An empty object will be returned. // In case of displaymessage="true", a default message will be alerted. // (Alert Example) This field is mandatory.

visible( flag )

[deprecated]
Use show/hide or setStyle instead.
The Engine sets the CSS visibility property.

Parameter
name	type	required	description
flag	Boolean	Y	CSS visibility setting