WebSquare.uiplugin.repeat

Generates component templates as many as specified. For automatic generation, id and ref are bound with the key for the data.

Type

uiplugin

Property Summary

autoCount: To be set in the repeated node for the repeatKey property. The value starts from 1 in the first node.
class: Class of the component
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
toolTip: Tooltip of the component.
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 class to the component.
bind( eventType , function ): Dynamically allocates events to the component.
changeClass( oldClassName , newClassName ): Renames the class from oldClassName to newClassName.
focus( ): Moves the focus to the component.
getDisabled( ): Gets the current value of the disabled property.
getGenerator( ): Called by a component under the Generator component. When called, gets the parent Generator object.
getID( ): Gets the ID of the component.
getInstanceValue( ): Returns the instance nodeValue that the Repeat component refers to.
getOpacity( ): Gets the opacity of the component defined in CSS.
getPluginName( ): Gets the pluginName (or the name) of the component.
getPosition( positionName ): Gets the left or top position of the component.
getReadOnly( ): Gets the current setting of the readOnly property.
getRepeat( ): Returns an object of the Repeat component that does the repetition.
getRepeatChildren( originalId ): Returns the child object of the repeated components.
getRepeatIndex( ): Returns the index of the repeated part to which the current component belongs.
getRepeatInstanceNode( ): Returns the instance node to which the the repetiion part of the current component refers.
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 ): Gets the size of the component.
getStyle( propertyName ): Gets the current value of the propertyName of the component defined in CSS.
getStyleValue( style ): [deprecated] Use getStyle instead.
getTitle( ): Gets the title value.
getUserData( key ): Returns the user-defined property value set by setUserData as the user data or source (page XML).
hasClass( className ): Checks whether the component has className received as a parameter or not.
hide( ): Hides the component.
init( options ): Initializes all component values not including components specified by options.
invoke( funcName , param , options ): Calls functions of all components.
refreshRepeat( ): Updates the component with an instance when the component is bound by ref.
removeClass( className ): Removes className from the component.
setDisabled( disabled ): Sets the disabled property.
setEventPause( evList , flag ): Disables or enables the component event.
setOpacity( value ): Sets the opacity of the component.
setPosition( left , top , mode ): Sets the position (left, top) of the component.
setReadOnly( readOnly ): Controls the "readOnly" property.
setSize( width , heigth ): Sets the size (width, height) of the component.
setStyle( propertyName , value ): Sets the style of the specified property.
setUserData( key , value ): Sets the user data in the component.
show( displayType ): Displays the component.
toggleClass( className ): Removes a class named className, or if there is no such a class, adds a class named className.
trigger( type , array ): Triggers a certain event registered for the component.
unbind( type , function ): Removes an event registered for the component.
visible( flag ): [deprecated] Shows/Hides the component, or sets the visible property using setStyle.

Property Detail

autoCount: To be set in the repeated node for the repeatKey property. The value starts from 1 in the first node. (If there is no repeatKey, set the autoCount as true.)
class: Class of the component
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
toolTip: Tooltip of the component.
userData1: User-defined property. Use getUserData("userData1") 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

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

Method Detail

addClass( className )

Adds a class to the component.

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

Sample

// Add oddClass to component input1. input1.addClass("oddClass");

bind( eventType , function )

Dynamically allocates events to the component.

Parameter
name	type	required	description
eventType	String	Y	Name of the event to allocate.
function	Function	Y	Handler function of the event to allocate.

Sample

// Define the event handler function for the onclick event in the input component, and bind the function. input1.bind("onclick", function(e){ alert(input1.getValue();})); // Bind commObj.ev_click function for the onclick event with component input1. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; input1.bind("onclick", commObj.ev_click );

changeClass( oldClassName , newClassName )

Renames the class from oldClassName to newClassName.
In the default setting, only the classes added by addClass will be applied. In order to directly remove the class defined in the "class" property of the component, add the following setting in config.xml file.
<style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
oldClassName	String	Y	Name of the class to remove
newClassName	String	Y	Name of the class to add

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following to config.xml. <style> <removeDefaultClass value="true" /> </style> // Change tmpInputClass class to tmpInputWarninClass. input1.changeClass("tmpInputClass","tmpInputWarninClass");

focus( )

Moves the focus to the component.

getDisabled( )

Gets the current value of the disabled property.

Return
type	description
Boolean	The value of the disabled property.

Sample

var returnValue = componentId.getDisabled(); (Return example) false

getGenerator( )

Called by a component under the Generator component. When called, gets the parent Generator object.

Return
type	description
Object	Parent Generator object

Sample

<w2:generator id="generator1"> <w2:trigger id="trigger1" ev:onclick="scwin.trigger1_onclick"></w2:trigger></w2:generator> scwin.trigger1.onclick = function(){ console.log(this.getGenerator());} // Click trigger1 to display the generator1 object on the console. // See https://inswave.com/jira/browse/WPF-1425.

getID( )

Gets the ID of the component.

Return
type	description
String	ID of the WebSquare5 component

Sample

