WebSquare.uiplugin.selectbox

Functions similar to the select tag of HTML. Allows the end user to select one or multiple items.
Note that the div tag is at the highest level when the SelectBox component is rendered on the browser. In order to use the select tag, add additional settings.

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: [default: "", show, fadeIn, slideDown] Sets the animation effects of the itemtable. The details are as described below.
appearance: [default:minimal,full] Appearance property of xforms select1. In case of minimal, a select box will be displayed, and in case of full, radio buttons will be displayed.
chooseOption: [default:false,true] Shows the selection guide message.
chooseOptionLabel: Set the label of the selection guide message.
class: Same as the class property in HTML standard. One or more classes defined in the CSS file or in the style block can be applied (through the use of the space as the separator).
closeonmouseleave: [default:false, true] Closes the list upon mouse moving out when the list is open on the subLayer.
customFormatter: [default:""] Sets a user-defined function to customize the item list.
customLabelFormatter: [default:""] Specify the user-defined function that can customize the label value of the SelectBox.
dataListAutoRefresh: [default: false, true] Automatically updates the DataList bound with the SelectBox upon execution of addItem or deleteItem.
delimiter: Delimiter to separate the value from the label when both the value and the label are displayed on the list.
direction: [defulat:auto, down, up] Opening direction of the items
disabled: [default:false, true] Disabled status of the component.
disabledClass: Name of the class to apply when the disabled property is true.
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, value] Displaying method.
emptyItem: [default:false, true] When a value or index not in the item list is set (by a method such as setValue or setSelectedIndex), sets an empty label or value (empty string).
emptyValue: When the emptyItem property is true, sets the value with the specified value of the emptyValue property.
escape: Converts <>&" characters into HTML Escape characters.
id: Component 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.
keyMoveListSync: [default:false, true] Allows item selection through the key move on the item list. The item selected by the keyboard on the item list will be used the actual selection of the SelectBox.
labelWidthAuto: [default:false, true] Ignores the defined width of the component, and automatically adjusts the width to the longest text.
mandatory: [default:false, true] Mandatory field. The validation function checks mandatory input fields. (Options) "false" (Default) Not make it mandatory. "true" Make it mandatory. </xmp></xmp>
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
optionOrder: [default:choose, all] Order of displaying selection items. all is to display both All and selection items.
preventWheelEvent: [default:false, true] Prevents mouse wheel events. (Options) "false" (Default) Not prevent mouse wheel events. "true" Prevent mouse wheel events. </xmp></xmp>
ref: The value of the DataCollection. Required to bind the component with a DataCollection. Starts with a prefix of "data:".
refreshSelectedIndex: [default:false, true] Synchrnizes the selectedIndex with the actual selection in the SelectBox upon update of the DataList bound with the item list.
renderType: [default:component, auto, native, select] Layout of the component on the browser.
selectedData: [default:true, false] Keeps the selection not existing in the bound DataList.
setDataRemoveAll: Initializes the data upon removeAll.
sortMethod: [default:ascending, descending] Sorting method. Valid only when the sortOption is defined. (Options) "ascending" (Default) Sorts in ascending powers. "descending" Sorts in descending powers. </xmp></xmp>
sortOption: [label,value] Standard by which sorting will be made.
submenuSize: [default:auto, fixed] Way of deciding the size of the selection item list.
tabIndex: The focusing order by the Tab key.
textAlign: [default:center, left, right] Text alignment of the selection iten list.
title: Same as the class property in HTML.
toolTip: Tooltip provided by WebSquare5. Displays additional information of the component.
tooltipClass: Name of the style class to apply to the tooltip
tooltipDisplay: [default:false, true] Displays tooltip based on the user’s selection.
tooltipTime: Tooltip display time. (Unit: second)
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
visibleColumn: Hides certain items from the selection item list of the SelectBox. Specifies the column in which the visibility information exists in the bound DataList.
visibleColumnFalseValue: Value that specifies hiding of the items from the selection item list when the visibleColumn property is used. The default is "0,false,FALSE,F".
visibleRowNum: Number of the rows to be displayed
wmode: [default:false, true] Displays the selection item list above the object tag using the wmode.

Event Summary

onblur: Triggered when the focus is lost.
onchange: riggered upon a selection change.
onclick: Triggered upon the end user's clicking the SelectBox component.
ondblclick: Triggered upon the end user's double-clicking the SelectBox component.
onfocus: Triggered upon the component being focused.
ontooltiphide: Triggered upon the tooltip being hidden
ontooltipshow: Triggered upon the tooltip showing
onviewchange: Triggered when the value on the list is changed through keyboard input or mouse clicking.

