WebSquare.uiplugin.searchbox

SearchBox. An extended version of the InputBox. "X" icon is displayed to delete the text. Provides same functions with those of the InputBox. "X" icon is displayed only when the text is inputted. (!!!Warning!!!) IE10 and higher-version browsers provides “X” icon in <input> tag in default. In order to prevent double display of "X" icons, do the following: (CSS sample to remove "X" of the browser) (Example 1) input[type=text]::-ms-clear { display: none; } (Example 2) ::-ms-clear { display: none; } At the highest level of this component is the <input> tag.

Type

uiplugin

Property Summary

allowChar: Characters to allow. Implemented by RegExp of JavaScript. Korean/Chinese characters are applied upon blurring.
applyFormat: The application range of the formatted value. In case of all, the value and the displayed value will be the same and the displayed value will be formatted during the input.
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.
dataType: Data type of the component. [default: text, number, date, time, bigDecimal]
dateMask: Value displaying format. Valid when the dataType is date. (Example) yyyy-MM-dd, yyyy.MM.dd
disabled: [default:false, true] Disabled status of the component.
displayFormat: Formats the values same as in Excel file. Depends on the dataType defined in the Engine.
displayFormatter: Name of the function that format the component value.
displaymessage: Displays the result message upon a validation failure by the validation API. [default: false, true]
editType: [default:select, focus] Defines the action to be triggered upon the end user’s clicking the component.
id: Component ID
ignoreChar: Characters to ignore. Implemented in RegExp of JavaScript. Specified Korean/Chinese characters will be ignored upon blurring.
invalidMessage: Message to display upon a failure by the validate API. Valid only in case of displaymessage="true".
invalidMessageFunc: Name of the user-defined function that will generate a message upon a validation failure by the validation API.
mandatory: [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>
maxByteLength: Maximum input length in bytes. The exceeding characters will be automatically cut.
maxlength: Maximum input length. Exceeding characters will be automatically cut.
minByteLength: Checks the minimum byte length upon calling of the validation API.
minlength: Checks the minimum length upon calling of the validation API.
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
onFocusClass: Checks the minimum length upon calling of the validation API.
preventCopyPaste: [default:false, true] Prevents component values from being copied-and-pasted.
readOnly: [default:false, true] Setting of the readOnly property. Functions same as the readOnly of the HTML.
readOnlyClass: Name of the class to apply for readOnly mode.
ref: Value path of the DataCollection. Used with a purpose to bind a DataCollection with a WebSquare component.
refSync: Refreshes the ref as soon as the key of the ref bound with the SearchBox is entered. [default:false, true]
tabIndex: The focusing order by the Tab key.
timeMask: Value displaying format. Valid when the dataType is time. (Example) hh:mm:ss
title: Same as the class property in HTML.
tooltip: Text to be displayed upon the end user’s hovering the mouse over the component.
tooltipLocaleRef: Text key of the tooltip in case the tooltip text is provided in multiple languages.
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property
validator: Name of the validation function

Event Summary

onblur: Triggered upon being unfocused.
onchange: Triggered upon a change in an inputted or selected value. Occurs at the point of focusing-out.
onclick: Triggered upon clicking of the component.
ondblclick: Triggered upon double-clicking of the component.
onfocus: Triggered upon being focused.
onkeydown: Triggered upon the end user's pressing a key on the keyboard.
onkeypress: Triggered upon the end user's pressing a key (and maintaining the key being pressed) on the keyboard.
onkeyup: Triggered upon the end user's releasing a key on the keyboard after pressing the key.
onmousedown: Triggered upon the end user's clicking the mouse.
onmousemove: Triggered upon moving of the mouse pointer.
onmouseout: Triggered upon the mouse focus moving out of a specified area or link.
onmouseover: Triggered upon the mouse moving into a specified area or link.
onmouseup: Triggered upon the end user's unclicking the mouse (after clicking).
onresetclick: Triggered upon clicking of the Reset button of the SearchBox.
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.
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.)
commit( ): When the SearchBox is bound through the ref property, reflects the value displayed on the input box to the ref.
focus( ): Moves the focus to the component.
getDataListInfo( ): Returns the dataList bound with the component.
getDataType( ): Returns the dataType of the component.
getDisabled( ): Returns the current value of the disabled property.
getDisplayFormat( ): Returns the current value of the displayFormat property.
getDisplayFormatter( ): Returns the current function set for the displayFormatter property.
getDisplayValue( ): Returns the currently displayed (formatted) value.
getFormattedValue( ): Returns the formatted value of the SearchBox component.
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.
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.)
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]
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 current value of the component.
hasClass( className ): Checks whether the WebSquare component has a certain class.
hide( ): Hides the WebSquare component. (Supported in all WebSquare components.)
removeClass( className ): Removes a class from the WebSquare component. (Supported in all WebSquare components.)
setDisabled( disabled ): Sets the disabled property of the WebSquare component.
setDisplayFormat( format ): Sets the displayFormat property of the component.
setDisplayFormatter( formatter ): Sets the displayFormatter property of the component.
setEventPause( evList , flag ): Pauses the event.
setInitStyle( property ): Restores the initial style of the WebSquare component.
setOpacity( value ): Sets the opacity in the WebSquare component. (Supported in all WebSquare components.)
setPosition( left , top , mode ): Sets the position (left, top) of the WebSquare component.
setReadOnly( readOnly ): Sets the readOnly proprety of the WebSquare component.
setSize( width , height ): Sets the size (width, height) of the WebSquare component.
setStyle( propertyName , value ): Sets the CSS of the WebSquare component.
setUserData( key , value ): Sets random data in the WebSquare component. (Supported in all WebSquare components.)
setValue( value ): Sets the value of the component.
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.
validate( ): Validates the component according to the specified properties.
visible( flag ): [deprecated]

