WebSquare.uiplugin.checkcombobox

Provides extended functions of select tag in HTML. Provides an interface that is like a combination of a select box and a check box in order to allow the end user to make multiple selections.
At the highest-level is the div tag containing sub tags.

Type

uiplugin

Property Summary

allOption: [default:false, true] Whether to allow all options or not. The label is "-All-" and the value is "all".
animation: Sets the animation for the itemtable.
appearance: The appearance property of xforms select1
checkboxClickSync: [default:false, true] Synchronizes the checkbox clicking with the selected itemset.
checkDisabledOnAllCheck: [default:true, false]
chooseOption: [default:false,true] Displays the selection options. In case the chooseOptionLabel is not defined, the label will be "-Choose-" and the value ""(empty string).
chooseOptionLabel: Define the text (label) to guide selection when the chooseOption is true.
class: Provides a similar feature to the class in HTML. One or more classes defined in the CSS file or the style block can be used.
closeonmouseleave: [default:false, true] Closes the sub-layer upon the mouseleave event.
delimiter: Separates the value from the label. Used by the displayMode property.
direction: [defulat:auto, down, up] Opening direction of the items
disabled: [default:false, true] Disables the component.
displayAllOptionLabel: [default:false, true] Displays All instead of the labels of all items.
displaymessage: [default:false, true] Displays the result message upon a validation failure by the validation API.
displayMode: [default:label, value delim label, label delim value] Mode of display. Both the label and the value can be displayed. The separator (delim) is defined in the delimiter property.
escape: Converts <>&" characters into HTML Escape characters.
id: ID of the component. Allocated as a global object. Scripts access the component through the ID.
invalidMessage: A message displayed upon failure of the validation API. The displaymessage property must be true.
invalidMessageFunc: Name of the function that dynamically displays messages upon a validation failure by the validation API.
labelWidthAuto: [default:false, true]
mandatory: [default:false, true] Whether to check the mandatory input or not when calling the validation API.
navBtn: Sets the button for the itemtable.
nextTabID: Component ID to move by tab
ref: The value of the DataCollection. Required to bind the component with a DataCollection. Starts with a prefix of "data:".
separator: [default:" "(space)] Delimiter to list multiple labels of the selected items.
sortMethod: [default:ascending, descending] Referenced by the sortOption property. The method to sort the values defined in the sortOption.
sortOption: [label,value] Used to sort the items by label or value.
submenuSize: [default:auto, fixed] Whether to fit the list size to the label or fix it to the default width. Not valid when the labelWidthAuto property is true.
tabIndex: Same as the tabindex property in HTML standard. Indicates the focusing order of the component by the tab key.
title: Same as the title property of HTML. Displays the Text upon the end user's hovering the mouse over the browser.
useLocale: [default:false, true] True to use the multi-language key to display the labels on the WebSquare5 client.
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property
validator: Name of the validation function
visibleRowNum: Number of the rows to be displayed
wmode: [default:false, true] Use wmode. To be used when the component is hidden by an object (such as activeX or flash).

Event Summary

