WebSquare.uiplugin.submit

Creates a Submit component and provides options to support various features.

Type

uiplugin

Property Summary

anchorWithGroupClass: Applies the w2group class when the type is anchor.
centerOffImageClass: Center image class upon trigger mouse-out
centerOffImageClass: Valid only when the type is image. Define the name of the class to apply to the center td upon the mouse hovering off.
centerOnImageClass: Class of the center image upon the mouse moving hovering over the trigger
centerOnImageClass: Valid when the type is image. Define the class to be applied to the center td upon mouse-over.
class: Class property of submit
class: Provides a similar feature to the class in HTML. One or more classes defined in the CSS file or the style block can be used.
disabled: Disabled status of the component
disabled: [default:false, true] Disabled status of the component.
id: Component ID
id: Component ID
leftOffImageClass: Left image class upon trigger mouse-out
leftOffImageClass: Valid only when the type is image. Define the name of the class to apply to the left td upon the mouse hovering off.
leftOnImageClass: Class of the left image upon the mouse hovering over the trigger
leftOnImageClass: Valid when the type is image. Define the class name on the left td upon mouse-over.
localeRef: Defines the key of the text to be displayed on the WebSquare5 client when the multi-language feature is enabled.
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
rightOffImageClass: Class of the right image upon the mouse moving out of the trigger
rightOffImageClass: Valid when the type is image. Define the class to be applied to the right td.
rightOnImageClass: Right image class upon trigger mouse-over
rightOnImageClass: Valid when the type is image. Define the class to be applied to the right td.
submission: submission ID
submitType: Transmission type in submission
syncMsg: Message for synchronous transmission
tabIndex: The focusing order by the Tab key.
tabIndex: The focusing order by the Tab key.
title: Same as the class property in HTML.
toolTip: Displays the tooltip.
toolTip: Tooltip provided by WebSquare5. Displays additional information of the component.
type: Component type
type: [default:button, image, anchor] rigger-displaying type. For the HTML of each type, see the below.
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property

Event Summary

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.
getBackgroundImage( ): Returns the background-image defined in the CSS when the type is button.
getDisabled( ): Returns the current value of the disabled property.
getGenerator( ): In case generated by the Generator component, returns the parent Generator object that created the component itself.
getID( ): Returns the ID of the WebSquare component.
getInitStyle( CSS ): Returns the initial style of the WebSquare component.
getLabel( ): Returns the label of the 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.
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, height) of the WebSquare component.
getStyle( propertyName ): Returns the CSS setting of the WebSquare component.
getStyleValue( style ): [deprecated]
getSubmission( ): Returns the actual object of the submission defined as the submission property of the Submit component.
getTitle( ): Returns the title of the WebSquare component.
getType( ): Returns the current type of the 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 label of the displayed 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.)
setBackgroundImage( imgUrl ): Sets the background image when the type is button.
setDisabled( disabled ): Sets the disabled property of the WebSquare component.
setEventPause( evList , flag ): Pauses the event.
setInitStyle( property ): Restores the initial style of the WebSquare component.
setLabel( lable ): Sets the label (value).
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.
setSubmission( submission ): Sets the submission for the Submit component.
setTitle( title ): Sets the title of the WebSquare component.
setUserData( key , value ): Sets random data in the WebSquare component.
setValue( lable ): Sets the label (value).
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

