WebSquare.uiplugin.checkcombobox

CheckComboBox. An extended version of <select> tag of HTML. As a combined type of SelectBox and CheckBox, supports multiple selections. Various tags are used under the <div> tag at the highest level.

Type

uiplugin

Property Summary

allOption: Displays “-All-” on the selection list.
animation: Animation effects to apply to the selection item list.
appearance: Selection item display method
checkboxClickSync: Synchronizes with the selection on the CheckBox.
checkDisabledOnAllCheck: Select disabled items also when selecting all items.
chooseOption: Shows the selection guide message. [default: false, true]
chooseOptionLabel: Set the label of the selection guide message.
chooseOptionLabelLocaleRef: Key of the chooseOptionLabel text.
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.
closeonmouseleave: Closes the list upon mouse moving out when the list is open on the subLayer. [default:false, true]
customLabelFormatter: Specify the user-defined function that can customize the label value.
delimiter: Delimiter to separate the value from the label when both the value and the label are displayed on the list.
direction: Opening direction of the selection items.
disabled: Opening direction.
displayAllOptionLabel: Displays All instead of the labels of all items.
displaymessage: Displays the result message upon a validation failure by validate(); API. [default: false, true]
displayMode: Displaying method. [default:label, value delim label, label delim value, value]
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.
labelWidthAuto: Ignores the defined width of the component, and automatically adjusts the width to the longest text. [default: false, true]
mandatory: Allows reading only. [default:false, true]
navBtn: Displays [Cancel] and [Confirm] buttons below the selection item list.
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
rangeSeparator: Specifies the ranged items. (Example: "x-y")
ref: Value path of the DataCollection. Used with a purpose to bind a DataCollection with a WebSquare component.
search: Search method. [default: start, contain, none]
searchTarget: Data to search based on the user's input.
separator: Separator to divide multiple selections
sortMethod: Sets how to sort the selection item list.
sortOption: Standard by which sorting will be made. [label, value]
submenuSize: Sets how to define the size the selection item list.
tabIndex: The focusing order by the Tab key.
title: Same as the class property in HTML.
useDrag: Selects multiple items through mouse dragging.
useEdit: Allows end users to directly enter the items to select. (Options) "true": Allows end users to directly enter selection items in the input field.
useItemLocale: Supports multi-language in the selection item list.
useKeywordHighlight: Highlights the keyword in the search result by applying a separate class.
useLocale: Multilanguage support
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property
validateOnInput: [default:false] Validates the user’s input (useEdit=“true”). Supported in IE9 or higher versions supporting oninput event. (Options) "false" (Default) : Does not apply.
validator: Name of the validation function
visibleColMax: Number of maximum columns to use to display selection items. To be used when the number of columns are decided based on the number of the selection items.
visibleColNum: Number of the columns to display selection items
visibleColumn: Hides certain items from the selection item list.
visibleColumnFalseValue: Value that specifies hiding of the items from the selection item list when the visibleColumn property is used.
visibleRowNum: Number of the rows to be displayed
wmode: Displays the selection item list above the object tag using the wmode. [default:false, true]

Event Summary