Property Detail

allowChar: Characters to allow. Implemented by RegExp of JavaScript. Korean/Chinese characters are applied upon blurring.
applyFormat: The application range of the formatted value. In case of all, the value and the displayed value will be the same and the displayed value will be formatted during the input.
For the displayed data, the format will be applied after the input is completed.
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.
dataType: Data type of the component. [default: text, number, date, time, bigDecimal]
Used by other properties such as displayFormat.
dateMask: Value displaying format. Valid when the dataType is date. (Example) yyyy-MM-dd, yyyy.MM.dd
If the user's input sequence is different from the format, ioFormat will be applied.
disabled: [default:false, true] Disable the component.
displayFormat: Formats the values same as in Excel file. Depends on the dataType defined in the Engine.
Cannot be used with the displayFormatter.
(Example) When the dataType is number#,###.#0 means that the comma will be added to every three digits and be of up to two decimal points.
displayFormatter: Name of the function that format the component value.
Formats the value from the Engine, and returns the final value to be displayed.
displaymessage: Displays the result message upon a validation failure by the validation API. [default: false, true]
Default message provided by the Engine is displayed. However, using the invalidMessageFunc property, a separate message can be defined.
editType: [default:focus, select] Defines the action to be triggered upon the end user’s clicking the component.
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
ignoreChar: Characters to ignore. Implemented in RegExp of JavaScript. Specified Korean/Chinese characters will be ignored upon blurring.
invalidMessage: Message to display upon a failure by the validate API. Valid only in case of displaymessage="true".
Cannot be used with the invalidMessageFunc property at the same time.
invalidMessageFunc: Name of the user-defined function that will generate a message upon a validation failure by the validation API.
The displaymessage property must be true. Cannot be used with invalidMessage at the same time.
mandatory: [default:false, true] Mandatory field. The validation function checks mandatory input fields.
maxByteLength: Maximum input length in bytes. The exceeding characters will be automatically cut.
The value of the maxLength or the value of this property whichever is smaller will be applied.
If the byteCheckEncoding is euc-kr in config.xml, one Korean character will be counted as two bytes. In case of utf-8, it will be counted as three bytes.
maxlength: Maximum input length. Exceeding characters will be automatically cut.
The value of the maxByteLength or the value of this property whichever is smaller will be applied.
minByteLength: Checks the minimum byte length upon calling of the validation API.
If the byteCheckEncoding is euc-kr in config.xml, one Korean character will be counted as two bytes. In case of utf-8, it will be counted as three bytes.
minlength: Checks the minimum length upon calling of the validation API.
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
onFocusClass: Name of the class to apply upon onFocus
preventCopyPaste: [default:false, true] Prevents component values from being copied-and-pasted.
readOnly: [default:false, true] Setting of the readOnly property. Functions same as the readOnly of the HTML.
readOnlyClass: Name of the class to apply for readOnly mode.
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.