anchorWithGroupClass: Applies the w2group class when the type is anchor.
true: Apply.
false (Default): Does not apply.
centerOffImageClass: Center image class upon trigger mouse-out
centerOffImageClass: Valid only when the type is image. Define the name of the class to apply to the center td upon the mouse hovering off.
Specify the image url in the left and the right classes. In most cases, width can be omitted.
(Example) .tmpBtnCenter{ background-image: url(/img/btn_c.png); }
centerOnImageClass: Class of the center image upon the mouse moving hovering over the trigger
centerOnImageClass: Valid when the type is image. Define the class to be applied to the center td upon mouse-over.
Specify the image url in the left and the right classes. In most cases, width can be omitted.
(Example) .tmpBtnCenterOn{ background-image: url(/img/btn_c_on.png); }
class: Class property of submit
class: Provides a similar feature to the class in HTML. One or more classes defined in the CSS file or the style block can be used.
The WebSquare5 Engine has a dedicated class to each component. Using the class of the component, the developer can apply a common CSS.
disabled: Disable the component.
disabled: [default:false, true] Disable the component.
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
leftOffImageClass: Left image class upon trigger mouse-out
leftOffImageClass: Valid only when the type is image. Define the name of the class to apply to the left td upon the mouse hovering off.
Specify the image url and thd width in the class. (When not giving width to the center td.)
(Example) .tmpBtnLeft{ background-image: url(/img/btn_l.png); width:10px; }
leftOnImageClass: Class of the left image upon the mouse hovering over the trigger
leftOnImageClass: Valid when the type is image. Define the class name on the left td upon mouse-over.
Specify the image url and thd width in the class. (When not giving width to the center td.)
(Example) .tmpBtnLeftOn{ background-image: url(/img/btn_l_on.png); }
localeRef: Defines the key of the text to be displayed on the WebSquare5 client when the multi-language feature is enabled.
>In case multi-language setting is incorrect or is not of the defined key, "global undefined" will be displayed.
nextTabID: The ID of the component to be selected upon the end user’s pressing the Tab key.
rightOffImageClass: Class of the right image upon the mouse moving out of the trigger
rightOffImageClass: Valid when the type is image. Define the class to be applied to the right td.
Specify the image url and thd width in the class. (When not giving width to the center td.)
(Example) .tmpBtnRight{ background-image: url(/img/btn_r.png); width:10px; }
rightOnImageClass: Right image class upon trigger mouse-over
rightOnImageClass: Valid when the type is image. Define the class to be applied to the right td.
Specify the image url and thd width in the class. (When not giving width to the center td.)
(Example) .tmpBtnRightOn{ background-image: url(/img/btn_r.png); width:10px; }
submission: submission ID
submitType: Transmission type in submission
syncMsg: Message for synchronous transmission
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
title: Same as the title property in HTML. The title is displayed upon the end user’s moving the mouse over the component. Generally used to support web accessibility.
toolTip: Displays the tooltip.
toolTip: Tooltip provided by WebSquare5. Displays additional information of the component. Displayed upon mouse-over.
type: Component type
type: [default:button, image, anchor] rigger-displaying type. For the HTML of each type, see the below.
button : Uses HTML input tag. The type property is defined as button.
image : Uses the highest-level table tag. Class is applicable to left, center, and right. (See the properties starting with center, left, and right.)
anchor : Uses the highest-level anchor tag. The button text is in the span tag.
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

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

focus( )

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

getBackgroundImage( )

Returns the background-image defined in the CSS when the type is button.

Return
type	description
String	Current background-image

Sample

// A background-image is defined as shown below. <xf:trigger type="button" id="trigger1" style="position:relative;width:80px;height:23px;background-image: url(/img/book1.jpg);"> <xf:label><![CDATA[click]]></xf:label> </xf:trigger> var returnValue = trigger1.getBackgroundImage(); // (Return) "url(http://localhost:9999/img/book1.jpg)"

getDisabled( )

Returns the current value of the disabled property. (Supported in all WebSquare components.)

Return
type	description
Boolean	Value of the disabled property

Sample

// (Example) Check the current value of the disabled property. var returnValue = componentId.getDisabled(); // (Return) false

getGenerator( )

In case generated by the Generator component, returns the parent Generator object that created the component itself. (Supported in all WebSquare components.)

Return
type	description
Object	Parent Generator object

Sample

// (Example) The Generator (parent) create a Trigger (child). <w2:generator id="generator1"> <w2:trigger id="trigger1" ev:onclick="scwin.trigger1_onclick"></w2:trigger></w2:generator> // In the example below, upon the end user’s clicking the Trigger 1, the generator1 object will be displayed on the console. scwin.trigger1.onclick = function(){ console.log(this.getGenerator());}