onblur: Triggered when the focus is lost.
onchange: Triggered upon a value change by the end user’s selecting/changing or through the use of the API.
oncheckboxclick: Triggered upon selection (checking/unchecking) of an item on the list.
onclick: Triggered upon the end user's clicking the 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 CSS class to the component.
addItem( value , label , index ): Adds an item. If the index is not specified, the item will be added as a sub-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.)
checkAll( checked ): Checks or unchecks all items.
deleteItem( index ): Deletes the item of the corresponding index.
focus( ): Focuses the WebSquare component.
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.
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( CSS ): Returns the initial style of the WebSquare component.
getItemCount( ): Returns the number of the items on the list.
getItemDisabled( index ): Returns the disabled status of the item of the corresponding index.
getNextTabID( ): Returns the nextTabID value.
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.)
getSelectedInfo( ): Returns the JSON data containing information of the selected item as an array.
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 ): Gets the label of the currently selected item. Multiple items are separated by the specified separator when being returned.
getTextArray( ): Returns the labels of the selected items in an array.
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. Multiple items are separated by the specified separator when being returned.
getValueArray( ): Returns the values of the selected items in an array.
hasClass( className ): Checks whether the WebSquare component has a certain class.
hide( ): Hides the component.
initCheckCombobox( ): Initializes the CheckComboBox.
openTable( ): Opens the selection item list.
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.
setItemDisabled( index , flag ): Sets the disabled status of the item of the corresponding index.
setItemSet( nodeset , label , value ): Sets the selection item list.
setNextTabID( componentID , componentScope ): Sets the nextTabID property.
setNodeSet( nodeset , label , value ): Sets the selection item list.
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. Add “data:” prefix to bind with a DataCollection.
setSelectedInfo( infoArray ): Selects or unselects items based on the selection information (in JSON format).
setSize( width , height ): Sets the size (width, height) of the WebSquare component.
setStyle( propertyName , value ): Sets the CSS of the WebSquare component.
setText( label ): Selects the item of the specified label. Use the specified separator to enter multiple labels.
setUserData( key , value ): Sets random data in the WebSquare component. (Supported in all WebSquare components.)
setValue( value ): Selects the selection item of the given value.
setVisibleColumn( columnId , visibleColumnFalseValue ): Dynamically sets the visibleColumn property.
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.
validateObject( ): Validates the component according to the specified properties.
visible( flag ): [deprecated]

Property Detail

