WebSquare.uiplugin.group

Group. Layout component. The Group component is for creating layout and can contain other components. The Group component provides functions to initialize values of the contained component and can use methods and functions of the contained components.
HTML div tags are used for the Group component. HTML tags (such as ul, dl, ol, and table) which can have children can be used through the tag names.
The Group component cannot have values. In order to set values, use the Textbox component.
It is recommended to block contained components for easier layout control and UI maintenance.

Type

uiplugin

Property Summary

adaptive: Adaptive web. Changes the layout according to the screen size and the device type.
adaptiveThreshold: A threshold to change the layout in case of tagname="table" with the adaptive setting is enabled.
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.
id: Component ID
localeRef: Key of the language text.
tabIndex: The focusing order by the Tab key.
tagname: Uses other tags than <div> to render the Group component.
text: Value of the component.
tooltip: Text to be displayed upon the end user’s hovering the mouse over the component.
tooltipDisplay: Displays hidden data as a tooltip when the data is not fully displayed.
tooltipFormatter: Name of the user-defined function to format the tooltip contents when the tooltipDisplay is “true”.
tooltipLocaleRef: Text key of the tooltip in case the tooltip text is provided in multiple languages.
tooltipPositionX: Tooltip text to be displayed for tooltipDisplay="true". [default: 20]
tooltipPositionY: Y coordinate of the tooltip when the tooltipDisplay is "true". (Unit: px) [default: height+3]
tooltipTime: Tooltip display time. (Unit: second)
useLocale: Uses multi-language keys of the client to display labels of the selection items in multiple languages.
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property

Event Summary

onblur: Triggered when the focus is lost.
onclick: Triggered upon being clicked.
ondblclick: Triggered upon being double-clicked.
onfocus: Triggered upon the component being focused.
onmousedown: Triggered upon the end user's clicking the mouse.
onmouseenter: Fired upon the mouse pointer moving inside to the Group.
onmouseleave: Fired upon the mouse pointer moving out of the Group.
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).
ontooltiphide: Triggered upon the tooltip being hidden
ontooltipshow: Triggered upon the tooltip showing

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.)
focus( ): Focuses the WebSquare component.
getAttributeNode( attributeName ): Returns the value of the property defined as an HTML attribute.
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.
hasClass( className ): Checks whether the WebSquare component has a certain class.
hide( ): Hides the WebSquare component. (Supported in all WebSquare components.)
init( options ): Initializes the value of the contained component. (Default: ‘ ’)
invoke( funcName , param , options ): Calls a method or a customized function for all contained components.
removeAttributeNode( nodeName ): Removes a child node of the corresponding nodeName from attributes.
removeClass( className ): Removes a class from the WebSquare component. (Supported in all WebSquare components.)
setAttributeNode( nodeName , nodeValue ): Sets a value in the child node of the corresponding node name in attributes node.
setDisabled( disabled ): Applies the disabled property setting to the contained components.
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 ): Applies readOnly to the components contained in the Group.
setSize( width , height ): Sets the size (width, height) of the WebSquare component.
setStyle( propertyName , value ): Sets the CSS of the WebSquare component.
setTitle( title ): Sets the title of the WebSquare component.
setUserData( key , value ): Sets random data in the WebSquare component. (Supported in all WebSquare components.)
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.
visible( flag ): [deprecated]

Property Detail

adaptive: Adaptive web. Changes the layout according to the screen size and the device type.
Supported when the tagname is "table".
Browsers supported: Chrome, Safari, Firefox, Opera, IE10+
adaptiveThreshold: A threshold to change the layout in case of tagname="table" with the adaptive setting is enabled. (The default is 480.)
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.
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
localeRef: Key of the language text.
When there is no text for the key, "global_undefined" will be displayed on the screen.
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
tagname: Uses other tags than <div> to render the Group component.
Define a tag that can have child tags (or elements).
(Remarks: The Group uses the <div> tag in most cases.)
text: Value of the component.
Define the text to set in the Group component.
However, in case there is already a setting value (Edit value), the text will not be used.
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.
tooltipDisplay: Displays hidden data as a tooltip when the data is not fully displayed. [default: false, true]
tooltipFormatter: Name of the user-defined function to format the tooltip contents when the tooltipDisplay is “true”.
The user-defined function receives componentId and label, and returns the string for the tooltip.
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.
tooltipPositionX: Tooltip text to be displayed for tooltipDisplay="true". [default: 20]
The far-left end of the selected element is the origin, and the unit is in pixels.
Supports expressions using the width and the height.
tooltipPositionY: Y coordinate of the tooltip when the tooltipDisplay is "true". (Unit: px) [default: height+3]
The upper-left corner of the selected element is the origin, and the unit is in pixels.
Supports expressions using the width and the height.
Note that the margin-top setting in the component style will affect Y axis.
tooltipTime: Tooltip display time. (Unit: second)
Valid in case of tooltipDisplay="true".
useLocale: Uses multi-language keys of the client to display labels of the selection items in multiple languages.
Valid when the tagName is td or th and when the there is only one child text node.
(For more information, see the user guide.)
userData1: User-defined property. Use getUserData("userData3") to get the data.
userData2: User-defined property. Use getUserData("userData2") to get the data.
userData3: User-defined property. Use getUserData("userData3") to get the data.