getID( )

Returns the ID of the WebSquare component. (Supported in all WebSquare components.)

Return
type	description
String	WebSquare component ID

Sample

// Upon dynamically receiving a WebSquare component, the ID can be checked as shown below. function fn_validCheck(tmpObj){ var compID = tmpObj.getID(); } // If the tmpObj in the above example has "input1" ID. // (Return) "input1"

getInitStyle( CSS )

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

Parameter
name	type	required	description
CSS	String	N	Property (If not specified, all properties will be displayed.)

getLabel( )

Returns the label of the component. Functions same as getValue.

Return
type	description
String	label

Sample

// Define the label of trigger1 as shown below. <xf:trigger type="button" id="trigger1" style="position:relative;width:80px;height:23px;"> <xf:label><![CDATA[click]]></xf:label> </xf:trigger> var returnValue = trigger1.getLabel(); // (Return) "click"

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, height) of the WebSquare component. (Supported in all WebSquare components.) If set in %, the value will be converted into pixels.

Parameter
name	type	required	description
sizeName	String	Y	[height, innerHeight, outerHeight, outerMarginHeight, width, innerWidth, outerWidth, outerMarginWidth] Position type. For the details, see below.

Return
type	description
Number	Size of the component

Sample

var returnValue = componentId.getSize("width"); // (Return Example) 100 // Values are in pixels. // If set in %, values will be converted into pixels.

getStyle( propertyName )

Returns the CSS setting of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
propertyName	String	Y	CSS property to return

Return
type	description
String	CSS value

Sample

// Define an Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;"></xf:input> // (Example) Check the width of the InputBox above. var returnValue = input1.getStyle("width"); // (Return) "144px"

getStyleValue( style )

[deprecated]
Use getStyle instead.
Returns the current CSS applied to the WebSquare component.

Parameter
name	type	required	description
style	String	Y	CSS property to return

Return
type	description
String	CSS value (Colors are returned in HexCode.)

getSubmission( )

Returns the actual object of the submission defined as the submission property of the Submit component.
For example, let's assume there is a submission object of which ID is submission1 in the model part in the XML file.
If the submission property of the Submit object is submission1,
getSubmission() method will return an internal object created through the parsing of the submission tags of which ID is submission1.

Return
type	description
Object	Submission object of the Submit component

getTitle( )

Returns the title of the WebSquare component. (Supported in all WebSquare components.)

Return
type	description
String	Title

Sample

// In the following example, the Title is “Input Name”. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); // (Return Example ) "Input Name"

getType( )

Returns the current type of the component.

Return
type	description
String	Current value of the type property

Sample

If the "type" property of the Trigger component is "button", trigger1.getType() will return button. In case of image, trigger1.getType() will return image.

getUdcHome( )

Returns the path of the UDC file including the file name in which the UDC object is defined. (Supported in all WebSquare components.)
The file name includes .xml. In order to get the file path without .xml, use getUdcRoot.
When called by a WebSquare component, not a UDC object, “undefined” will be returned.

Return
type	description
String	UDC file path (For others than the UDC, undefined will be returned.)

Sample

// Example // UDC file path is /a/b/udc.xml. // Page XML is /a/c/main.xml. // UDC ID is udc1. udc1.getUdcHome(); // (Result) /a/b/udc.xml

getUdcRoot( )

Returns the path of the UDC file in which the UDC object is defined. (Supported in all WebSquare components.)
Not contains the file name. In order to get a path including the file name, use getUdcHome.
When called by a WebSquare component, not a UDC object, “undefined” will be returned.

Return
type	description
String	UDC file path (For others than the UDC, undefined will be returned.)

Sample

// Example // UDC file path is /a/b/udc.xml. // Page XML is /a/c/main.xml. // UDC ID is udc1. udc1.getUdcHome(); // (Execution Result) /a/b/

getUserData( key )

Returns the value set by setUserData or directly defined by the user in the XML file. (Supported in all WebSquare components.)

Parameter
name	type	required	description
key	String	Y	Data key