// The WebSquare5 component dynamically received as a parameter can be used as shown in the following. function fn_validCheck(tmpObj){ // tmpObj has an ID of "input1". var compID = tmpObj.getID(); // (Return Example) "input1" }

getInstanceValue( )

Returns the instance nodeValue that the Repeat component refers to.

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

Sample

(Example) Use for the click event of the Output component of which ID is output1 under the Repeat Component. var returnValue = this.getInstanceValue(); Upon clicking of the first output1, the data referred to by the component output1 will be returned.

getOpacity( )

Gets the opacity of the component defined in CSS.

Return
type	description
Integer	Opacity

Sample

// Apply opacity CSS to the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> var returnValue = input1.getOpacity(); // "returnValue" is a real number between 0 and 1. // (Return Value) "0.2"

getPluginName( )

Gets the pluginName (or the name) of the component.

Return
type	description
String	pluginName of the WebSquare5 component

Sample

// For a WebSquare5 object dynamically received by a common function, conditional statements can be used as shown below. var commObj = {}; commObj.fn_makeReqData = function(tmpObj){ var tmpID = tmpObj.getID(); // Component ID var tmpCompType = tmpObj.getPluginName(); // Component Type if(tmpCompType == "input"){ //..Logic.. }else if(tmpCompType == "gridView"){ //..Logic .. }else{ //..Logic.. } };

getPosition( positionName )

Gets the left or top position of the component. If set by %, the corresponding pixel value will be returned.

Parameter
name	type	required	description
positionName	String	Y	[left,top] Type of the position

Return
type	description
Number	Position of the component

Sample

// Apply margin CSS to the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> var returnValue = input1.getPosition("top"); // The returnValue will be a position in pixels. // (Return Example) 10

getReadOnly( )

Gets the current setting of the readOnly property.

Return
type	description
Boolean	The current setting of the readOnly property

Sample

var returnValue = componentId.getReadOnly(); // (Return Example) false

getRepeat( )

Returns an object of the Repeat component that does the repetition.
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	Repeat component object to repeat the current component

Sample

(Example) Use for the click event of the Output component of which ID is output1 under the Repeat Component. 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

(Example) There is an Output component of which ID is output1 within the Repeat component. (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 part to which the current component belongs.

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

Sample

(Example) Use for the click event of the Output component of which ID is output1 under the Repeat Component. var returnValue = this.getRepeatIndex(); Click the first output1 component. 0 will be returned.

getRepeatInstanceNode( )

Returns the instance node to which the repetition part of the current component refers.

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

Sample

(Example) Use for the click event of the Output component of which ID is output1 under the Repeat Component. var returnNode = this.getRepeatInstanceNode(); Click the first output1 component. Then, the node that the repetition node of output1 component refers to will be returned.

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

(Example) 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'); Click the first output1 component. An object of the component output1 will be returned. The value of the component output1 can be returned by 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) Use for the click event of the Output component of which ID is output1 under the Repeat Component. var returnValue = this.getSiblingId('output1'); Click the first output1 component. repeat1_0_output1 will be returned.

getSize( sizeName )

Gets the size of the component. If set by "%", the corresponding pixel value will be returned.

Parameter
name	type	required	description
sizeName	String	Y	[height, innerHeight, outerHeight, outerMarginHeight, width, innerWidth, outerWidth, outerMarginWidth] Type of the size. For the calculation of each size type, see below.

Return
type	description
Number	Size of the component

Sample

var returnValue = componentId.getSize("width"); // "returnValue" will be a size in pixels. If set by "%", the corresponding pixel value will be returned. // (Return Example) 100

getStyle( propertyName )

Gets the current value of the propertyName of the component defined in CSS.

Parameter
name	type	required	description
propertyName	String	Y	Name of the property in the style

Return
type	description
String	Style value

Sample

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

getStyleValue( style )

[deprecated] Use getStyle instead.
Gets the current value of the propertyName of the component defined in CSS.

Parameter
name	type	required	description
style	String	Y	Name of the property defined in the style

Return
type	description
String	Value defined in the style property. (In case of a color, the hexcode of the color will be returned.)

getTitle( )

Gets the title value.

Return
type	description
String	Title value

Sample

// Define the "title" for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); // (Return Example ) "Input Name"

getUserData( key )

Returns the user-defined property value set by setUserData as the user data or source (page XML).

Parameter
name	type	required	description
key	String	Y	Random data key

Return
type	description
String	Data of the corresponding key

Sample

// Apply the customized property (eduTest) to the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" eduTest="Hello"></xf:input> input1.getUserData("eduTest"); // (Return Example) "Hello" // Use setUserData. input1.setUserData("eduTest","WebSquare"); input1.getUserData("WebSquare"); // (Return Example) "Hello"

hasClass( className )

Checks whether the component has className received as a parameter or not.

Parameter
name	type	required	description
className	String	Y	className to check

Return
type	description
Boolean	Whether the component has the class or not

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> var returnValue = input1.hasClass("tmpInputClass"); // (Return Example) true

hide( )

Hides the component.
he CSS setting will be "display:none;" and "visibility:hidden;".

Sample

componentId.hide();

init( options )

Initializes all component values not including components specified by options. Components that can be initialized includecalendar, checkbox, input, inputCalendar, multiselect, radio, selectbox, and 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); Initialize components except the Radio component, the InputBox component of which ID is input1, the Calendar component of which ID is calendar1, and trigger events upon value changes.