Method Summary

addClass( className ): Adds a CSS class to the component.
addItem( value , label , index , refresh ): Adds an item. If no index is specified, the item will be appended to the lower node.
bind( eventType , function ): Dynamically allocate an event and the handler function to the component.
changeChooseOption( newValue , newLabel ): Changes the chooseOption property.
changeClass( oldClassName , newClassName ): Changes the class currently applied to the corresponding WebSquare component. (Supported in all WebSquare components.)
deleteItem( idx , refresh ): Deletes the item of the corresponding index. If both the chooseOption and the allOption are true, the -Select- item will be considered being included in index numbering.
focus( ): Focuses the WebSquare component.
getDataListInfo( ): Returns the dataList bound with the 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.
getInitStyle( CSS ): Returns the initial style of the WebSquare component.
getItemCount( ): Returns the number of the items. If the chooseOption or allOption is true, -All- or -Select- will be considered as an item and will be also included in item counting.
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.
getReadOnly( ): Returns the current value of the readOnly property.
getScope( ): For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
getScopeWindow( ): For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
getSelectedIndex( ): Returns the index of the selected item. If the chooseOption or allOption is true, -All- or -Select- will be considered as an item and will be also included in index numbering.
getSize( sizeName ): Sets the size (width, height) of the WebSquare component.
getStyle( propertyName ): Returns the CSS setting of the WebSquare component.
getStyleValue( style ): [deprecated]
getText( isOriginal ): Returns the index of the currently selected item.
getTitle( ): Returns the title of the WebSquare component.
getUdcHome( ): Returns the path of the UDC file including the file name in which the UDC object is defined. (Supported in all WebSquare components.)
getUdcRoot( ): Returns the path of the UDC file in which the UDC object is defined. (Supported in all WebSquare components.)
getUserData( key ): Returns the value set by setUserData or directly defined by the user in the XML file.
getValue( ): Returns the value of the selected item.
hasClass( className ): Checks whether the WebSquare component has a certain class.
hide( ): Hides the component.
removeAll( isInitialize ): [default:false, true] Removes all items. If the chooseOption or allOption is true, the items for which isInitialize is true will not be deleted.
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.
setGridItemset( obj ): Dynamically changes the gridViewItemset binding.
setInitStyle( property ): Restores the initial style of the WebSquare component.
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( title ): Sets the ref property. Add “data:” prefix to bind with a DataCollection.
setSelectedIndex( idx ): Selects the item of the corresponding index. If the chooseOption or allOption is true, -All- or -Select- will be considered as an item and will be also included in index numbering.
setSize( width , height ): Sets the size (width, height) of the WebSquare component.
setStyle( propertyName , value ): Sets the CSS of the WebSquare component.
setText( lbl , isOriginal ): Selects an item of which label is same as the specified lbl value.
setTitle( title ): Sets the title of the WebSquare component.
setUserData( key , value ): Sets random data in the WebSquare component.
setValue( value ): Selects an item which contains the value received as a parameter, and sets the value in the selected item.
setVisibleColumn( columnId , visibleColumnFalseValue ): Dynamically sets the visibleColumn property.
show( displayType ): Shows the WebSquare component on the page. (Supported in all WebSquare components.)
showChooseOption( chooseOption ): Sets the chooseOption.
toggleClass( className ): Adds or removes a CSS class to or from a WebSquare component. (Supported in all WebSquare components.)
trigger( type , array ): Triggers the specified event in the WebSquare component.
unbind( type , function ): Removes the specified event from the WebSquare component.
unbindRef( ): Releases the ref binding.
validate( ): Validates the component according to the specified properties.
validateObject( ): Validates the component according to the specified properties.
visible( flag ): [deprecated]

Property Detail

