WebSquare.util

WebSquare.util Package

Type

engine

Property Summary

Event Summary

Method Summary

appendingPathComponent( starturl , endurl ): Appends an additional path to the URL path. Handles abnormal functioning depending on whether / exists or not.
clearInterval( key , force ): WebSquare
clearPage( ): Refreshes the browser.
clearTimeout( key , force ): WebSquare
closePopup( id ): Closes the pop-up of the corresponding ID.
createPopup( id , type , popupName , style , useIFrame , modal , srcORurl , srcData , destData , xml ): Creates a pop-up according to the specified properties.
dbltoHexacode( dbl ): Converts the integer into hexa code for RGB.
deleteLocale( url ): Deletes the language pack in the client.
encodeParameter( ): Encrypts the parameter contained in the URI when the encodeParameter option is enabled in the config.xml file.
first( elem ): Returns the first child node of the specified HTML element.
getBoolean( boolstr ): Returns true for "true", or false for "false".
getChildNodeAt( obj , idx ): Returns the child node of the corresponding index in the object.
getChildren( component , options ): Returns child components of a certain component as an array.
getComponentById( id ): Returns the WebSquare5 component of the corresponding ID.
getData( key ): Gets the data of the specified key.
getDate( str ): Removes the slash (/) from the date string.
getDocumentSize( sizeName ): Gets the width of height of the document not including the scroll bar size.
getEventTarget( this ): Returns the information of the component that triggered the corresponding event.
getGlobalFunction( str ): Gets a global function even from inside an object.
getIntervalKeyList( ): WebSquare
getKeyCode( comp , e ): Receives the component object with a key event and the event object, and returns a keyCode or unicode.
getMetaValue( key ): Returns the value corresponding to the meta key defined in the head area.
getNumber( str ): Removes the comma from the string, and returns parseInt/parseFloat result.
getPopup( id ): Returns the pop-up component of the corresponding ID.
getPopupParam( ): Returns the string of xmlDocument parameter of the pop-up.
getPopupWindow( id ): Returns the pop-up window of the corresponding ID.
getStringByteSize( str , ignoreChar ): Returns the byte size of the string.
getSubmissionURL( url ): Reads the submission URL.
getTextNodeValue( element ): Returns the Text node of the HTML element.
getTime( str ): Removes colons from the time string.
getTimeoutKeyList( ): WebSquare
hexacodetoDbl( hexa ): Converts the hexa code into an integer.
isEmptyObject( obj ): If an empty object is received as a parameter, true will be returned. Otherwise, false will be returned.
isHybrid( ): Judges whether the browser is running in the mobile hybrid app or not.
isInteger( num ): Checks whether the number is an integer or not.
isMobile( ): Checks whether the current device is mobile or not.
isNull( value ): Checks whether the entered value is null or not.
isNumber( value ): Checks whether the entered value is numeric data or not.
isOdd( num ): Checks whether the given integer is an odd number or not.
isPopup( ): Checks whether the current window is a pop-up or not. If it is a pop-up, returns true. Otherwise, returns false.
isString( value ): Checks whether the entered value is a string.
js( scriptUrl , callback ): Controls the sequence of loading multiple external scripts.
last( elem ): Returns the last child node of the HTML element.
loadLocale( url ): Loads the language JS file for the client.
multipleDataListDownload( options , infoArr ): Saves the DataList data as an Excel file.
multipleExcelDownload( options , infoArr ): Saves the grid data as an Excel file.
next( elem ): Returns the next node that is not a Text node.
openPopup( url , options , params , target ): Creates a pop-up according to the specified properties.
parent( elem , num ): Returns the node of the parent node as high as the given number in the HTML element.
parseFloat( str , defaultValue ): Calls parseFloat.
parseInt( str , defaultValue ): Calls parseInt.
prev( elem ): Returns the previous node that is not a Text node.
reinitialize( refresh ): Reloads the page without refreshing the browser, or refreshes the browser.
removeData( key ): Removes the data of the corresponding key.
setData( key , data ): Set the data with a certain key.
setDate( str ): Adds / to the date string.
setDisabled( obj ): Disables the objects under the component.
setDocumentLang( lang ): Sets the language code in the HTML tag.
setDomain( domain ): Sets a domain to uspport cross-domainon frames and pop-ups.
setFullView( zoomResolve ): Sets the fullview feature in the current screen.
setInterval( func , options ): Registers a function and regularly executes the function.
setNumber( str ): Converts to a string by adding a comma to the entered number.
setTime( str ): Adds : to the time string.
setTimeout( func , options ): Registers a function and executes the function after time-out.
toHexColor( rgb ): Receives rgb (r, g, b) string and returns the color code in #RRGGBB format.
url( w2xPath , options ): Passes only the w2xPath instead of the entire URL upon a page change.