invoke( funcName , param , options )

Calls functions of all 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); Same as executing componentId.setValue(a returned value by the customized function(createValue)); for all components under the Repeat component except the Output component, the Calendar component, and the component radio1.

refreshRepeat( )

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

Sample

(Example) If the response data is bound by submission, update the Repeat component to reflect the changes in the model instance. repeat1.refreshRepeat();

removeClass( className )

Removes className from the component.
In the default setting, only the classes added by addClass will be applied. In order to directly remove the class defined in the "class" property of the component, add the following setting in config.xml file.
<style><removeDefaultClass value="true" /></style>

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

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following to config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.removeClass("tmpInputClass");

setDisabled( disabled )

Sets the disabled property. True to disable, or false not to disable.

Parameter
name	type	required	description
disabled	Boolean	Y	True to disable, or false not to disable.

Sample

// Disable the component. componentId.setDisabled(true);

setEventPause( evList , flag )

Disables or enables the component event.

Parameter
name	type	required	description
evList	String	N	List of the events. If not specified, all user events of the component will be listed. (Enter null data.)
flag	Boolean	Y	true is to pause, or false is to cancel pausing.

Sample

input1.setEventPause("onclick", true); // Dynamically pauses the onclick event. input1.setEventPause("onfocus,onblur", false); // Restarts the onfocus and the onblur events. input1.setEventPause(null, true); // Pauses all user events registered for the Input component.

setOpacity( value )

Sets the opacity of the component.

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

Sample

componentId.setOpacity(0.45);

setPosition( left , top , mode )

Sets the position (left, top) of the component.

Parameter
name	type	required	description
left	Number	Y	Left position or null.
top	Number	Y	Top position or null.
mode	String	N	[defulat:absolute, delta] absolute sets the current positions as x and y, and delta adds x and y to the current positions.

Sample

// Set the top position of the component as 100 pixels. componentId.setPosition(null, 100);

setReadOnly( readOnly )

Controls the "readOnly" property. True to enable, or false to disable.

Parameter
name	type	required	description
readOnly	Boolean	Y	True to enable, or false to disable.

Sample

// Enable the read-only. componentId.setReadOnly(true);

setSize( width , heigth )

Sets the size (width, height) of the component.

Parameter
name	type	required	description
width	Number	Y	Component width or null
heigth	Number	Y	Component height or null

Sample

// Set the component height as 100 pixels. componentId.setSize(null,100);

setStyle( propertyName , value )

Sets the style of the specified property.

Parameter
name	type	required	description
propertyName	String	Y	Name of the style
value	String	Y	Value of the style

Sample

// Set the component width as 200px. componentId.setStyle("width", "200px"); // Change the background color to olive. componentId.setStyle("background-color","olive");

setUserData( key , value )

Sets the user data in the component. If the key cannot be set for the component, corresponding logs will be displayed.

Parameter
name	type	required	description
key	String	Y	Random data key
value	String	Y	Random data key

Sample

// Setting a (key, value) pair of ("data", "WebSquare5") in the component. componentId.setUserData("data", "WebSquare"); // Some keys cannot be set for the component. componentId.setUserData("title", "WebSquare"); // (Log Example) !!!WARNING - [title] can't define as UserData

show( displayType )

Displays the component.
The related CSS properties are display and visibility:show;.

Parameter
name	type	required	description
displayType	String	N	[default:block ,inline ,none ,""] Value of the Display property.

Sample

// Block the "display" property. componentId.show(); // Enable the "display" property in the class. componentId.show("");

toggleClass( className )

Removes a class named className, or if there is no such a class, adds a class named className.
In the default setting, only the classes added by addClass can be removed. To remove other classes, add the following setting in config.xml.
<style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	className to set

Sample

// Define a class for the Input component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following to config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.toggleClass("tmpInputClass"); // Add tmpInputClass class again. input1.toggleClass("tmpInputClass");

trigger( type , array )

Triggers a certain event registered for the component.

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

Sample

// Trigger the onclick event in the input1 component. input1.trigger("onclick"); // Trigger the onviewchange event in the input component and call the event handler function by sending arguments of (1, 2). input1.trigger("onviewchange", [1,2]);

unbind( type , function )

Removes an event registered for the component.

Parameter
name	type	required	description
type	String	N	Name of the event to remove. If not specified, all events of the components 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

// Remove all events registered in the input component. input1.unbind(); // Remove all handler functions of onviewchange event registered in the input component. input1.unbind("onviewchange"); // Remove the func1 event handler of onviewchange event registered for component input1. input1.unbind("onviewchange", func1);

visible( flag )

[deprecated] Shows/Hides the component, or sets the visible property using setStyle.
Sets the visibility of the component style. In case of true, set visible. In case of false, set hidden.

Parameter
name	type	required	description
flag	Boolean	Y	Visibility (In case of true, set visible. In case of false, set hidden.)