allOption: [default:false, true] Whether to allow all options or not. The label is "-All-" and the value is "all".
animation: [default: "", show, fadeIn, slideDown] Sets the animation effects of the itemtable. The details are as described below.
Default: Displays the entire contents at once.
show : Spreads from one point.
fadeIn : Fades in.
slideDown : Slides down.
appearance: [default:minimal,full] Appearance property of xforms select1. In case of minimal, a select box will be displayed, and in case of full, radio buttons will be displayed.
chooseOption: [default:false,true] Shows the selection guide message.
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".
class: Same as the class property in HTML standard. One or more classes defined in the CSS file or in the style block can be applied (through the use of the space as the separator).
WebSquare5 Engine applies different classes to different components. By defining a common class, the common class can be applied to multiple components.
closeonmouseleave: [default:false, true] Closes the list upon mouse moving out when the list is open on the subLayer.
customFormatter: [default:""] Sets a user-defined function to customize the item list. (Not supported for gridItemset and gridViewItemset.)
customLabelFormatter: [default:""] Specify the user-defined function that can customize the label value of the SelectBox.
dataListAutoRefresh: [default: false, true] Automatically updates the DataList bound with the SelectBox upon execution of addItem or deleteItem.
true: Automatically updates. false: Default Not automatically update.
Required for lower compatibility. Setting true is recommended. (Set in config.xml to apply to all.)
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] Disable the component.
disabledClass: Name of the class to apply when the disabled property is true.
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, value] Displaying method.
Both the label and the value are displayed.
The delimiter is defined as a property.
emptyItem: [default:false, true] When a value or index not in the item list is set (by a method such as setValue or setSelectedIndex), sets an empty label or value (empty string).
Use the emptyValue property to set an additional value. If an item is added or removed while there is an empty value, the first item will be selected. (Same as selectedIndex=-1 of HTML select.)
Note that the label is still an empty string even when the chooseOption is true.
emptyValue: When the emptyItem property is true, sets the value with the specified value of the emptyValue property.
When the emptyItem property is true, sets the value with the specified value of the emptyValue property. Note that although the value is same as the emptyValue, the label will be empty.
escape: Converts <>&" characters into HTML Escape characters.
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component 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."; } }
keyMoveListSync: [default:false, true] Allows item selection through the key move on the item list. The item selected by the keyboard on the item list will be used the actual selection of the SelectBox.
Each moving on the item list will trigger the onviewchange event.
labelWidthAuto: [default:false, true] Ignores the defined width of the component, and automatically adjusts the width to the longest text.
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] Mandatory field. The validation function checks mandatory input fields.
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
optionOrder: [default:choose, all] Order of displaying selection items. all is to display both All and selection items.
preventWheelEvent: [default:false, true] Prevents mouse wheel events.
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
refreshSelectedIndex: [default:false, true] Synchrnizes the selectedIndex with the actual selection in the SelectBox upon update of the DataList bound with the item list.
Set this property as true for a new project. Required for lower compatibility.
renderType: [default:component, auto, native, select] Layout of the component on the browser.
component : Uses div tag as the highest tab. Use the select tag under the div tag.
native : Mostly used to comply with web accessibility requirements. Provides same UIs and features on all browsers with the same title for web accessibility.
select : Renders only the select tag. Complies with web accessibility requirements, but does not guarantee UI consistency on all browsers.
auto : Automatically selects the renderType. (native for mobile browsers, and component for others.)
selectedData: [default: true, false] Keeps the user’s selection when the selected data is not in the DataList bound.
setDataRemoveAll: Initializes the data upon removeAll.
sortMethod: [default:ascending, descending] Sorting method. Valid only when the sortOption is defined.
sortOption: [label,value] Standard by which sorting will be made.
Sorted in ascending powers in default. However, in case the sortMethod is defined, the specified sorting method will be used.
submenuSize: [default:auto, fixed] Way of deciding the size of the selection item list.
No functions when the labelWidthAuto is "true".
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
textAlign: [default:center, left, right] Text alignment of the selection iten list.
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.
toolTip: Tooltip provided by WebSquare5. Displays additional information of the component. Displayed upon mouse-over.
tooltipClass: Name of the style class to apply to the tooltip Valid in case of tooltipDisplay="true".
tooltipDisplay: [default:false, true] Displays tooltip based on the user’s selection.
tooltipTime: Tooltip display time. (Unit: second)
Valid in case of tooltipDisplay="true".
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("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.
visibleColumn: Hides certain items from the selection item list of the SelectBox. Specifies the column in which the visibility information exists in the bound DataList.
If the column has a value same as the visibleColumnFalseValue, the corresponding row will not be displayed on the selection item list.
selectedIndex is not affected. 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. The default is "0,false,FALSE,F".
In case dataList.getCellData(row, visibleColumn); returns one of "0,false,FALSE,F", the row will not be displayed on the selection item list.
visibleRowNum: Number of the rows to be displayed "1" is not recommended.
wmode: [default:false, true] Displays the selection item list above the object tag using the wmode.
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

riggered upon a selection change.

onclick

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

Parameter
name	type	description
e	Object	Event object

ondblclick

Triggered upon the end user's double-clicking the SelectBox component.

Parameter
name	type	description
e	Object	Event object

onfocus

Triggered upon the component being focused.

Parameter
name	type	description
e	Object	Event object

ontooltiphide

Triggered upon the tooltip being hidden

ontooltipshow

Triggered upon the tooltip showing

onviewchange

Triggered when the value on the list is changed through keyboard input or mouse clicking.

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 , refresh )