Property Detail

Event Detail

Method Detail

appendingPathComponent( starturl , endurl )

Appends an additional path to the URL path. Handles abnormal functioning depending on whether / exists or not.
case 1 : "/hoyoon/" + "/inswave.xml" = "/hoyoon/inswave.xml" (Remove / from //.)
case 2 : "/hoyoon" + "/inswave.xml" = "/hoyoon/inswave.xml" (Add.)
case 3 : "/hoyoon/" + "inswave.xml" = "/hoyoon/inswave.xml" (Add.)
case 4 : "/hoyoon" + "inswave.xml" = "/hoyoon/inswave.xml" (Add /.)
degenerating case : If the latter component is followed by :// (an absolute path including the protocol), only the latter part will be returned.

Parameter
name	type	required	description
starturl	String	Y	Starting URL to append
endurl	String	Y	Ending URL to append

Return
type	description
String	Appended URL

clearInterval( key , force )

Clears the execution interval of the function registered by WebSquare.util.setInterval.

Parameter
name	type	required	description
key	String	Y	Value of the key set by options.key of WebSquare.util.setInterval
force	Boolean	N	Whether to execute the function registered by setInterval again or not. The default is false.

Sample

WebSquare.util.clearInterval("timer1");

clearPage( )

Refreshes the browser. Used by the onpageunload event when the browser needs to be initialized in the SPA mode. Add onpageunload event and call this function in the components that have memory leak issue in the SPA mode such as Editor or Chart. WebSquare.util.url(WebSquare.baseURI + "blank.xml", {"spa":true, "forceReload":true}); // Same as calling the function.

Sample

clearTimeout( key , force )

Clears time-out of the function registered by WebSquare.util.setTimer.

Parameter
name	type	required	description
key	String	Y	Value of the key set by options.key of WebSquare.util.setTimer
force	Boolean	N	Whether to execute the setTimer function or not. The default is false.

Sample

WebSquare.util.clearTimeout("timer1");

closePopup( id )

Closes the pop-up of the corresponding ID.

Parameter
name	type	required	description
id	String	Y	Popup ID

Sample

WebSquare.util.closePopup("popup1");

createPopup( id , type , popupName , style , useIFrame , modal , srcORurl , srcData , destData , xml )

Creates a pop-up according to the specified properties.

Parameter
name	type	required	description
id	String	Y	Popup object ID
type	String	N	Popup object type (litewindow, window, browser)
popupName	String	N	Popup object name to be displayed on the popup frame
style	String	N	Popup object style
useIFrame	String	N	true or false.
modal	String	N	true or false.
srcORurl	String	Y	Source to display on the screen.
srcData	String	N	XPath to get from the parent when the pop-up object type is window
destData	String	N	XPath to set in the pop-up when the pop-up object type is window
xml	Array	N	XML document to be applied to the pop-up object

Sample

WebSquare.util.createPopup("popup1", "window", "People Profile", "width:600px;height:350px;top:100px;left:100px;", "true", "true", "WebSquare1.xml", peopleNode, "map", peopleNode);

dbltoHexacode( dbl )

Converts the integer into hexa code for RGB.

Parameter
name	type	required	description
dbl	Number	Y	RGB value in the integer type

Return
type	description
String	Conversion result into hexa code

Sample

WebSquare.util.dbltoHexacode(16777215);

deleteLocale( url )

Deletes the language pack in the client.

Parameter
name	type	required	description
url	String	Y	URL of the multi-language JS file to delete.

encodeParameter( )

Encrypts the parameter contained in the URI when the encodeParameter option is enabled in the config.xml file.

Return
type	description
String	Encrypts the string and returns the encryption result.

first( elem )

Returns the first child node of the specified HTML element.

Parameter
name	type	required	description
elem	Object	Y	The object to check the child nodes

Return
type	description
Object	The first child node of the element

Sample

WebSquare.util.first( xmlDoc);

getBoolean( boolstr )

Returns true for "true", or false for "false".

Parameter
name	type	required	description
boolstr	String	Y	boolean string

Return
type	description
Boolean	true for "ture", and false for "false".

Sample

WebSquare.util.getBoolean("true");

getChildNodeAt( obj , idx )

Returns the child node of the corresponding index in the object.

Parameter
name	type	required	description
obj	Object	Y	Object to check the child nodes
idx	Number	Y	Index of the child node

Return
type	description
Object	Child node of the corresponding index in the object

Sample

WebSquare.util.getChildNodeAt( xmlDoc, 1 );

getChildren( component , options )

Returns child components of a certain component as an array.

Parameter
name	type	required	description
component	Object	N	Parent component. When properties are not specified, the component means the body component.
options	Object	N	Options are as shown below.

Return
type	description
Object	Array of components

Sample

(ex1) WebSquare.util.getChildren(); or WebSquare.util.getChildren(null, {recursive:true}); => Returns all immediate child components of the body. In case of body, recursive option will be ignored. (Due to performance issues, recursive checking of the child nodes is not allowed.) (ex2) WebSquare.util.getChildren (group1, {excludePlugin : "trigger output", recursive : true}); => Returns all except the trigger and the output among the descendants of the group1. (ex3) WebSquare.util.getChildren(group2, {excludePlugin : "trigger input", excludeId : "treeview1_tooltip windowContainer1_tooltip"); => Returns all except the trigger, the input, and the components of which ID is treeview1_tooltip or widnowContainer1_tooltip among the immeidate children of the group1. (ex4) WebSquare.util.getChildren (group1, {includePlugin : "trigger output", recursive : true}); => Returns only trigger and output among all descendants of the group1. (ex5) WebSquare.util.getChildren (group1, {includePlugin : "trigger output", excludePlugin : "trigger"}); => Returns only the output among all descendants of the group1.

getComponentById( id )

Returns the WebSquare5 component of the corresponding ID.

Parameter
name	type	required	description
id	String	Y	ID of the WebSquare5 component

Return
type	description
Object	WebSquare component object

Sample

var output1 = WebSquare.util.getComponentById("output1");

getData( key )

Gets the data of the specified key.

Parameter
name	type	required	description
key	String	Y	Key of the data to get

Return
type	description
Object	Data of the specified key

Sample

var itemList = WebSquare.util.getData("item1").itemList;

getDate( str )

Removes the slash (/) from the date string.

Parameter
name	type	required	description
str	String	Y	Date String

Return
type	description
String	Entered string without /

Sample

var data = WebSquare.util.getDate("2012/01/01"); date : 20120101

getDocumentSize( sizeName )

Gets the width of height of the document not including the scroll bar size.

Parameter
name	type	required	description
sizeName	String	Y	"width" or "height" in string

Return
type	description
Number	Document size

Sample

WebSquare.util.getDocumentSize("width");

getEventTarget( this )

Returns the information of the component that triggered the corresponding event.

Parameter
name	type	required	description
this	Object	Y	this object for the function

Return
type	description
Object	Returns the name, the component ID, and the full ID of the WebSquare component.

Sample

(Example) var info = WebSquare.util.getEventTarget(this); (Returned Info) { "pluginName": "Component name", "id": "component ID" }

getGlobalFunction( str )

Gets a global function even from inside an object. Gets a global function even from inside an object.

Parameter
name	type	required	description
str	String	Y	String indicating the function

Return
type	description
Function	Function to return

Sample

var func = WebSquare.util.getGlobalFunction("obj.formatter");

getIntervalKeyList( )

Returns all keys registered by WebSquare.util.setIntervalKey as an array.

Return
type	description
Object	Keys registered by getIntervalKey

Sample

var IntervalKeyList = WebSquare.util.getIntervalKeyList(); for(var i = 0; i < IntervalKeyList.length; i++) { WebSquare.util.clearInterval(IntervalKeyList[i]); } // Clear all timers.

getKeyCode( comp , e )

Receives the component object with a key event and the event object, and returns a keyCode or unicode.
When a keyCode is generated, the keyCode will be returned as a decimal value. If no keyCode is not generated, the unicode will be returned as a decimal value.

Parameter
name	type	required	description
comp	Object	Y	Component object
e	Event	Y	event object

Return
type	description
Number	Returns the keyCode or uniCode.

Sample

var returnValue = WebSquare.util.getKeyCode(input1,e);
console.log("returnValue="+returnValue);

getMetaValue( key )

Returns the value corresponding to the meta key defined in the head area.

Parameter
name	type	required	description
key	String	Y	Meta data key

getNumber( str )

Removes the comma from the string, and returns parseInt/parseFloat result.

Parameter
name	type	required	description
str	String	Y	Numeric data as a string

Return
type	description
Number	Numeric data converted from the inputted string

Sample

var data = WebSquare.util.getNumber("2,000"); data : 2000

getPopup( id )

Returns the pop-up component of the corresponding ID.

Parameter
name	type	required	description
id	String	Y	Popup ID

Return
type	description
Object	Popup component

Sample

var popObj = WebSquare.util.getPopup("popup1");

getPopupParam( )

Returns the string of xmlDocument parameter of the pop-up.

Return
type	description
String	xmlDocument string

Sample

var dataStr = WebSquare.util.getPopupParam();

getPopupWindow( id )

Returns the pop-up window of the corresponding ID.

Parameter
name	type	required	description
id	String	Y	Popup ID

Return
type	description
Object	Popup window

Sample

var popObj = WebSquare.util.getPopupWindow("popup1");

getStringByteSize( str , ignoreChar )

Returns the byte size of the string.

Parameter
name	type	required	description
str	String	Y	String to get the byte size
ignoreChar	String	N	Characters to ignore in the byte size checking

Return
type	description
Number	byte size

Sample

var data = WebSquare.util.getStringByteSize("websquare"); data : 9

getSubmissionURL( url )

Reads the submission URL. Uses appendingPathComponent.

Parameter
name	type	required	description
url	String	Y	Default URL address

Return
type	description
String	Submission URL

getTextNodeValue( element )

Returns the Text node of the HTML element.

Parameter
name	type	required	description
element	Object	Y	html element

Return
type	description
String	text node string

Sample

WebSquare.util.getTextNodeValue( xmlDoc);

getTime( str )

Removes colons from the time string.

Parameter
name	type	required	description
str	String	Y	Time String

Return
type	description
String	Entered string without ':'

Sample

var data = WebSquare.util.getTime("11:23"); data : 1123

getTimeoutKeyList( )

Returns all keys registered by WebSquare.util.setTimer as an array.

Return
type	description
Object	Keys registered by setTimer

Sample

var timeoutKeyList = WebSquare.util.getTimeoutKeyList(); for(var i = 0; i < timeoutKeyList.length; i++) { WebSquare.util.clearTimeout(timeoutKeyList[i]); } // Clear all timers.

hexacodetoDbl( hexa )

Converts the hexa code into an integer.

Parameter
name	type	required	description
hexa	String	Y	hexa code value

Return
type	description
Number	Conversion result in integer

Sample

WebSquare.util.hexacodetoDbl("A0D39C");

isEmptyObject( obj )

In case an empty object is received as a parameter, true will be returned. Otherwise, false will be returned.

Parameter
name	type	required	description
obj	Object	Y	Object to check whether it is empty or not=

Return
type	description
Boolean	True if it is empty, or false.

Sample

var A = {"x":100}; WebSquare.util.isEmptyObject(A); // false delete A.x; WebSquare.util.isEmptyObject(A); // true WebSquare.util.isEmptyObject(null); // false (An empty object is {}, not null.)

isHybrid( )

Judges whether the browser is running in the mobile hybrid app. Note that the browser is in the general mobile browser app, “false” will be returned.

Return
type	description
Boolean	“true” will be returned in case of the browser being running in the hybrid app. Or, “false” will be returned.

isInteger( num )

Checks whether the number is an integer or not.

Parameter
name	type	required	description
num	String	Y	Number or Number String

Return
type	description
Boolean	True for an integer, or false.

Sample

WebSquare.util.isInteger(10)

isMobile( )

Checks whether the current device is mobile or not. Supported devices include iPhone, iPad, iPodTouch, Android, and Blackberry.

Return
type	description
Boolean	true is returned for mobile devices, or false.

isNull( value )

Checks whether the entered value is null or not.

Parameter
name	type	required	description
value	Obejct	Y	Value to check

Return
type	description
Boolean	True for null, or false.

isNumber( value )

Checks whether the entered value is numeric data or not.

Parameter
name	type	required	description
value	Obejct	Y	Value to check

Return
type	description
Boolean	True for number type, or false.

Sample

var data = WebSquare.util.isNumber("12"); data : false

isOdd( num )

Checks whether the given integer is an odd number or not.

Parameter
name	type	required	description
num	String	Y	Number String

Return
type	description
Boolean	True for an odd number, or false.

Sample

WebSquare.util.isOdd(11);

isPopup( )

Checks whether the current window is a pop-up or not. If it is a pop-up, returns true. Otherwise, returns false.

Return
type	description
boolean	Checks whether the current window is a pop-up or not.

Sample

var ispopup = WebSquare.util.isPopup();

isString( value )

Checks whether the entered value is a string.

Parameter
name	type	required	description
value	Obejct	Y	Value to check

Return
type	description
Boolean	True for the string type, or false.

Sample

var data = WebSquare.util.isString("12"); data : true

js( scriptUrl , callback )

Controls the sequence of loading multiple external scripts. Loads the scripts in parallel, but runs them in a sequential manner. If the last received parameter is a function, execute the function after script loading. (callback)

Parameter
name	type	required	description
scriptUrl	String	Y	javascript url. The parameter count is not fixed. When there are multiple scripts to load, as man script URLs as the script count will be received.
callback	Function	N	If the last received type is a function, the function will be executed after all scripts are executed. A callback function.

Sample

WebSquare.util.js("/common/js/common.js", "/common/js/test1.js", "/common/js/test2.js", function(){alert("all done");} // common.js, test1.js, and test2.js will be loaded in parallel, but they will be executed in the receive order (common.js -> test1.js -> test2.js.) // The callback function will be executed after test2.js is loaded. Then, alert("all done"); will be executed.

last( elem )

Returns the last child node of the HTML element.

Parameter
name	type	required	description
elem	Object	Y	The object to check the child nodes

Return
type	description
Object	Last child node

Sample

WebSquare.util.last(xmlDoc);

loadLocale( url )

Loads the language JS file for the client.

Parameter
name	type	required	description
url	String	Y	URL of the multi-language JS file.

multipleDataListDownload( options , infoArr )

Saves the DataList data as an Excel file. The sheetName must be unique. (Supported for JDK 1.5 and higher versions.)

Parameter
name	type	required	description
options	Object	Y	Downloading options defined in the JSON format. File information Excel file Printing Other options
infoArr	Object	N	Array containing DataList information.

Sample

// There are five columns - a, b, c, d, e - in the DataList. var options = { common: { fileName : "user.xls", showProcess : true, multipleSheet : true, printSet : { landScape : "true", fitToPage : "true", fitWidth : "1", fitHeight : "1", scale : "222" } }, excelInfo: [ { dataListId : "dataList1", sheetName : "First sheet", removeColumns : "1,3", foldColumns : "2", startRowIndex : 3, startColumnIndex : 0, headerColor : "#DBEEF3", bodyColor : "#92CDDC", wframeId : "wframe1", infoArr : [ { rowIndex : 1, colIndex : 3, rowSpan : 1, colSpan : 2, text : "Data Display" , textAlign : "center" } ] }, { dataListId : "dataList2", sheetName : "Second sheet", removeColumns : "1,3", foldColumns : "2", startRowIndex : 3, startColumnIndex : 0, headerColor : "#DBEEF3", bodyColor : "#92CDDC", wframeId : "wframe1", infoArr : [ { rowIndex : 1, colIndex : 3, rowSpan : 1, colSpan : 2, text : "Data Display" , textAlign : "center" } ] } ] }; WebSquare.util.multipleDataListDownload( options ); (First sheet) A || C D E F ┌──────────────┐┌──────────┬──────┬──────┬──── 1 | || | | | | || ┌──────┴──────┐ 2 | || | Data Display | | || └──────┬──────┘ 3 | || | | | 4 | a || e | | | -> Grid Header. 5 | Renaissance || 20111231 | | | -> Grid Data. 6 | ... (Omitted.) (Second sheet) A || C D E F ┌──────────────┐┌──────────┬──────┬──────┬──── 1 | || | | | | || ┌──────┴──────┐ 2 | || | Data Display | | || └──────┬──────┘ 3 | || | | | 4 | a || e | | | -> Grid Header. 5 | Renaissance || 20111231 | | | -> Grid Data. 6 | ... (Omitted)

multipleExcelDownload( options , infoArr )

Saves the grid data as an Excel file. The sheetName must be unique. (Supported for JDK 1.5 and higher versions.)

Parameter
name	type	required	description
options	Object	Y	Downloading options for the grid data (stored in JSON format) as an Excel file File information Excel file Printing Other options
infoArr	Object	N	An array of GridView information to show it in another cell

Sample

// Grid with five columns with IDs of a, b, c, d, and e. var options = { common: { fileName : "user.xls", showProcess : true, multipleSheet : true, printSet : { landScape : "true", fitToPage : "true", fitWidth : "1", fitHeight : "1", scale : "222" } }, excelInfo: [ { gridId : "grid1", sheetName : "First sheet", type : "1", removeColumns : "1,3", foldColumns : "2", startRowIndex : 3, startColumnIndex : 0, headerColor : "#DBEEF3", bodyColor : "#92CDDC", dataProvider : "com.provider.Provider1", providerRequestXml : "<info><key value='TEST'/><info>", infoArr : [ { rowIndex : 1, colIndex : 3, rowSpan : 1, colSpan : 2, text : "Data Display" , textAlign : "center" } ] }, { gridId : "grid2", sheetName : "Second sheet", type : "1", removeColumns : "1,3", foldColumns : "2", startRowIndex : 3, startColumnIndex : 0, headerColor : "#DBEEF3", bodyColor : "#92CDDC", dataProvider : "com.provider.Provider1", providerRequestXml : "<info><key value='TEST'/><info>", infoArr : [ { rowIndex : 1, colIndex : 3, rowSpan : 1, colSpan : 2, text : "Data Display" , textAlign : "center" } ] } ] }; WebSquare.util.multipleExcelDownload( options ); (First sheet) A || C D E F ┌──────────────┐┌──────────┬──────┬──────┬──── 1 | || | | | | || ┌──────┴──────┐ 2 | || | Data Display | | || └──────┬──────┘ 3 | || | | | 4 | a || e | | | -> Grid Header. 5 | Renaissance || 20111231 | | | -> Grid Data. 6 | ... (Omitted.) (Second sheet) A || C D E F ┌──────────────┐┌──────────┬──────┬──────┬──── 1 | || | | | | || ┌──────┴──────┐ 2 | || | Data Display | | || └──────┬──────┘ 3 | || | | | 4 | a || e | | | -> Grid Header. 5 | Renaissance || 20111231 | | | -> Grid Data. 6 | ... (Omitted)

next( elem )

Returns the next node that is not a Text node.

Parameter
name	type	required	description
elem	Object	Y	Object to check the next node

Return
type	description
Object	Next node

Sample

WebSquare.util.next(xmlDoc);

openPopup( url , options , params , target )

Opens a pop-up of the corresponding property. Functions same as createPopup although using different properties.

Parameter
name	type	required	description
url	String	Y	Pop-up window URL
options	Object	Y	Popup options. (width, height, etc.)
params	Object	N	Parameter to send to the popup
target	Object	N	window object. The default is window.

Sample

requires("uiplugin.popup"); // Must be added to create a popup. // Define data to pass to the new popup (through dataObject.) // Define the actual data to pass. var rowJSON = { "Personal Info" : { "Name": "Lee", "Age": 50, "Married" : false}, "Region": "Seoul", "Carrier": true }; var dataObject = { "type" : "json", // Data type. "json" is recommended. "name" : "paramTest", // Key to get the data. The newly created popup can access the passed data through $p.getParameter( "paramTest" ). "data" : rowJSON // Actual data to pass. }; // Popup creation options. var options = { id : "popup1", type : "wframePopup", width: "230px", height: "250px", top: "130px", left: "200px", popupName : "testPopup", modal : true, resizable : true, status : true, menubar : false, scrollbars : false, title : false, dataObject : dataObject }; // Create a popup. WebSquare.util.openPopup("/ComponentTest/innerPopup1.xml", options ); // (Example) The new popup accesses the passed data. // // var paramData = $p.getParameter("paramTest"); // var data = JSON.stringify(paramData); // alert(data); //

parent( elem , num )

Returns the node of the parent node as high as the given number in the HTML element.

Parameter
name	type	required	description
elem	Object	Y	Object to check the parent node
num	Number	N	Number of the times to check the parent nodes

Return
type	description
Object	Parent node

Sample

WebSquare.util.parent( xmlDoc, 1)

parseFloat( str , defaultValue )

Calls parseFloat. defaultValue will be given. If the result is NaN, the defaultValue will be returned.

Parameter
name	type	required	description
str	String	Y	Number string
defaultValue	Number	N	The default value to return when the result is NaN.

Return
type	description
Number	Numeric value converted from the string

Sample

var data = WebSquare.util.parseFloat(num, 0);

parseInt( str , defaultValue )

Calls parseInt. defaultValue will be given. If the result is NaN, the defaultValue will be returned.

Parameter
name	type	required	description
str	String	Y	Number string
defaultValue	Number	N	The default value to return when the result is NaN.

Return
type	description
Number	Numeric value converted from the string

Sample

var data = WebSquare.util.parseInt(num, 0);

prev( elem )

Returns the previous node that is not a Text node.

Parameter
name	type	required	description
elem	Object	Y	Object to check the previous nodes

Return
type	description
Object	Previous node

Sample

WebSquare.util.prev( xmlDoc);

reinitialize( refresh )

Reloads the page without refreshing the browser, or refreshes the browser.

Parameter
name	type	required	description
refresh	Boolean	N	Whether to refresh the browser or not. (The defatul is false.)

Sample

Load the page without refreshing the browser.
WebSquare.util.reinitialize(true); // Refreshes the browser.

removeData( key )

Removes the data of the corresponding key. The lower objects of the data will be removed.

Parameter
name	type	required	description
key	String	Y	Key of the data to delete

Return
type	description
Object	Data of the specified key

Sample

var itemList = WebSquare.util.getData("item1").itemList;

setData( key , data )

Set the data with a certain key.
The data will be registered as a global variable of WebSquare5.
In the SPA mode, both the key and the data will be automatically cleared.

Parameter
name	type	required	description
key	String	Y	Value of the key to control the registered data
data	Object	Y	Data to register

Sample

window["common"] = {}; common.itemList = []; common.func = function(){}; WebSquare.util.setData("item1", common);

setDate( str )

Adds / to the date string.

Parameter
name	type	required	description
str	String	Y	Date String

Return
type	description
String	Entered string with '/' added.

Sample

var data = WebSquare.util.setDate ("20120101"); data : 2012/01/01

setDisabled( obj )

Disables the objects under the component.

Parameter
name	type	required	description
obj	Object	Y	disabled parameter

Return
type	description
Object	object

Sample

WebSquare.util.setDisabled({"componentId":"", "disabled":true}); // All disabled. WebSquare.util.setDisabled({"componentId":"", "disabled":false}); // All enabled. WebSquare.util.setDisabled({"componentId":"", "disabled":true, "excludeIdList": ["output10"]}); // All but output10 disabled. WebSquare.util.setDisabled({"componentId":"", "disabled":true, "includeIdList": ["output1","output2"]}); // Only output1 and output2 disabled.

setDocumentLang( lang )

Sets the language code in the HTML tag.

Parameter
name	type	required	description
lang	String	Y	Language code. (Example) xml:lang="ko"

Sample

WebSquare.util.setDocumentLang("ko");

setDomain( domain )

Sets a domain to support cross-domain on frames and pop-ups.

Parameter
name	type	required	description
domain	String	Y	Common domain

setFullView( zoomResolve )

Sets the fullview feature in the current screen. fullview is to control the zoom feature by calculating the ratio between the reference width/height and the browser width/height.

Parameter
name	type	required	description
zoomResolve	Function	Y	Returns an object containing baseWidth and baseHeight, or a zoom value.

Sample

scwin.zoomResolve = function() { var width = window.innerWidth || document.body.clientWidth; var height = window.innerHeight || document.body.clientHeight; var ratio = height / width; var baseRatio = 0.5625; // In case of 16:9, the ratio between the width and the height is 0.5625. if(ratio > baseRatio) { wrapper.addClass("hideWidget"); return {"baseWidth" : 1440, "baseHeight" : 979}; } else { wrapper.removeClass("hideWidget"); return {"baseWidth" : 1920, "baseHeight" : 979}; } } WebSquare.util.setFullView(zoomResolve);

setInterval( func , options )

Registers a function and regularly executes the function. Upon the end user's changing pages in the SPA mode, the timer registered by setInterval will be cleared.

Parameter
name	type	required	description
func	Function	Y	Function to execute
options	Object	N	Options are as shown below.

Sample

WebSquare.util.setInterval("function(){alert(this.id);}", {caller:grid1, delay:2000, key:"interval1"});

setNumber( str )

Converts to a string by adding a comma to the entered number.

Parameter
name	type	required	description
str	String	Y	Number string

Return
type	description
String	Entered string with commas

Sample

var data = WebSquare.util.setNumber ( 1234652 ); data : 1,234,652

setTime( str )

Adds : to the time string.

Parameter
name	type	required	description
str	String	Y	Time String

Return
type	description
String	Entered string with ':' added.

Sample

var data = WebSquare.util.setTime ("1123"); data : 11:23

setTimeout( func , options )

Registers a function and executes the function after time-out. Upon the end user's changing pages in the SPA mode, the timer added by this function will be cleared.

Parameter
name	type	required	description
func	Function	Y	Function to execute
options	Object	N	Options are as shown below.

Sample

WebSquare.util.setTimeout(function(){alert(this.id);}, {caller:grid1, delay:200, key:timer1});

toHexColor( rgb )

Receives rgb (r, g, b) string and returns the color code in #RRGGBB format.

Parameter
name	type	required	description
rgb	String	Y	rgb (r, g, b) string

Return
type	description
String	Color code in #RRGGBB format

Sample

WebSquare.util.toHexColor("rgb(17,59,158)");

url( w2xPath , options )

Passes only the w2xPath instead of the entire URL upon a page change.
Add additional arguments in the options to use the SPA mode.

Parameter
name	type	required	description
w2xPath	String	Y	XML file path
options	Object	N	Options are as shown below.

Sample