allOption: Whether to allow all options or not. The label is "-All-" and the value is "all". [default: false, true]
animation: Animation effects to apply to the selection item list. [default: "", show, fadeIn, slideDown]
appearance: Selection item display method
checkboxClickSync: Synchronizes with the selection. [default: false, true]
checkDisabledOnAllCheck: Select disabled items also when selecting all items. [default: true, false]
chooseOption: Shows the selection guide message. [default: false, true]
Display the text defined as the chooseOptionLabel property.
However, if chooseOptionLabel is not specified while chooseOption is "true", "-Choose-" (label) will be displayed. At the time, the value will be "" (empty string).
chooseOptionLabel: Set the label of the selection guide message. Valid when the chooseOption is "true".
chooseOptionLabelLocaleRef: Key of the chooseOptionLabel text.
When there is no text for the key, "global_undefined" will be displayed on the screen.
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.
closeonmouseleave: Closes the list upon mouse moving out when the list is open on the subLayer. [default:false, true]
customLabelFormatter: Specify the user-defined function that can customize the label value of the SelectBox. [default: “”]
delimiter: Separates the value from the label. Used by the displayMode property.
direction: Opening direction of the items. [defulat: auto, down, up]
disabled: Disable the component. [default:false, true]
displayAllOptionLabel: Displays “All” instead of the labels of all items. [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.
displayMode: Displaying method. [default:label, value delim label, label delim value, value]
Both the label and the value are displayed.
The delimiter is defined as a property.
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.
labelWidthAuto: Ignores the defined width of the component, and automatically adjusts the width to the longest text. [default: false, true]
However, in case of “position: absolute;” with the component on the right, the UI may not be displayed as intended.
It is recommended that there should be no component on the right and use “position: relative;” CSS.
mandatory: Allows reading only. [default:false, true]
The validation function checks the mandatory fields.
navBtn: Displays [Cancel] and [Confirm] buttons below the selection item list.
([Cancel] - Cancels selection. [Confirm] - Confirms selection.)
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
rangeSeparator: Specifies the ranged items. (Example: "x-y")
The range is determined based on the sequence of the items on the selection item list.
ref: Value path of the DataCollection. Used with a purpose to bind a DataCollection with a WebSquare component.
(Format: data: [DataCollection ID].[Key id or Column id])
When bound with a DataList, the value of the selected row in the GridView will be bound.
search: Search method. [default: start, contain, none]
Valid only in case of interactionMode="true".
searchTarget: Data to search based on the user's input. [default:label, value, both]
separator: Separator to divide multiple selections. [default:" "(space)]
sortMethod: Sorting method. Valid only when the sortOption is defined. [default: ascending, descending]
sortOption: Standard by which sorting will be made. [label, value]
Sorted in ascending powers in default. However, in case the sortMethod is defined, the specified sorting method will be used.
submenuSize: Way of deciding the selection item list. [default: fixed, auto, column]
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
title: Same as the title property in HTML. The title is displayed upon the end user’s moving the mouse over the component. Generally used to support web accessibility.
useDrag: Selects multiple items through mouse dragging.
Hold the Shift and drag the mouse to unselect items.
useEdit: Allows end users to directly enter the items to select.
useItemLocale: Supports multi-language in the selection item list.
useKeywordHighlight: Highlights the keyword in the search result by applying a separate class. [default:false, true]
useLocale: Multilanguage support
Uses multi-language keys of the client to display label values in multiple languages.
(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.
validateOnInput: [default:false] Validates the user’s input (useEdit=“true”). Supported in IE9 or higher versions supporting oninput event.
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.
visibleColMax: Number of maximum columns to use to display selection items. To be used when the number of columns are decided based on the number of the selection items.
visibleColNum = Math.min(visibleColMax, Math.ceil(itemCount / visibleRowNum))
In case the visibleColNum is defined, the visibleColMax will be denied.
visibleColNum: Number of the columns to display selection items The default is 1.
visibleColumn: Hides certain items from the selection item list.
Shows the display status when the selection item list is bound with the DataList.
In case the column value is same as the visibleColumnFalseValue value, the corresponding row will not be displayed on the selection item list.
selectedIndex is not affected. In other words, the entire index, not the displayed index, is used.
The property can be set by the setVisibleColumn API.
visibleColumnFalseValue: Value that specifies hiding of the items from the selection item list when the visibleColumn property is used.
visibleRowNum: Number of the rows to be displayed "1" is not recommended.
wmode: Displays the selection item list above the object tag using the wmode. [default:false, true]
To be used when the selection item list is hidden by objects (such as ActiveX, Flash, etc.)
Use wmode in the object (such as ActiveX, Flash, etc.) not in the component.

Event Detail

onblur

Triggered when the focus is lost.

Parameter
name	type	description
e	Object	Event object

onchange

Triggered upon a value change by the end user’s selecting/changing or through the use of the API.
When controlling the end user’s selection only, use the onviewchange event.

Parameter
name	type	description
info	JSON	Returns JSON data containing oldValue and newValue.

Sample

// The event is within the component tag. <script ev:event="onchange( info )"><![CDATA[ var oldValue = info.oldValue; var newValue = info.newValue; ]]></script>

oncheckboxclick

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

Parameter
name	type	description
index	Number	Index of the selected item
isChecked	Boolean	Selection status.
value	String	Value of the selected item

onclick

Triggered upon the end user's clicking the component.

Parameter
name	type	description
e	Object	Event object

onclose

Triggered upon clicking other areas after selection.

Parameter
name	type	description
flag	Boolean	Closes.

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, the event will not 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 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 )

Adds an item. If the index is not specified, the item will be added as a sub-item.
Note that when allOption is enabled, the item will be included in the index but the item defined by the chooseOption will not be included in the index.

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

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 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");

checkAll( checked )

Checks or unchecks all items.

Parameter
name	type	required	description
checked	Boolean	Y	{0}// Select/Unselect

Sample

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

deleteItem( index )

Deletes the item of the corresponding index. When the allOption is true, the index will be numbered.

Parameter
name	type	required	description
index	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) {label: "All", value: "all"}

focus( )

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

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"

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( 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

// When there are total two items var returnValue = checkcombobox1.getItemCount(); // (Return) 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) false

getNextTabID( )

Returns the nextTabID value. (Related Property) nextTabID

Sample

// Example var nextTabID = checkcombobox1.getNextTabID();

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

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 )

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 )

Gets the label of the currently 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 labels of the selected items

Sample

// Select "Apple" and "Orange". var returnValue = checkcombobox1.getText(); // (Return) "Apple Orange" // Use the separator. var returnValue = checkcombobox1.getText(","); // (Return) "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( )

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 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 value of the selected item.

Sample