Specify the XPath of the XML data to interface with the instance data.
refSync: Refreshes the ref as soon as the key of the ref bound with the SearchBox is entered. [default:false, true]
When the SearchBox is bound with a DataMap through the ref property, executing dataMap1.get("key1") in the onkeydown event will return the inputted value.

(Version: Added in 5.0_2.2777B.20170904.121217.)
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
timeMask: Value displaying format. Valid when the dataType is time. (Example) hh:mm:ss
If the user's input sequence is different from the format, ioFormat will be applied.
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: Text to be displayed upon the end user’s hovering the mouse over the component. Provided by WebSquare, and specifies additional information of the component.
tooltipLocaleRef: Text key of the tooltip in case the tooltip text is provided in multiple languages.
When there is no text for the key, "global_undefined" will be displayed on the screen.
userData1: User-defined property. Use getUserData("userData3") to get the data.
userData2: User-defined property. Use getUserData("userData2") to get the data.
userData3: User-defined property. Use getUserData("userData3") to get the data.
validator: Name of the validation function
Runs the specified function upon blurring of the component.
The specified function is executed before the onblur event, and validates upon occurrence of blurring. The developer can change the value through the return.

Event Detail

onblur

Triggered when the focus is lost.

Parameter
name	type	description
e	Object	Event object

onchange

Triggered upon a change in an inputted or selected value. Occurs at the point of focusing-out.
A change made by the script will also trigger a change. Use the onviewchage event to compare old and new values.

onclick

Triggered upon clicking of the component.

Parameter
name	type	description
e	Object	Event object

ondblclick

Triggered upon double-clicking of the component.

Parameter
name	type	description
e	Object	Event object

onfocus

Triggered upon the component being focused.

Parameter
name	type	description
e	Object	Event object

onkeydown

Triggered upon the end user's pressing a key on the keyboard.

Parameter
name	type	description
e	Object	Event object

onkeypress

Triggered upon the end user's pressing a key (and maintaining the key being pressed) on the keyboard.

Parameter
name	type	description
e	Object	Event object

onkeyup

Triggered upon the end user's releasing a key on the keyboard after pressing the key.

Parameter
name	type	description
e	Object	Event object

onmousedown

Triggered upon the end user's clicking the mouse.

Parameter
name	type	description
e	Object	Event object

onmousemove

Triggered upon moving of the mouse pointer.

Parameter
name	type	description
e	Object	Event object

onmouseout

Triggered upon the mouse focus moving out of a specified area or link.

Parameter
name	type	description
e	Object	Event object

onmouseover

Triggered upon the mouse moving into a specified area or link.

Parameter
name	type	description
e	Object	Event object

onmouseup

Triggered upon the end user's unclicking the mouse (after clicking).

Parameter
name	type	description
e	Object	Event object

onresetclick

Triggered upon clicking of the Reset button of the SearchBox.

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 JSON data containing oldValue and newValue.

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

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

commit( )

When the SearchBox is bound through the ref property, reflects the value displayed on the input box to the ref.
Real-time return is not supported. Instead, the end user must use Enter or Tab.

Sample

