WebSquare.uiplugin.repeat

Repeat. Repeats creation of components. Generates component templates as many as specified.
Renders Group containing repeated components under the Repeat. Set the Group position as relative.
Components not supported: Chart, Grid, Menu, Switch, TabContainer, Treeview, WindowContainer
Note that the Generator is recommended in most cases where repeated creation of web UI is required.

Type

uiplugin

Property Summary

autoCount: Sets the repeatKey in the repeated node.
class: Same as the class property in HTML.
cols: Number of the repeated columns
direction: Repetition direction of the node when the node is repeated in a form of a two-dimensional array
id: Component ID
nodeset: XPath of the node to repeat
repeatKey: Saves the value of the node.
rows: Number of the repeated rows
tabIndex: The focusing order by the Tab key.
tooltip: Text to be displayed upon the end user’s hovering the mouse over the component.
tooltipLocaleRef: Text key for the tooltip in case the tooltip text is provided in multiple languages.
userData1: User-defined property.
userData2: User-defined property.
userData3: User-defined property.

Event Summary

onrepeatdone: Triggered after an update is made by the instance when the component is bound with the ref.

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.
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.
getInstanceValue( ): Returns the instance nodeValue that the component currently uses.
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.
getRepeat( ): Returns the Repeat component object repeating the current component.
getRepeatChildren( originalId ): Returns the child object of the repeated components.
getRepeatIndex( ): Returns the index of the repeated node to which the current component belongs.
getRepeatInstanceNode( ): Returns the instance node to which the repetition node of the current component uses.
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.)
getSibling( originalID ): Returns a component object in the repetition node where the current component exists.
getSiblingId( originalID ): Returns the ID of the component which exists in the same repetition node where the current component exists.
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 components in the Group.
invoke( funcName , param , options ): Invokes a certain function in all sub components.
refreshRepeat( ): Updates the component with an instance when the component is bound by ref.
removeClass( className ): Removes a class from the WebSquare component. (Supported in all WebSquare components.)
setDisabled( disabled ): Sets the disabled property of the WebSquare component.
setEventPause( evList , flag ): Pauses the event.
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.)
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

autoCount: Sets the repeatKey in the repeated node.
The repeatKey increases by 1 from the first node.
(In case there is no repeatKey, autoCount="true" will automatically set.)
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.
cols: Number of the repeated columns
direction: Repetition direction of the node when the node is repeated in a form of a two-dimensional array
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
nodeset: XPath of the node to repeat
repeatKey: Saves the value of the node.
rows: Number of the repeated rows
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
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 for 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("userData3") to get the data.
userData3: User-defined property.
Use getUserData("userData3") to get the data.

Event Detail

onrepeatdone: Triggered after an update is made by the instance when the component is bound with the ref.

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

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

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

getInstanceValue( )

Returns the instance nodeValue that the component currently uses.

Return
type	description
String	Instance nodeValue that the component currently refers to

Sample

// (Example) Used by the click event of output1 under Repeat. var returnValue = this.getInstanceValue(); // Upon clicking of the first output1, the data referred to by the component output1 will be returned.

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

getRepeat( )

Returns the Repeat component object repeating the current component.
In most cases, not used. Functions as a connection between a lower Repeat component and a higher Repeat component.
Not used if there is a single Repeat component.

Return
type	description
Object	Returns the Repeat component object repeating the current component.

Sample

// (Example) Used by the click event of output1 under Repeat. var returnObj = this.getRepeat(); // Click the first output1 component. Then, a Repeat object including output1 will be returned.

getRepeatChildren( originalId )

Returns the child object of the repeated components.

Parameter
name	type	required	description
originalId	String	Y	Original ID of the component repeated in the Repeat component.

Return
type	description
Object	Array of the repeated components created with originalId

Sample

// Under Repeat is output1 and the repetition count is 3. // (The first is test1, the second test2, and the third test3.) var returnArr = repeat1.getRepeatChildren('output1'); // returnArr.length is 3, and returnArr[0].getValue() is test1.

getRepeatIndex( )

Returns the index of the repeated node to which the current component belongs.

Return
type	description
String	Index of the repeated node to which the current component belongs

Sample

// (Example) Used by the click event of output1 under Repeat. var returnValue = this.getRepeatIndex(); // Click the first output1 component. 0 will be returned.

getRepeatInstanceNode( )

Returns the instance node to which the repetition node of the current component uses.

Return
type	description
XML Element	Instance node to which the repetition node of the current component refers

Sample

// (Example) Used by the click event of output1 under Repeat. var returnNode = this.getRepeatInstanceNode(); // Click the first output1 component. Then, the node that the repetition node of output1 component refers to will be returned.

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

getSibling( originalID )

Returns a component object in the repetition node where the current component exists.

Parameter
name	type	required	description
originalID	String	Y	Original ID of the component

Return
type	description
Object	Object with the originalID in the repetition node

Sample

// Use for a click event for an Output component of which ID is output1 under the Repeat component. (Components at the same level with component output1 are accessible.) var returnObj = this.getSibling('output1'); // Clicking the output1 of the repeated outut components will return output1. output1 is accessible through returnObj.getValue().

getSiblingId( originalID )

Returns the ID of the component which exists in the same repetition node where the current component exists.

Parameter
name	type	required	description
originalID	String	Y	Original ID of the component

Return
type	description
String	Returns the ID of the component which exists in the same repetition node where the current component exists.

Sample

// (Example) Used by the click event of output1 under Repeat. var returnValue = this.getSiblingId('output1'); // Click the first output1 component. repeat1_0_output1 will be returned.

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 components in the Group.
Specify component to exclude from initialization. (Components that can be initialized) Calendar CheckBox Input InputCalendar MultiSelect Radio Selectbox TextArea

Parameter
name	type	required	description
options	Object	N	Specifies the components to exclude from initialization (through the use of excludePlugin and excludeId)

Sample

repeat1.init(); // Initialize components under the Repeat. var options = { excludePlugin : "radio", excludeId : "input1 calendar1", fireEvent : true }; repeat1.init(options); // Components under Repeat not including Radio, input1, and calendar1 will be initialized and an event will be triggered.

invoke( funcName , param , options )

Invokes a certain function in all sub components.
(Example: Execute setValue for all components under the Repeat component.)

Parameter
name	type	required	description
funcName	String	Y	Name of the function to invoke
param	Object	N	Argument for the function or a function object returning the argument
options	Object	N	Object to specify components not to be affected by function calling.

Sample

repeat1.invoke("setValue", "WebSquare"); // Same as executing componentId.setValue("WebSquare"); for all components under the Repeat component. // An error will be returned if a component does not have the setValue function. function createValue(obj){ var pluginName = obj.getPluginName(); // Component type var id = obj.getID(); // Component ID ... } var options = { excludePlugin : "output calendar", excludeId : "radio1" }; repeat1.invoke("setValue", createValue, options); // Component under the Repeat not including Output, Calendar, and radio1 are not included. // componentId.setValue(Return of the user-defined function(createValue);

refreshRepeat( )

Updates the component with an instance when the component is bound by ref.

Sample

// The response data is bound through a submission. // A changed Model instance requires refreshing of the Repeat. repeat1.refreshRepeat();

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

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.

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