Event Detail

onblur

Triggered when the focus is lost.

Parameter
name	type	description
e	Object	Event object

onclick

Triggered upon being clicked.

Parameter
name	type	description
e	Object	Event object

ondblclick

Triggered upon being double-clicked.

Parameter
name	type	description
e	Object	Event object

onfocus

Triggered upon the component being focused.

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

onmouseenter

Fired upon the mouse pointer moving inside to the Group.

Parameter
name	type	description
e	Object	Event object

onmouseleave

Fired upon the mouse pointer moving out of the Group.

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

ontooltiphide

Triggered upon the tooltip being hidden.

ontooltipshow

Triggered upon the tooltip being shown.

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

focus( )

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

getAttributeNode( attributeName )

Returns the value of the property defined as an HTML attribute.
For example, properties such as id, class, or style can be returned, but the tagname property is not returned.

Parameter
name	type	required	description
attributeName	String	Y	Name of the attribute

Sample

// Add an attribute using tagname as shown below. <xf:group id="ui_btnLoginGrp" style="" tagname="a"> <w2:attributes> <w2:href>#</w2:href> </w2:attributes> <xf:image id="ui_btnLoginImg" alt="login" src="/images/btn_login.gif"></xf:image> </xf:group> ui_btnLoginGrp.getAttributeNode("href"); // (Return) "#" ui_btnLoginGrp.getAttributeNode("id"); // (Return) "ui_btnLoginGrp" ui_btnLoginGrp.getAttributeNode("tagname"); // (Return) "#"</div> </dd> <a class="anchor" id="getGenerator"></a> <dt class="apiname">getGenerator( ) </dt> <dd> <div class="pdesc">In case generated by the Generator component, returns the parent Generator object that created the component itself. (Supported in all WebSquare components.)</div>   <table id="ptable"> <caption>Return</caption> <tr> <td class="header1">type</td><td class="header2">description</td> </tr> <tr> <td class="row">Object</td><td class="row">Parent Generator object</td> </tr> </table> <div class="caption_sample">Sample</div> <div class="pdesc"><xmp class='js 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"

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

init( options )

Initializes the value of the contained component. (Default: ‘ ’)
Components that can be initialized: Calendar, Checkbox, GridView, Input, InputCalendar, MultiSelect, Radio, SelectBox, TextArea

Parameter
name	type	required	description
options	Object	N	Object to specify the component not to be initialized

Sample

// Initialize the user-input components contained in group1. group1.init(); // Initialize all components contained in group1 except gridView, radio, and the components of which IDs are input1 and calendar1 respectively, and trigger events upon changes in the values. var options = { excludePlugin : "gridView radio", excludeId : "input1 calendar1", fireEvent : true }; group1.init(options);

invoke( funcName , param , options )

Calls a method or a customized function for all contained components.

Parameter
name	type	required	description
funcName	String	Y	API to call. Name of the API. Or, to use a customized function, define as “assert”.
param	Object	N	Parameter for the API, or customized function
options	JSON	N	Object to specify components not to be affected by function calling.

Sample

group1.invoke("setValue", "WebSquare"); // Same as executing componentId.setValue("WebSquare"); on all contained components. // If there is a component without setValue (for example, grid), an error will be returned. function createValue(obj){ var pluginName = obj.getPluginName(); // Component type var id = obj.getID(); // Component ID ... } var options = { excludePlugin : "grid calendar", excludeId : "radio1" }; group1.invoke("setValue", createValue, options); // Same as executing the below except for the grid and radio1 component under the Group. // componentId.setValue(Return of the user-defined function(createValue); var options = { includePlugin : "grid calendar", includeId : "radio1" }; group1.invoke("setValue", createValue, options); // Same as executing the below only for the grid and radio1 component under the Group. // componentId.setValue(Return of the user-defined function(createValue);

removeAttributeNode( nodeName )

Removes a child node of the corresponding nodeName from attributes.
For the values that can be used as a nodeName, follow the attributes setting in config.xml.

Parameter
name	type	required	description
nodeName	String	Y	Name of the child node to remove

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

setAttributeNode( nodeName , nodeValue )

Sets a value in the child node of the corresponding node name in attributes node.
For the values that can be used as a nodeName, follow the attributes setting in config.xml.

Parameter
name	type	required	description
nodeName	String	Y	Name of the child node to set the value
nodeValue	String	Y	Value to set

setDisabled( disabled )

Applies the disabled property setting to the contained components.

Parameter
name	type	required	description
disabled	Boolean	Y	Disabled status

Sample

// Disable the contained components in the Group. group1.setDisabled(true); // Do not disable the contained components in the Group. group1.setDisabled(false);

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 )

Applies readOnly to the components contained in the Group.

Parameter
name	type	required	description
readOnly	String	Y	Current value of the readOnly property (true \| false)

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

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". group1.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.

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

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