onblur: Triggered when the focus is lost.
onchange: Triggered upon the end user's selecting/changing an item or setting a value. Use the onviewchange event to control only the end user's selecting an item.
oncheckboxclick: Triggered upon selection (checking/unchcking) of an item on the list.
onclick: Triggered upon the end user's clicking the CheckComboBox component.
onclose: Triggered upon clicking other areas after selection.
ondblclick: Triggered upon the end user's double-clicking the CheckComboBox 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 class to the component.
addItem( value , label , idx ): Adds an item. If no index is specified, the item will be appended to the lower node.
bind( eventType , function ): Dynamically allocates events to the component.
changeClass( oldClassName , newClassName ): Renames the class from oldClassName to newClassName.
checkAll( checked ): Checks or unchecks all items.
deleteItem( idx ): Deletes the item of the corresponding index. When the allOption is true, the index will be numbered from an option that is to select all items.
focus( ): Moves the focus to the component.
getDisabled( ): Gets the current value of the disabled property.
getGenerator( ): Called by a component under the Generator component. When called, gets the parent Generator object.
getID( ): Gets the ID of the component.
getInfo( index ): Returns JSON data containing of all item information as an array.
getInfoArray( ): Returns JSON data containing of all item information as an array.
getInitStyle( property ): Gets the initial style of the component.
getItemCount( ): Returns the number of the items.
getItemDisabled( index ): Returns the disabled status of the item of the corresponding index.
getNextTabID( ): Returns the nextTabID value.
getOpacity( ): Gets the opacity of the component defined in CSS.
getPluginName( ): Gets the pluginName (or the name) of the component.
getPosition( positionName ): Gets the left or top position of the component.
getReadOnly( ): Gets the current setting of the readOnly property.
getScope( ): Returns the parent WFrame object when the component is a child of the WFrame which uses the scope feature (scope=true).
getScopeWindow( ): Returns the scope object of the parent when the component is a child of the WFrame which uses the scope feature (scope=true).
getSelectedInfo( ): Returns the JSON data containing information of the selected item as an array.
getSize( sizeName ): Gets the size of the component.
getStyle( propertyName ): Gets the current value of the propertyName of the component defined in CSS.
getStyleValue( style ): [deprecated] Use getStyle instead.
getText( separator ): Gets the label of the currently selected item. For multiple items, uses the defined separator.
getTextArray( ): Returns the labels of the selected items in an array.
getTitle( ): Gets the title value.
getUdcHome( ): Returns the path of the file which defines the UDC.
getUdcRoot( ): Returns the path of the file which defines the UDC.
getUserData( key ): Returns the user-defined property value set by setUserData as the user data or source (page XML).
getValue( separator ): Gets the value of the currently selected item. Uses the defined separator for multiple values.
getValueArray( ): Returns the values of the selected items in an array.
hasClass( className ): Checks whether the component has className received as a parameter or not.
hide( ): Hides the component.
removeAll( isInitialize ): [default:false, true] Removes all items. In case allOption is specified and isInitialize is true, the item will not be removed.
removeClass( className ): Removes className from the component.
setDisabled( disabled ): Sets the disabled property.
setEventPause( evList , flag ): Disables or enables the component event.
setInitStyle( property ): Initializes the component style.
setItemDisabled( idx , value ): Disables or enables the item of the corresponding index.
setNextTabID( componentID , componentScope ): Sets the nextTabID.
setNodeSet( nodeset , label , value ): Changes the itemset setting. When bound with a DataList, the nodeset must start with data: prefix.
setOpacity( value ): Sets the opacity of the component.
setPosition( left , top , mode ): Sets the position (left, top) of the component.
setReadOnly( readOnly ): Controls the "readOnly" property.
setRef( ref ): Dynamically sets the ref binding. Add data: prefix to bind with a DataCollection.
setSelectedInfo( infoArray ): Selects or unselects items based on the selection information (in JSON format).
setSize( width , heigth ): Sets the size (width, height) of the component.
setStyle( propertyName , value ): Sets the style of the specified property.
setText( label ): Selects the item of the specified label. Use the specified separator to enter multiple labels.
setUserData( key , value ): Sets the user data in the component.
setValue( value ): Selects an item which contains the value received as a parameter, and sets the value in the selected item.
show( displayType ): Displays the component.
toggleClass( className ): Removes a class named className, or if there is no such a class, adds a class named className.
trigger( type , array ): Triggers a certain event registered for the component.
unbind( type , function ): Removes an event registered for the component.
unbindRef( ): Releases the ref binding.
validateObject( ): Validates the component according to the specified properties.
visible( flag ): [deprecated] Shows/Hides the component, or sets the visible property using setStyle.

Property Detail