Adds an item. If no index is specified, the item will be appended to the lower node.
If the chooseOption or allOption is true, -All- or -Select- will be considered as an item and will be also included in index numbering.

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

Return
type	description
Number	Index of the added item

Sample

// Do not append, and set the chooseOption as true. <xf:select1 chooseOption="true" id="selectbox1" style="position: relative;width: 148px;height: 21px;" disabledClass="w2selectbox_disabled" appearance="minimal"> <xf:choices></xf:choices> </xf:select1> // Add an item without specifying an index. selectbox1.addItem( 'M', 'Male' ); // dded as the last item under "-Select-". The sequence will be "-Select-" and "Male". // (Return) 1 // Add an item with specifying the index as "0". selectbox1.addItem( 'F', 'Female' ); // Added to index 0 position before "-Select-". The sequence will be "Female","-Select-", and "Male". // (Return Example) 0

bind( eventType , function )

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

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

Sample

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

changeChooseOption( newValue , newLabel )

Changes the chooseOption property. (Related Property) chooseOption

Parameter
name	type	required	description
newValue	String	Y	New chooseOption value
newLabel	String	Y	New chooseOption label

Sample

// (Example) Set the value as "0" and the label as "Choose". selectbox1.changeChooseOption("0","Choose");

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> // The class can be changed. (Change the class from tmpInputClass to tmpInputWarninClass.) input1.changeClass("tmpInputClass","tmpInputWarninClass");

deleteItem( idx , refresh )

Deletes the item of the corresponding index. If both the chooseOption and the allOption are true, the -Select- item will be considered being included in index numbering.

Parameter
name	type	required	description
idx	Number	Y	Index of the item to delete
refresh	Boolean	N	Automatically updates the bound DataList (instance). If undefined, the value of the dataListAutoRefresh property will be used.

Return
type	description
JSON	JSON containing information of the deleted item

Sample

// When the chooseOption property and the items are defined as shown below. <xf:select1 id="selectbox1" chooseOption="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> // Delete the item of index 1. var returnValue = selectbox1.deleteItem(1); // Index 0 will be -Select-. The Male item will be deleted. // (Return ) {label: "Male", value: "M"}

focus( )

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

getDataListInfo( )

Returns the dataList bound with the component.

Return
type	description
Object	Returns nodeset, label, and value id as an object.

Sample

// Example selectbox1.getDataListInfo();

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

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. If the chooseOption or allOption is true, -All- or -Select- will be considered as an item and will be also included in item counting.

Return
type	description
Number	Number of the items

Sample

// Set the chooseOption as shown below. <xf:select1 id="selectbox1" chooseOption="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> var returnValue = selectbox1.getItemCount(); // (Return) 3

getNextTabID( )

Returns the nextTabID value. (Related Property) nextTabID

Sample

// Example var nextTabID = selectbox1.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

getSelectedIndex( )

Returns the index of the selected item. If the chooseOption or allOption is true, -All- or -Select- will be considered as an item and will be also included in index numbering.

Return
type	description
Number	Index of the selected item

Sample

// The "chooseOption" is "true" and "Male" item is selected. <xf:select1 id="selectbox1" chooseOption="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> var returnValue = selectbox1.getSelectedIndex(); // (Return Example) 1

getSize( sizeName )

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

Parameter
name	type	required	description
sizeName	String	Y	[height, innerHeight, outerHeight, outerMarginHeight, width, innerWidth, outerWidth, outerMarginWidth] Position type. For the details, see 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( isOriginal )

Returns the index of the currently selected item.

Parameter
name	type	required	description
isOriginal	Boolean	N	[default:true, false] In case of true, returns unformatted original Text. In case of false, the formatted value will be returned.

Return
type	description
String	label of the currently selected item

Sample

// An item of which label "Male" is selected. var returnValue = selectbox1.getText(); // (Return) "Male"

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 ) "Input 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"); // (Reurn) "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( )

Returns the value of the selected item.

Return
type	description
String	Value of the selected item

Sample

// An item of which value "M" is selected. var returnValue = selectbox1.getValue(); // (Return) "M"

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.

removeAll( isInitialize )

[default:false, true] Removes all items. If the chooseOption or allOption is true, the items for which isInitialize is true will not be deleted.

Parameter
name	type	required	description
isInitialize	Boolean	N

Sample

// Remove all items including chooseOption and allOption items. selectbox1.removeAll(); // Remove all items but chooseOption and allOption items. selectbox1.removeAll(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	Setting of the disabled property. (true: Used. false: Not used.)

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. (true: Pause. false: Restart.)

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