// When values "1" and "2" are selected. // Use the corresponding API. var returnValue = checkcombobox1.getValue(); // (Return) "1 2" // Use "," separator. var returnValue = checkcombobox1.getValue(","); // (Return) "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 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 component.

initCheckCombobox( )

Initializes the CheckComboBox. (Deletes the items and initializes the values.)

Sample

// (Example) checkcombobox.initCheckCombobox();

openTable( )

Opens the selection item list.
Updates the selection item list (updateTabe), and shows the selection item list (showTable).
Must be called by xforms-submit-done event when the interactionMode is "true", and must be called after the submission or submissionFunc. (Related Property) interactionMode="true"

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();

setItemDisabled( index , flag )

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

Parameter
name	type	required	description
index	Number	Y	Index of the item
flag	Boolean	Y	Disabled status

Sample

// Disable the first item. checkcombobox1.setItemDisabled(0, true); // The first item cannot be selected or unselected.

setItemSet( nodeset , label , value )

Sets the selection item list.
Keeps the current selection (input), and newly sets the selection item list only.

Parameter
name	type	required	description
nodeset	String	N	nodeset of the item
label	String	N	New path to set as the label of the selection item list
value	String	N	New path to set as the value of the selection item list

Sample

// (Example) // (1) Bind with "dc_tmpSearchList" DataList. // (2) Set the disp column as the label and the code column as the value. checkcombobox1.setItemSet("data:dc_tmpSearchList","disp","code");

setNextTabID( componentID , componentScope )

Sets the nextTabID property.
When the ID of the frame in which the nextTabID, the second argument, is given, the scope can be set. (Related Property) nextTabID

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

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

setNodeSet( nodeset , label , value )

Sets the selection item list.
When bound with the DataList, the nodeset parameter must start with "data:".

Parameter
name	type	required	description
nodeset	String	Y	DataList ID. Must start with "data:". (Or XPath of the InstanceData)
label	String	N	Column ID to set as the label. If no value is allocated, the existing value will be applied. (Or XPath under the nodeset to set as the label.)
value	String	N	Column ID to set as the value. If no value is allocated, the existing value will be applied. (Or XPath under the nodeset to set as the value.)

Sample

// Define a DataList. <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> // (EXample 1) Bind with DataList1, and use lbl column for the label and code column for the value. checkcombobox1.setNodeSet('data:dataList1','lbl','code'); // (Example 2) Bind with DataList2, and use existing column settings for the label and the value. checkcombobox1.setNodeSet('data:dataList2'); // (Result) The existing label and value codes remain the same, and only the DataList is changed.

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

Sample

//Bind hobby key of dataMap1 with the value of checkcombobox1. 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 , 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 CSS of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
propertyName	String	Y	CSS property to set.
value	String	Y	Value to set as the specified CSS property

Sample

// (Example 1) Set the width as 200px. componentId.setStyle("width", "200px"); // (Example 2) Set the background as 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 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 )

Selects the selection item of the given value.
When setting multiple items, use space. In case there is no item of the corresponding value, no operation will be made.

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

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[Apple]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[Orange]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> // Select "Apple" and "Orange". checkcombobox1.setValue("1,2");

setVisibleColumn( columnId , visibleColumnFalseValue )

Dynamically sets the visibleColumn property.
The visibleColumn column indicates whether to be displayed on the selection item list.
visibleColumn is to hide certain items from the selection item list of the CheckComboBox.
selectedIndex is not affected. Instead the entire selection item list is used. (Related Property) visibleColumn visibleColumnFalseValue

Parameter
name	type	required	description
columnId	String	Y	Column ID to set as the visibleColumn. (The column contains the item list to hide from the selection item list.)
visibleColumnFalseValue	String	N	Value required to hide from the selection item list.

Sample

// CheckComboBox is bound with the DataList. checkCombobox1.setVisibleColumn(col3, false); // (Result) Rows of which col3 has “false” value will not be displayed as selection items on the CheckComboBox.

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.

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 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 - When there is no CheckComboBox value) returnObj will be returned. returnObj.callerId = "checkcombobox1" returnObj.type = "mandatory" returnObj.value = "" // (Return - When there is a CheckComboBox 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