allOption: [default:false, true] Whether to allow all options or not. The label is "-All-" and the value is "all".
animation: Sets the animation for the itemtable.
appearance: The appearance property of xforms select1
checkboxClickSync: [default:false, true] Synchronizes the checkbox clicking with the selected itemset.
checkDisabledOnAllCheck: [default:true, false]
Select disabled items also when selecting all items.
true (Default): Selects disabled items.
false: Does not select disabled items.
chooseOption: [default:false,true] Displays the selection options. In case the chooseOptionLabel is not defined, the label will be "-Choose-" and the value ""(empty string).
chooseOptionLabel: Define the text (label) to guide selection when the chooseOption is true.
class: Provides a similar feature to the class in HTML. One or more classes defined in the CSS file or the style block can be used.
The WebSquare5 Engine has a dedicated class to each component. Using the class of the component, the developer can apply a common CSS.
closeonmouseleave: [default:false, true] Closes the sub-layer upon the mouseleave event.
delimiter: Separates the value from the label. Used by the displayMode property.
Used as the "delim" in the displayMode property.
direction: [defulat:auto, down, up] Opening direction of the items
disabled: [default:false, true] Disables the component.
displayAllOptionLabel: [default:false, true] Displays All instead of the labels of all items.
displaymessage: [default:false, true] Displays the result message upon a validation failure by the validation API.
Displays the result message upon a validation failure by the validation API. Define a customized message using the invalidMessageFunc property.
displayMode: [default:label, value delim label, label delim value] Mode of display. Both the label and the value can be displayed. The separator (delim) is defined in the delimiter property.
escape: Converts <>&" characters into HTML Escape characters.
id: ID of the component. Allocated as a global object. Scripts access the component through the ID.
invalidMessage: A message displayed upon failure of the validation API. The displaymessage property must be true.
Cannot be used with invalidMessageFunc at the same time.
invalidMessageFunc: Name of the function that dynamically displays messages upon a validation failure by the validation API.
The displaymessage property must be true. Cannot be used with invalidMessage at the same time.
The customized function (in the following example) gets the type of the value through this.getType() and the value through this.getValue(), and returns the dynamically created message through the use of the type and the value.
(Type) mandatory, allowChar, ignoreChar, minLength, maxLength, minByteLength, maxByteLength
(Example) function fn_msg(){ var tmpType = this.getType(); var tmpValue = this.getValue(); if(tmpType == "mandatory"){ return "Required."; } }
labelWidthAuto: [default:false, true]
Note when the position is absolute in the style and the component is on the right side, the component position may get unstable. Put the component on the left side, or set the component position as relative.
mandatory: [default:false, true] Whether to check the mandatory input or not when calling the validation API.
navBtn: Sets the button for the itemtable.
nextTabID: Component ID to move by tab
ref: The value of the DataCollection. Required to bind the component with a DataCollection. Starts with a prefix of "data:".
(Format: data: [DataCollection ID].[Key id or Column id]) (Example) data:dataMap1.dept
When bound with a DataList, the row selected on the GridView will be bound.
Specify the XPath of the XML data to interface with the instance data. (Example) res/userInfo/dept/@value
separator: [default:" "(space)] String containing values of the selected items in the component.
sortMethod: [default:ascending, descending] Referenced by the sortOption property. The method to sort the values defined in the sortOption.
sortOption: [label,value] Used to sort the items by label or value.
In the default, the items are sorted in ascending order. In case sortMethod is specified, the items will be sorted in the corresponding method.
submenuSize: [default:auto, fixed] Whether to fit the list size to the label or fix it to the default width. Not valid when the labelWidthAuto property is true.
tabIndex: Same as the tabindex property in HTML standard. Indicates the focusing order of the component by the tab key.
title: Same as the title property of HTML. Displays the Text upon the end user's hovering the mouse over the browser.
useLocale: [default:false, true] True to use the multi-language key to display the labels on the WebSquare5 client.
Uses the multi-language key to display the label on the client side.
userData1: User-defined property. Use getUserData("userData1") 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
visibleRowNum: Number of the rows to be displayed
wmode: [default:false, true] se wmode. To be used when the component is hidden by an object (such as activeX or flash).
sing the wmode (true) is to put the component above the object tag, not to set the wmode. It is recommended to use the wmode in the object tag (such as activeX or flash).

Event Detail

onblur

Triggered when the focus is lost.

Parameter
name	type	description
e	Object	Event object

onchange

Triggered upon the end user's selecting/changing an item or setting a value. Use the onviewchange event to control only the end user's selecting an item.
The event handler (this function) can access the component. (Example) this.getValue();

oncheckboxclick

Triggered upon selection (checking/unchcking) of an item on the list.

Parameter
name	type	description
index	Number	Index of the selected item
isChecked	Boolean	true is when the checkbox is checked, or false when the checkbox is unchecked.
value	String	Value of the selected item

onclick

Triggered upon the end user's clicking the CheckComboBox component.

Parameter
name	type	description
e	Object	Event object

onclose

Triggered upon clicking other areas after selection.

Parameter
name	type	description
flag	Boolean	true : Upon the user's clicking other areas than the list

ondblclick

Triggered upon the end user's double-clicking the CheckComboBox 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, no event will be triggered. (Similar to the native onchange event.)

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

Sample

Method Detail

addClass( className )

Adds a class to the component.

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

Sample

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

addItem( value , label , idx )

Adds an item. If no index is specified, the item will be appended to the lower node.
Note that when allOption is enabled, the item will be included in the index but chooseOption will not.