setGridItemset( obj )

Dynamically changes the gridViewItemset binding.
Deletes the existing gridViewItemset, and sets a new one.

Parameter
name	type	required	description
obj	JSON\|\|XML	Y	Object containing the gridViewItemset to be newly created. (JSON or XML object only.)

Sample

var obj = { "nodeset" : "data:dataList2", "label" : "col1", "value" : "col2", "width" : 400, "height" : 300, "item" : [{"ref" : "col1", "header" : "label"},{"ref" : "col2", "header" : "value"},{"ref" : "col3", "header" : "dummy"}] }; selectbox1.setGridItemset(obj);

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

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 selectbox1.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 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 selectbox1 to dataList1 of the datacollection, the label to lbl column, and the value to code column. selectbox1.setNodeSet('data:dataList1','lbl','code'); // Change to dataList2 which has same columns with dataList1 but different data. selectbox1.setNodeSet('data:dataList2'); // Existing labels and values are maintained, and only 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	[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( title )

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
title	String	Y	Path of ref

Sample

// Bind the hobby key in dataMap1 with the value of selectbox1. selectbox1.setRef("data:dataMap1.hobby"); // Bind with res/userData/hobby of the InstanceData. selectbox1.setRef("res/userData/hobby");

setSelectedIndex( idx )

Selects the item of the corresponding index. If the chooseOption or allOption is true, -All- or -Select- will be considered as an item and will be also included in index numbering.

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

Sample

// Set the chooseOption as shown below. <xf:select1 id="selectbox1" chooseOption="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> selectbox1.setSelectedIndex(1); // Because the "chooseOption" is "true", the "Male" item will be selected.

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( lbl , isOriginal )

Selects an item of which label is same as the specified lbl value.

Parameter
name	type	required	description
lbl	String	Y	Label of the item
isOriginal	Boolean	N	[default:true, false] Sets the value with the original, an unformatted value. In case of true, a formatted value will be used. In case of false, an unformatted value will be used.

Sample

// The label is "Male". selectbox1.getText('Male');

setTitle( title )

Sets the title of the WebSquare component.

Parameter
name	type	required	description
title	String	Y	Value to set

Sample

// Set the title as "test". selectbox1.setTitle("test");

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 an item which contains the value received as a parameter, and sets the value in the selected item.
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

Return
type	description
Boolean	Setting result

Sample

// The label is "Male" and the value is "M". selectbox1.setValue("M"); // "Male" item will be selected.

setVisibleColumn( columnId , visibleColumnFalseValue )

Dynamically sets the visibleColumn property.
The visibleColumn decides which columns in the DataList to display on the selection item list.
Hides certain items from the selection item list of the SelectBox.
selectedIndex is not affected. The entire list is used.

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. If not se, the existing visibleColumnFalseValue setting will be used.

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	[default: block, inline, none, ""] CSS display setting.

Sample

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

showChooseOption( chooseOption )

Sets the chooseOption.

Parameter
name	type	required	description
chooseOption	boolean	Y	Value

Sample

selectbox1.showChooseOption(true);

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 functios for the onviewchange event of the input1 component. input1.unbind("onviewchange"); // (Example 3) // Remove func1 for the onviewchange event of the input1 component. input1.unbind("onviewchange", func1);

unbindRef( )

Releases the ref binding.

validate( )

Validates the component according to the specified properties.
Validation-related property: mandatory

Sample

// Set chooseOption and mandatory as shown below. <xf:select1 id="selectbox1" chooseOption="true" mandatory="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> // The end user selected nothing. ("-Selected-" item is currently being displayed.) var returnValue = selectbox1.validate(); // (Return Example) false // If the "displaymessage" is "true", the WebSquare5 Engine will alert "Mandatory information" message.

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 chooseOption and mandatory as shown below. <xf:select1 disabledClass="w2selectbox_disabled" appearance="minimal" direction="auto" chooseOption="true" id="selectbox1" style="position: absolute;width:229px;height:66px;left:692px;top:268px;" mandatory="true" chooseOptionLabel="-선택-"> <xf:choices> <xf:itemset nodeset="data:dataList3"> <xf:label ref="label"></xf:label> <xf:value ref="value"></xf:value> </xf:itemset> </xf:choices> </xf:select1> var returnObj = selectbox1.validateObject(); // Return Example - When there is no SelectBox value, returnObj will be returned. returnObj.callerId = "selectbox1" returnObj.type = "mandatory" returnObj.value = "" // Return Example - When there is a SelectBox object, an empty object will be returned. Alerts the defined message upon a validation failure in case the displaymessage is "true". // (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