scwin.searchbox_onkeydown = function(e) { if((e.charCode || e.keyCode) === 13) { searchbox.commit(); // Applies the current input in the SearchBox to dataMap1.key1. If omitted, the previous value before the input in the SearchBox will value returned as key1. dataMap1.get("key1"); } }

focus( )

Moves the focus to the component.

Sample

searchbox1.focus();

getDataListInfo( )

Returns the dataList bound with the component.

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

Sample

// Example searchbox1.getDataListInfo();

getDataType( )

Returns the current value of the dataType. [default:text]

Return
type	description
String	dataType of the SearchBox

Sample

// Define a SearchBox as shown below. <w2:searchbox id="searchbox1" dataType="number" style="position: relative;width: 140px;height: 21px;"></w2:searchbox> var returnValue = searchbox1.getDataType(); // (Return) "number"

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

getDisplayFormat( )

Returns the current value of the displayFormat property.

Return
type	description
String	Current displayFormat

Sample

// The dataType is number and the displayFormat is #,###. var returnValue = searchBox1.getDisplayFormat(); // (Return) "#,###"

getDisplayFormatter( )

Returns the current function set for the displayFormatter property.

Return
type	description
String	Formatter function currently configured for the component

Sample

// displayFormatter="eduObj.fn_numFormat" var returnValue = searchBox1.getDisplayFormatter(); (Return) "eduObj.fn_numFormat"

getDisplayValue( )

Returns the currently displayed (formatted) value.

Return
type	description
String	Formatted value

Sample

// The dataType is number and the displayFormat is "#,###". Input 1000000. var returnValue = searchBox1.getDisplayValue(); // (Return)"1,000,000"

getFormattedValue( )

Returns the currently displayed (formatted) value.

Return
type	description
String	Formatted value

Sample

// The dataType is number and the displayFormat is "#,###". Input 1000000. var returnValue = searchBox1.getFormattedValue(); // (Return)"1,000,000"

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

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

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

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

Returns the current value of the component.

Return
type	description
String	Value of the SearchBox

Sample

// The user inputs WebSquare in the SearchBox. searchBox1.getValue(); // (Return) "WebSquare"

hasClass( className )

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

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

Return
type	description
Boolean	Whether the class exists or not

Sample

hide( )

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

Sample

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

removeClass( className )

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

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

Sample

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

setDisabled( disabled )

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

Parameter
name	type	required	description
disabled	Boolean	Y	Disabled status

Sample

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

setDisplayFormat( format )

Sets the displayFormat property of the component.

Parameter
name	type	required	description
format	String	Y	displayFormat to set

Sample

// Define SearchBox as shown below. <w2:searchbox id="searchbox1" dataType="number" style="position: relative;width: 140px;height: 21px;"></w2:searchbox> // Change to add comma to every three digits and display up to two decimal points. searchBox.setDisplayFormat("#,###.#0"); // For example, the value "1000000" will be displayed as "1,000,000.00".

setDisplayFormatter( formatter )

Sets the displayFormatter property of the component.

Parameter
name	type	required	description
formatter	String	Y	Formatter function to set

Sample

// Define SearchBox as shown below. <w2:searchbox id="searchbox1" style="position: relative;width: 140px;height: 21px;"></w2:searchbox> // Define the format function for the component in the global script as shown below. (The value will be displayed in upper cases.) var commObj = {}; commObj.fn_setUpper = function(value){ value = value.toUpperCase(); return value; }; // Set the displayFormatter. searchbox1.setDisplayFormatter("commObj.fn_setUpper"); // (Display) The inpuuted value "hong gil dong" will be displayed as "HONG GIL DONG".

setEventPause( evList , flag )

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

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

Sample

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

setInitStyle( property )

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

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

Sample

// (Example) group1.setInitStyle();

setOpacity( value )

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

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

Sample

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

setPosition( left , top , mode )

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

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

Sample

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

setReadOnly( readOnly )

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

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

Sample

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

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

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 )

Sets the value of the component.

Parameter
name	type	required	description
value	String	Y	Value to set

Sample

searchBox1.setValue("WebSquare");

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

validate( )

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

Return
type	description
Boolean	Validation result

Sample

// Enable mandatory in the SearchBox. <w2:searchbox id="searchbox1" mandatory="true" style="position: relative;width: 140px;height: 21px;"></w2:searchbox> var returnValue = searchbox1.validate(); // (Return - without input) false // (Return - with input) false // Set displaymessage as true to alert a message defined in the WebSquare5 Engine upon a validation failure. // (Alert Example) This field is mandatory.

visible( flag )

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

Parameter
name	type	required	description
flag	Boolean	Y	CSS visibility setting