Parameter
name	type	required	description
value	String	Y	Value of the item
label	String	Y	Label of the item
idx	Number	N	Index of the item

Return
type	description
Number	Index of the added item

Sample

// Do not add an item. Set chooseOption and allOption as "true". <xf:checkcombobox id="checkcombobox1" chooseOption="true" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"></xf:checkcombobox> // Add an item without specifying an index. checkcombobox1.addItem( "1" , "Apple"); // Result - "All" Added to the end of the list. The order of the items will be "All", // "Select"(chooseOption) will not be on the selection list. Unselected items will be included in the label. // Add an item with specifying the index as "0". checkcombobox1.addItem( "2" , "Orange",0); // Result - An item of Index 0 will be added before "All". The order of the items will be "Orange", "All", "Apple". // "Select"(chooseOption) will not be on the selection list. Unselected items will be included in the label.

bind( eventType , function )

Dynamically allocates events to the component.

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

Sample

// Define the event handler function for the onclick event in the input component, and bind the function. input1.bind("onclick", function(e){ alert(input1.getValue();})); // Bind commObj.ev_click function for the onclick event with component input1. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; input1.bind("onclick", commObj.ev_click );

changeClass( oldClassName , newClassName )

Renames the class from oldClassName to newClassName.
In the default setting, only the classes added by addClass will be applied. In order to directly remove the class defined in the "class" property of the component, add the following setting in config.xml file.
<style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
oldClassName	String	Y	Name of the class to remove
newClassName	String	Y	Name of the class to add

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following to config.xml. <style> <removeDefaultClass value="true" /> </style> // Change tmpInputClass class to tmpInputWarninClass. input1.changeClass("tmpInputClass","tmpInputWarninClass");

checkAll( checked )

Checks or unchecks all items.

Parameter
name	type	required	description
checked	Boolean	Y	true is to check all, or false is to uncheck all.

Sample

// Check all. checkcombobox1.checkAll(true); // Uncheck all. checkcombobox1.checkAll(false);

deleteItem( idx )

Deletes the item of the corresponding index. When the allOption is true, the index will be numbered from an option that is to select all items.

Parameter
name	type	required	description
idx	Number	N	Index of the item to delete

Return
type	description
JSON	JSON containing information of the deleted item

Sample

// Add an item as shown below, and set chooseOption and allOption as "true". <xf:checkcombobox id="checkcombobox1" chooseOption="true" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> </xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> var returnValue = checkcombobox1.deleteItem(0); // Since allOption is "true", the corresponding item will be deleted. // (Return Example) {label: "All", value: "all"}

focus( )

Moves the focus to the component.

getDisabled( )

Gets the current value of the disabled property.

Return
type	description
Boolean	The value of the disabled property.

Sample

var returnValue = componentId.getDisabled(); (Return example) false

getGenerator( )

Called by a component under the Generator component. When called, gets the parent Generator object.

Return
type	description
Object	Parent Generator object

Sample

<w2:generator id="generator1"> <w2:trigger id="trigger1" ev:onclick="scwin.trigger1_onclick"></w2:trigger></w2:generator> scwin.trigger1.onclick = function(){ console.log(this.getGenerator());} // Click trigger1 to display the generator1 object on the console. // See https://inswave.com/jira/browse/WPF-1425.

getID( )

Gets the ID of the component.

Return
type	description
String	ID of the WebSquare5 component

Sample

// The WebSquare5 component dynamically received as a parameter can be used as shown in the following. function fn_validCheck(tmpObj){ // tmpObj has an ID of "input1". var compID = tmpObj.getID(); // (Return Example) "input1" }

getInfo( index )

Returns JSON data containing of all item information as an array.

Parameter
name	type	required	description
index	Integer	Y	Index

Return
type	description
JSON	JSON containing item information

Sample

// Add an item as shown below, and set chooseOption and allOption as "true". <xf:checkcombobox id="checkcombobox1" chooseOption="true" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> var returnValue = checkcombobox1.getInfo(1); // Since allOption is "ture", the first will be Apple. // (Return Example) {index: 1, label: "Apple", value: "1", checked: false}

getInfoArray( )

Returns JSON data containing of all item information as an array.

Return
type	description
Array	JSON array containing all item information

Sample

// Add an item as shown below, and set chooseOption and allOption as "true". <xf:checkcombobox id="checkcombobox1" chooseOption="true" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> var listArray = checkcombobox1.getInfoArray(); // Get information of Apple var tmpListObj = listArray[1]; // (Return Example) {index: 1, label: "Apple", value: "1", checked: false} // Get the value of Apple. var tmpListValue = tmpListObj.value; (Return Example) "1"