Return
type	description
String	Value for the given key

Sample

// (Example) Setting the user property (setTest) in the InputBox <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" setTest="Hello"></xf:input> // Returns the value of the setTest property. input1.getUserData("setTest"); // (Reurn) "Hello" // Set 'valueTest' (key) and 'WebSquare' (data) through setUserData. input1.setUserData("valueTest","WebSquare"); // Returns the value of the setTest property. input1.getUserData("WebSquare"); // (Return) "WebSquare"

getValue( )

Returns the label of the displayed component. Functions same as getLabel.

Return
type	description
String	label

Sample

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

setBackgroundImage( imgUrl )

Sets the background image when the type is button.
The specified value will be used as the background-image in the CSS.

Parameter
name	type	required	description
imgUrl	String	Y	Image URL

Sample

trigger1.setBackgroundImage('/img/btn_book1.jpg');

setDisabled( disabled )

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

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

Sample

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

setEventPause( evList , flag )

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

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

Sample

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

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

setLabel( lable )

Sets the label (value). Functions same as setValue.

Parameter
name	type	required	description
lable	String	Y	Text to display

Sample

trigger1.setLabel('search'); // (Display) "search" will be displed on the trigger.

setOpacity( value )

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

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

Sample

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

setPosition( left , top , mode )

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

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

Sample

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

setReadOnly( readOnly )

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

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

Sample

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

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

setSubmission( submission )

Sets the submission for the Submit component.
Sets the submission for the Submit component. When the submission id is given, sets the submission of the corresponding submission ID in the Submit component.

Parameter
name	type	required	description
submission	String	Y	Submission ID of the Submit object

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". trigger1.setTitle("test");

setUserData( key , value )

Sets random data in the WebSquare component. (Supported in all WebSquare components.) Enter key values supported by the component. In case a key value not supported by the component is entered, corresponding logs will be displayed.

Parameter
name	type	required	description
key	String	Y	Data key to set
value	String	Y	Defined data value

Sample

// Set 'data' key and 'WebSquare' value in the component. componentId.setUserData("data", "WebSquare"); // The key must be supported in the component. componentId.setUserData("title", "WebSquare"); // Following logs will be displayed. // !!!WARNING - [title] can't be defined as UserData.

setValue( lable )

Sets the label (value). Functions same as setLabel.

Parameter
name	type	required	description
lable	String	Y	Text to display

Sample

trigger1.setValue('search'); // (Display) "search" will be displed on the trigger.

show( displayType )

Shows the WebSquare component on the page. (Supported in all WebSquare components.)
Sets the display property as specified and applies "visibility: show;" CSS.

Parameter
name	type	required	description
displayType	String	N	[default: block, inline, none, ""] CSS display setting.

Sample

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

toggleClass( className )

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

Parameter
name	type	required	description
className	String	Y	Class to add or remove

Sample

// The class is directly defined in the inputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following in config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.toggleClass("tmpInputClass"); // Add the (previously removed) tmpInputClass. input1.toggleClass("tmpInputClass");

trigger( type , array )

Triggers a certain event in the component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
type	String	Y	Event to trigger
array	Array	N	Array of parameters to send to the event handler

Sample

// (Example 1) // Trigger the onclick event in input1 component. input1.trigger("onclick"); // (Example 2) // Trigger the onviewchange event in input1, and send (1, 2) parameter to the handler function. input1.trigger("onviewchange", [1,2]);

unbind( type , function )

Removes the event from the component. (Supported in all WebSquare component.)

Parameter
name	type	required	description
type	String	N	Event to remove. (If not specified, all events of the component will be removed.)
function	Function	N	Handler function of the event to remove. (If not specified, all handler functions of the event will be removed.)

Sample

// (Example 1) // Remove all events registered in the input1 component. input1.unbind(); // (Example 2) // Remove all handler functios for the onviewchange event of the input1 component. input1.unbind("onviewchange"); // (Example 3) // Remove func1 for the onviewchange event of the input1 component. input1.unbind("onviewchange", func1);

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