getInitStyle( property )

Gets the initial style of the component.

Parameter
name	type	required	description
property	String	N	Name of the attribute (If not specified, all information will be ouputted.)

getItemCount( )

Returns the number of the items.

Return
type	description
Number	Number of the items

Sample

// When there are total two items var returnValue = checkcombobox1.getItemCount(); // (Return Example) 2

getItemDisabled( index )

Returns the disabled status of the item of the corresponding index.

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

Return
type	description
Boolean	Disabled status of the item

Sample

// Get the disabled status of the first item which is enabled. var returnValue = checkcombobox1.getItemDisabled(0); // (Return Example) false

getNextTabID( )

Returns the nextTabID value.

Sample

var nextTabID = checkcombobox1.getNextTabID();

getOpacity( )

Gets the opacity of the component defined in CSS.

Return
type	description
Integer	Opacity

Sample

// Apply opacity CSS to the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> var returnValue = input1.getOpacity(); // "returnValue" is a real number between 0 and 1. // (Return Value) "0.2"

getPluginName( )

Gets the pluginName (or the name) of the component.

Return
type	description
String	pluginName of the WebSquare5 component

Sample

// For a WebSquare5 object dynamically received by a common function, conditional statements can be used as shown below. var commObj = {}; commObj.fn_makeReqData = function(tmpObj){ var tmpID = tmpObj.getID(); // Component ID var tmpCompType = tmpObj.getPluginName(); // Component Type if(tmpCompType == "input"){ //..Logic.. }else if(tmpCompType == "gridView"){ //..Logic .. }else{ //..Logic.. } };

getPosition( positionName )

Gets the left or top position of the component. If set by %, the corresponding pixel value will be returned.

Parameter
name	type	required	description
positionName	String	Y	[left,top] Type of the position

Return
type	description
Number	Position of the component

Sample

// Apply margin CSS to the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> var returnValue = input1.getPosition("top"); // The returnValue will be a position in pixels. // (Return Example) 10

getReadOnly( )

Gets the current setting of the readOnly property.

Return
type	description
Boolean	The current setting of the readOnly property

Sample

var returnValue = componentId.getReadOnly(); // (Return Example) false

getScope( )

Returns the parent WFrame object when the component is a child of the WFrame which uses the scope feature (scope=true).
Returns null when the component is not a child of the WFrame using the scope feature (scope=true).

Return
type	description
Object	wframe object or null

Sample

// The main page contains wframe1, and wframe1 contains wframe11 which contains textbox1. textbox1.getScope(); // Returns wframe11 object.

getScopeWindow( )

Returns the scope object of the parent when the component is a child of the WFrame which uses the scope feature (scope=true).
Returns a global window object when the component is not a child of the WFrame using the scope feature (scope=true.

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

Sample

// The main page contains wframe1, and wframe1 contains wframe11 which contains textbox1. var scope = textbox1.getScopeWindow(); scope.wframe11 === textbox1.getScope(); // true

getSelectedInfo( )

Returns the JSON data containing information of the selected item as an array.

Return
type	description
Array	JSON array containing information of the selected items.

Sample

// Add an item, and select Apple item. <xf:checkcombobox id="checkcombobox1" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> var selectedArr = checkcombobox1.getSelectedInfo(); // (Return Example) [{index: 0, label: "Apple", value: "1", checked: true}] // Get the first item (Apple). var selectedObj = selectedArr[0]; // (Return Example) {index: 0, label: "Apple", value: "1", checked: true} // Get the value of the first item. var selectedValue = selectedObj.value; // (Return Example) "1"

getSize( sizeName )

Gets the size of the component. If set by "%", the corresponding pixel value will be returned.

Parameter
name	type	required	description
sizeName	String	Y	[height, innerHeight, outerHeight, outerMarginHeight, width, innerWidth, outerWidth, outerMarginWidth] Type of the size. For the calculation of each size type, see below.

Return
type	description
Number	Size of the component

Sample

var returnValue = componentId.getSize("width"); // "returnValue" will be a size in pixels. If set by "%", the corresponding pixel value will be returned. // (Return Example) 100

getStyle( propertyName )

Gets the current value of the propertyName of the component defined in CSS.

Parameter
name	type	required	description
propertyName	String	Y	Name of the property in the style

Return
type	description
String	Style value

Sample

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

getStyleValue( style )

[deprecated] Use getStyle instead.
Gets the current value of the propertyName of the component defined in CSS.

Parameter
name	type	required	description
style	String	Y	Name of the property defined in the style

Return
type	description
String	Value defined in the style property. (In case of a color, the hexcode of the color will be returned.)

getText( separator )

Gets the label of the currently selected item. For multiple items, uses the defined separator.
Gets the label of the currently selected item. For multiple items, uses the defined separator.

Parameter
name	type	required	description
separator	String	N	Separator

Return
type	description
String	String containing labels of the selected items

Sample

// Select "Apple" and "Orange". var returnValue = checkcombobox1.getText(); // (Return Example) "Apple Orange" // Use the separator. var returnValue = checkcombobox1.getText(","); // (Return Example) "Apple,Orange"

getTextArray( )

Returns the labels of the selected items in an array.

Return
type	description
Array	Array containing labels of the selected items

Sample

// Select "Apple" and "Orange". var returnValue = checkcombobox1.getTextArray(); // (Return Example) ["Apple", "Orange"]

getTitle( )

Gets the title value.

Return
type	description
String	Title value

Sample

// Define the "title" for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); // (Return Example ) "Input Name"

getUdcHome( )

Returns the path of the file which defines the UDC. Includes the file extension of .xml. For a path without .xml, use getUdcRoot. When called by a component, not a UDC object, undefined will be returned.

Return
type	description
String	When called by a component, not a UDC object, undefined will be returned.

Sample

The udc file is /a/b/udc.xml, the XML file is /a/c/main.xml, and the UDC object ID is udc1. udc1.getUdcHome(); // The execution result is /a/b/udc.xml.

getUdcRoot( )

Returns the path of the file which defines the UDC. udc1.getUdcHome(); // The execution result is /a/b/udc.xml. For a path including .xml, use getUdcHome. When called by a component, not a UDC object, undefined will be returned.

Return
type	description
String	When called by a component, not a UDC object, undefined will be returned.

Sample

The udc file is /a/b/udc.xml, the XML file is /a/c/main.xml, and the UDC object ID is udc1. udc1.getUdcHome(); // The execution result is /a/b/udc.xml.

getUserData( key )

Returns the user-defined property value set by setUserData as the user data or source (page XML).

Parameter
name	type	required	description
key	String	Y	Random data key

Return
type	description
String	Data of the corresponding key

Sample

// Apply the customized property (eduTest) to the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" eduTest="Hello"></xf:input> input1.getUserData("eduTest"); // (Return Example) "Hello" // Use setUserData. input1.setUserData("eduTest","WebSquare"); input1.getUserData("WebSquare"); // (Return Example) "Hello"

getValue( separator )

Gets the value of the currently selected item. Uses the defined separator for multiple values.
Gets the label of the currently selected item. For multiple items, uses the defined separator.

Parameter
name	type	required	description
separator	String	N	Separator

Return
type	description
String	Values of the selected items

Sample

// When values "1" and "2" are selected. // Use the corresponding API. var returnValue = checkcombobox1.getValue(); // (Return Example) "1 2" // Use "," separator. var returnValue = checkcombobox1.getValue(","); // (Return Example) "1,2"

getValueArray( )

Returns the values of the selected items in an array.

Return
type	description
Array	Array of the values of the selected items

Sample

// When values "1" and "2" are selected. var returnValue = checkcombobox1.getValueArray(); // (Return Example) ["1", "2"]

hasClass( className )

Checks whether the component has className received as a parameter or not.

Parameter
name	type	required	description
className	String	Y	className to check

Return
type	description
Boolean	Whether the component has the class or not

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> var returnValue = input1.hasClass("tmpInputClass"); // (Return Example) true

hide( )

Hides the component.

removeAll( isInitialize )

[default:false, true] Removes all items. In case allOption is specified and isInitialize is true, the item will not be removed.

Parameter
name	type	required	description
isInitialize	Boolean	N	Whether to delete allOption item or not.

Sample

// When allOption is defined, all items including allOption will be deleted. checkcombobox1.removeAll(); // When allOption is defined, all items but allOption will be deleted. checkcombobox1.removeAll(true);

removeClass( className )

Removes className from the component.
In the default setting, only the classes added by addClass will be applied. In order to directly remove the class defined in the "class" property of the component, add the following setting in config.xml file.
<style><removeDefaultClass value="true" /></style>

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

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following to config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.removeClass("tmpInputClass");

setDisabled( disabled )

Sets the disabled property. True to disable, or false not to disable.

Parameter
name	type	required	description
disabled	Boolean	Y	True to disable, or false not to disable.

Sample

// Disable the component. componentId.setDisabled(true);

setEventPause( evList , flag )

Disables or enables the component event.

Parameter
name	type	required	description
evList	String	N	List of the events. If not specified, all user events of the component will be listed. (Enter null data.)
flag	Boolean	Y	true is to pause, or false is to cancel pausing.

Sample

input1.setEventPause("onclick", true); // Dynamically pauses the onclick event. input1.setEventPause("onfocus,onblur", false); // Restarts the onfocus and the onblur events. input1.setEventPause(null, true); // Pauses all user events registered for the Input component.

setInitStyle( property )

Initializes the component style.

Parameter
name	type	required	description
property	String	N	Name of the property (If not specified, all properties will be returned.)

Sample

group1.getInitStyle();

setItemDisabled( idx , value )

Disables or enables the item of the corresponding index.

Parameter
name	type	required	description
idx	Number	Y	Index of the item to disable
value	Boolean	Y	Disabled status

Sample

checkcombobox1.setItemDisabled(0, true); The first item is disabled. The item cannot be selected nor unselected.

setNextTabID( componentID , componentScope )

Sets the nextTabID. When the ID of the frame in which the nextTabID, the second argument, is given, the scope can be set.

Parameter
name	type	required	description
componentID	String	Y	Component ID to set as the nextTabID
componentScope	String	N	Component scope to set as the nextTabID

Sample

checkcombobox1.setNextTabID("input2", "wframe1");

setNodeSet( nodeset , label , value )

Changes the itemset setting. When bound with a DataList, the nodeset must start with data: prefix.

Parameter
name	type	required	description
nodeset	String	Y	Add data: prefix (or the XPath of the instance data) to the Id of the DataList.
label	String	N	ID of the column to be used as the label. If not specified, the existing value will be used. (Or XPath under the nodeset to set for the label.)
value	String	N	ID of the column to be used as the value. If not specified, the existing value will be used. (Or XPath under the nodeset to set for the value.)

Sample

// Define a DataList as shown below. <w2:dataList id="dataList1"> <w2:columnInfo> <w2:column id="lbl" dataType="text"></w2:column> <w2:column id="code" dataType="text"></w2:column> </w2:columnInfo> <w2:data use="true"> <w2:row> <lbl><![CDATA[zero]]></lbl> <code><![CDATA[0]]></code> </w2:row> <w2:row> <lbl><![CDATA[one]]></lbl> <code><![CDATA[1]]></code> </w2:row> </w2:data> </w2:dataList> // Change the itemset of checkcombobox1 into, and set the label as lbl column and the value as code column. checkcombobox1.setNodeSet('data:dataList1','lbl','code'); // Change to dataList2 which has same columns with dataList1 but different data. checkcombobox1.setNodeSet('data:dataList2'); // Keep the existing label and the value, and change the dataList only.

setOpacity( value )

Sets the opacity of the component.

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

Sample

componentId.setOpacity(0.45);

setPosition( left , top , mode )

Sets the position (left, top) of the component.

Parameter
name	type	required	description
left	Number	Y	Left position or null.
top	Number	Y	Top position or null.
mode	String	N	[defulat:absolute, delta] absolute sets the current positions as x and y, and delta adds x and y to the current positions.

Sample

// Set the top position of the component as 100 pixels. componentId.setPosition(null, 100);

setReadOnly( readOnly )

Controls the "readOnly" property. True to enable, or false to disable.

Parameter
name	type	required	description
readOnly	Boolean	Y	True to enable, or false to disable.

Sample

// Enable the read-only. componentId.setReadOnly(true);

setRef( ref )

Dynamically sets the ref binding. Add data: prefix to bind with a DataCollection.
If not specified, XPath of the InstanceData will be used.

Parameter
name	type	required	description
ref	String	Y	Path of the ref to apply

Sample

// Bind hobby key of dataMap1 with the checkcombobox1 component. checkcombobox1.setRef("data:dataMap1.hobby"); // Bind with res/userData/hobby of the InstanceData. checkcombobox1.setRef("res/userData/hobby");

setSelectedInfo( infoArray )

Selects or unselects items based on the selection information (in JSON format).

Parameter
name	type	required	description
infoArray	Array	Y	JSON array containing information of the items to select/unselect

Sample

// Add an item and set allOption as "true". <xf:checkcombobox id="checkcombobox1" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> // When selecting "Orange" - because allOption is "true" the item will be of Index 0. checkcombobox1.setSelectedInfo([{index:2,checked:true}]); // When selecting "Apple" and "Orange" - because allOption is "true" the item will be of Index 0. checkcombobox1.setSelectedInfo([{index:1,checked:true},{index:2,checked:true}]);

setSize( width , heigth )

Sets the size (width, height) of the component.

Parameter
name	type	required	description
width	Number	Y	Component width or null
heigth	Number	Y	Component height or null

Sample

// Set the component height as 100 pixels. 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
value	String	Y	Value of the style

Sample

// Set the component width as 200px. componentId.setStyle("width", "200px"); // Change the background color to olive. componentId.setStyle("background-color","olive");

setText( label )

Selects the item of the specified label. Use the specified separator to enter multiple labels.
In case no separator is defined, blank space will be used.

Parameter
name	type	required	description
label	String	Y	Labels of the items to select

Sample

// Add an item and define "," as the separator. <xf:checkcombobox id="checkcombobox1" separator="," style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> // Select "Apple" and "Orange". checkcombobox1.setText("Apple,Orange");

setUserData( key , value )

Sets the user data in the component. If the key cannot be set for the component, corresponding logs will be displayed.

Parameter
name	type	required	description
key	String	Y	Random data key
value	String	Y	Random data key

Sample

// Setting a (key, value) pair of ("data", "WebSquare5") in the component. componentId.setUserData("data", "WebSquare"); // Some keys cannot be set for the component. componentId.setUserData("title", "WebSquare"); // (Log Example) !!!WARNING - [title] can't define as UserData

setValue( value )

Selects an item which contains the value received as a parameter, and sets the value in the selected item.
For multiple items, use a separator.
The default separator is space.

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

Sample

show( displayType )

Displays the component.
The related CSS properties are display and visibility:show;.

Parameter
name	type	required	description
displayType	String	N	[default:block ,inline ,none ,""] Value of the Display property.

Sample

// Block the "display" property. componentId.show(); // Enable the "display" property in the class. componentId.show("");

toggleClass( className )

Removes a class named className, or if there is no such a class, adds a class named className.
In the default setting, only the classes added by addClass can be removed. To remove other classes, add the following setting in config.xml.
<style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	className to set

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following to config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.toggleClass("tmpInputClass"); // Add tmpInputClass class again. input1.toggleClass("tmpInputClass");

trigger( type , array )

Triggers a certain event registered for the component.

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

Sample

// Trigger the onclick event in the input1 component. input1.trigger("onclick"); // Trigger the onviewchange event in the input component and call the event handler function by sending arguments of (1, 2). input1.trigger("onviewchange", [1,2]);

unbind( type , function )

Removes an event registered for the component.

Parameter
name	type	required	description
type	String	N	Name of the event to remove. If not specified, all events of the components 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

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

unbindRef( )

Releases the ref binding.

validateObject( )

Validates the component according to the specified properties.
Related Properties : mandatory, minLength, maxLength, minByteLength, maxByteLength

Return
type	description
Object	object validation result object

Sample

// Set mandatory in checkcombobox1 as shown below. <xf:checkcombobox appearance="minimal" id="checkcombobox1" style="position: absolute;width:249px;height:57px;left:74px;top:459px;" mandatory="true"> <xf:choices> <xf:itemset nodeset="data:dataList2"> <xf:label ref="label"></xf:label> <xf:value ref="value"></xf:value> </xf:itemset> </xf:choices> </xf:checkcombobox> var returnObj = checkcombobox1.validateObject(); // Return - without checkcombobox value) An empty object will be returned. // Return -with checkcombobox value) A returnObj object will be returned. returnObj.callerId = "checkcombobox1" returnObj.type = "mandatory" returnObj.value = "" Set displaymessage as true to alert a message defined in the WebSquare5 Engine upon a validation failure. //// (Alert Example) This field is mandatory.

visible( flag )

[deprecated] Shows/Hides the component, or sets the visible property using setStyle.
Sets the visibility of the component style. In case of true, set visible. In case of false, set hidden.

Parameter
name	type	required	description
flag	Boolean	Y	Visibility (In case of true, set visible. In case of false, set hidden.)