WebSquare.uiplugin.multiupload

MultiUpload. Allows simultaneous uploading of multiple files. Multiple files can be uploaded at the same time. In other words, the end user can upload multiple files at the same time. The MultiUpload component uses the Flash.

Type

uiplugin

Property Summary

action: URL to upload the files
displaySizeUnit: [default:MB, KB, Byte, GB, TB] Size unit to display upon uploading being completed (the ondone event being triggered.) (Byte, KB, MB (Default), GB, TB)
filter: Limits the file types through extensions.
fireEventOnError: [default: false, true] Fires onerror event upon an error (file count, file size, existing file, etc.)
id: Component ID
lang: Language
maxcount: [default: 5] Maximum number of files to upload
maxsize: [default:20000] Maximum file size to upload (in Kb)
mode: [default:flash, transparent, html5_transparent] UI display mode
selectCallback: Callback function to execute after file selection. (Valid when the mode is transparent.)
sizeUnit: [default:Byte, KB, MB, GB, TB] Unit of the size notified to the server upon completion of uploading (or occurrence of the ondone event)
subDir: Name of the node specifying the sub directory.
subSize: Name of the node that saves the maximum upload size in websquare.xml and config.xml.
tabIndex: The focusing order by the Tab key.
uploadButton: Hides the uploading button.
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property
wmode: Displays the selection item list above the object using the wmode.

Event Summary

onComplete: Triggered after the uploading process starts.
ondone: Triggered after all files are uploaded.
onerror: Triggered upon a file uploading failure on the client side. (Error types: File count, file size, existing file)
onprogress: In case of mode="html5_transparent", triggers onprogress event to check the uploading status.

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.
browserDisable( disable ): Disables the feature to open the file in the transparent mode.
changeAction( action ): Sets the URL for the MultiUpload object to multi-upload the input.
changeClass( oldClassName , newClassName ): Changes the class currently applied to the corresponding WebSquare component. (Supported in all WebSquare components.)
disableCancel( disable ): Disables the Cancel button.
disableUpload( disable ): Disables the Upload button.
dropFiles( e ): A function to support drag&drop feature in the MultiUpload component.
focus( ): Focuses the WebSquare component.
getFileCount( ): Gets the number of the files to upload.
getFileInfos( ): Gets information of the files in the multi-upload grid as an array.
getFileNames( ): Returns the names of the files waiting for uploading as an array.
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.)
isUploading( ): Returns the uploading status.
removeAllFiles( ): Removes all file names currently in the Multi-Upload.
removeClass( className ): Removes a class from the WebSquare component. (Supported in all WebSquare components.)
removeFile( name ): Removes files to exclude from uploading among the files selected for multi-uploading.
setEventPause( evList , flag ): Pauses the event.
setInitStyle( property ): Restores the initial style of the WebSquare component.
setMaxFileCount( value ): Sets the number of the files that can be simultaneously uploaded.
setMaxFileSize( value ): Sets the size of the files that can be simultaneously uploaded.
setMessageDuplicateText( label ): Sets a message to guide that there are overlapping files to be simultaneously uploaded.
setMessageMaxCountText( label ): Sets a message to guide the maximum number of files to be simultaneously uploaded.
setMessageMaxSizeText( label ): Sets a message to guide the maximum size of the files to be simultaneously uploaded.
setOpacity( value ): Sets the opacity in the WebSquare component. (Supported in all WebSquare components.)
setParam( index , name , value ): Sets the parameter for file uploading.
setParamJSON( param ): Sets different parameters for each of the files uploaded.
setPosition( left , top , mode ): Sets the position (left, top) of the WebSquare component.
setReadOnly( readOnly ): Sets the readOnly proprety of the WebSquare component.
setRefCancelText( label ): Sets a message to guide that the multi-uploading is being cancelled.
setRefProgressText( label ): Sets a message to guide that the multi-uploading is under progress.
setRefSuccessText( label ): Sets a message to guide that the multi-uploading is completed.
setSelectCallback( functionName ): Sets the selectCallback function.
setSize( width , height ): Sets the size (width, height) of the WebSquare component.
setStyle( propertyName , value ): Sets the CSS of the WebSquare component.
setSubDir( subDir ): Sets the subDir path of the MultiUpload.
setTitleInput( title ): Sets the input title when the MultiUpload is rendered in the order of div, span, and input.
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.)
startUpload( ): Starts multi-uploading.
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

action: URL to upload the files
displaySizeUnit: [default:MB, KB, Byte, GB, TB] Size unit to display upon uploading being completed (the ondone event being triggered.) (Byte, KB, MB (Default), GB, TB)
(Added in 5.0_1.2701A.20170714.211228.)
filter: Limits the file types through extensions.
fireEventOnError: [default: false, true] Fires onerror event upon an error (file count, file size, existing file, etc.)
true: Fires the event.
false (Default): Not fire the event.
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
lang: Language
maxcount: [default: 5] Maximum number of files to upload
maxsize: [default:20000] Maximum file size to upload (in Kb)
mode: [default:flash, transparent, html5_transparent] UI display mode
flash : Uses flash (swf).
transparent : Allows the developer to customize the UI in flash mode.
html5_transparent : Functions in flash mode in IE9 and lower versions, and uses XHR for other browsers.
selectCallback: Callback function to execute after file selection. (Valid when the mode is transparent.)
sizeUnit: [default:Byte, KB, MB, GB, TB] Unit of the size notified to the server upon completion of uploading (or occurrence of the ondone event)
(Added in 5.0_1.2701A.20170714.211228.)
subDir: Name of the node specifying the sub directory. If specified as /websquare/upload/baseDir/"subDirNodeName"/@value in websquare.xml, returns the path. If not specified, the baseDir path will be returned.
subSize: Name of the node that saves the maximum upload size in websquare.xml and config.xml.
(Added in 5.0_1.2701A.20170714.211228.)
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
uploadButton: Hides the uploading button.
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.
wmode: Displays the selection item list above the object using the wmode.
To be used when the selection item list is hidden by objects (such as ActiveX, Flash, etc.)
Use wmode in the object (such as ActiveX, Flash, etc.) not in the component.

Event Detail

onComplete

Triggered after the uploading process starts.

ondone

Triggered after all files are uploaded. (data: JSON obejct to be received after file uploading is done.)

Parameter
name	type	description
data	Object	JSON object returned after uploading is done.

onerror

Triggered upon a file uploading failure on the client side. (Error types: File count, file size, existing file)
Errors on the server side can be detected through the ondone event.

Parameter
name	type	description
data	Object	JSON containing uploading failure info

onprogress

In case of mode="html5_transparent", triggers onprogress event to check the uploading status.

Parameter
name	type	description
data	Object	Upload information

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

browserDisable( disable )

Disables the feature to open the file in the transparent mode. (For the use in the transparent mode only.)

Parameter
name	type	required	description
disable	Boolean	Y	disabled status

Sample

multiupload1.browserDisable(true); Disables file uploading upon clicking of the multi-upload button.

changeAction( action )

Sets the URL for the MultiUpload object to multi-upload the input.

Parameter
name	type	required	description
action	String	Y	URL to multi-upload the files

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

disableCancel( disable )

Disables the Cancel button.

Parameter
name	type	required	description
disable	Boolean	Y	status

Sample

multiupload1.disableCancel(true); Disable the Cancel button.

disableUpload( disable )

Disable the Upload button.

Parameter
name	type	required	description
disable	Boolean	Y	status

Sample

multiupload1.disableUpload(true); Disable the Upload button.

dropFiles( e )

A function to support drag&drop feature in the MultiUpload component. (Added in 5.0_1.2701A.20170714.211228.)

Parameter
name	type	required	description
e	DragEvent	Y	dragEvent object (Event object)

Sample

fileDropZone.addEventListener("drop", multiupload.dropFiles, false);

focus( )

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

getFileCount( )

Gets the number of the files to upload.

Return
type	description
Number	Number of the files to simultaneously upload

Sample

(Example) Tiger.jpg, Lion.jpg var returnValue = multiupload1.getFileCount(); 2 will be returned.

getFileInfos( )

Gets information of the files in the multi-upload grid as an array.

Return
type	description
Array<Object	>Information of the files on the grid

Sample

(Example) Tiger.jpg, Lion.jpg var returnArr = multiupload1.getFileInfos(); [{name:"Tiger.jpg",size:1024,displaySize:"1Kb"},{name:"Lion.jpg",size:2048,displaySize:"2Kb"}]

getFileNames( )

Returns the names of the files waiting for uploading as an array.

Return
type	description
Array	Name of the file waiting for uploading

Sample

(Example) Tiger.jpg, Lion.jpg var returnArr = multiupload1.getFileNames(); returnArr.length is 2. returnArr[0] is Tiger.jpg, and returnArr[1] is Lion.jpg.

getGenerator( )

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

Return
type	description
Object	Parent Generator object

Sample

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

getID( )

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

Return
type	description
String	WebSquare component ID

Sample

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

getInitStyle( CSS )

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

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

getOpacity( )

Returns the opacity of the WebSquare component. (Supported in all WebSquare components.)
The Engine returns the opacity value of the CSS.

Return
type	description
Integer	Opacity

Sample

// Apply the opacity CSS to the InputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> // Return the opacity of the InputBox. var returnValue = input1.getOpacity(); // A real number between 0 and 1 will be returned. // (Return) "0.2"

getOriginalID( )

Returns the originalID of the WebSquare component. (Supported in all WebSquare components.)
The originalID is valid when the scope function is in use.
For scope="true" WFrame, component IDs inside the WFrame is changed with the prefix(wframeID + "_") being added before the ID given by the user (originalID).
The originalID means the ID before the prefix being added.

Return
type	description
String	originalID of the component

Sample

// An example of multi-WFrame page // Main page with a WFrame (main.xml) <w2:wframe id="wframe1" src="text.xml" scope="true"/> // Source page to be contained in the WFrame (text.xml) <w2:textbox id="textbox1"/> // (Example) Check the Id and the original ID in the script of text.xml // Run getID. textbox1.getID(); // "wframe1_textbox1" is returned. // Run getOriginalID. textbox1.getOriginalID(); // "textbox1" is returned.

getPluginName( )

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

Return
type	description
String	Name of the WebSquare component (pluginName)

Sample

// When a common function dynamically receives a WebSQuare object as shown below, different actions can be made for each component type. var commObj = {}; commObj.fn_makeReqData = function(tmpObj){ var tmpID = tmpObj.getID(); // Component ID var tmpCompType = tmpObj.getPluginName(); // Component name if(tmpCompType == "input"){ //..Logic.. }else if(tmpCompType == "gridView"){ //..Logic .. }else{ //..Logic.. } };

getPosition( positionName )

Returns the position (left and top) of the WebSquare component. (Supported in all WebSquare components.)
When the position is set in 0%, the value will be converted into %.

Parameter
name	type	required	description
positionName	String	Y	[left, top] Position type

Return
type	description
Number	Position of the component

Sample

// CSS margin is applied to the Input component as shown below. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> // (Example) Check the top value of the InputBox. var returnValue = input1.getPosition("top"); // Position value in pixels will be returned. // (Return) 10

getReadOnly( )

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

Return
type	description
Boolean	The current setting of the readOnly property

Sample

// Example to check the readOnly setting of the component. var returnValue = componentId.getReadOnly(); // (Return Example) false

getScope( )

For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
For scope="true" WFrame, null will be returned.

Return
type	description
Object	WFrame object or null

Sample

// (Example) // The main page has wframe1 which contains wframe1 which also contains wframe11. // The source page of wframe11 has textbox1. textbox1.getScope(); // (Return Example) wframe11 object

getScopeWindow( )

For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
If not a child of a scope="true" WFrame, a global window object will be returned.

Return
type	description
Object	Scope object of the WFrame or a global window object

Sample

// (Example) // The main page has wframe1 which contains wframe1 which also contains wframe11. // The source page of wframe11 has textbox1. var scope = textbox1.getScopeWindow(); scope.wframe11 === textbox1.getScope(); // true

getSize( sizeName )

Sets the size (width and height) of the WebSquare component. (Supported in all WebSquare components.)
If set in %, values will be converted into pixels.

Parameter
name	type	required	description
sizeName	String	Y	Size types. For calculation of each size type, see the below:

Return
type	description
Number	Size of the component

Sample

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

getStyle( propertyName )

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

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

Return
type	description
String	CSS value

Sample

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

getStyleValue( style )

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

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

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

getTitle( )

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

Return
type	description
String	Title

Sample

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

getUdcHome( )

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

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

Sample

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

getUdcRoot( )

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

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

Sample

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

getUserData( key )

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

Parameter
name	type	required	description
key	String	Y	Data key

Return
type	description
String	Value for the given key

Sample

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

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

isUploading( )

Returns the uploading status.

Return
type	description
Boolean	Uploading status

Sample

var returnValue = multiupload1.isUploading(); "true" will be returned during uploading.

removeAllFiles( )

"true" will be returned during uploading.

Sample

(Example) Tiger.jpg, Lion.jpg multiupload1.removeAllFiles(); The file list will be removed from the Multi-Upload.

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

removeFile( name )

Removes files to exclude from uploading among the files selected for multi-uploading.

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

Sample

(Example) Tiger.jpg, Lion.jpg multiupload1.removeFile("Tiger.jpg"); Tiger.jpg file will be removed from the list.

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

setMaxFileCount( value )

Sets the number of the files that can be simultaneously uploaded.

Parameter
name	type	required	description
value	Number	Y	Maximum number of files that can be simultaneously upladed

Sample

multiupload1.setMaxFileCount(5); Set the maximum number of files as 5.

setMaxFileSize( value )

Sets the size of the files that can be simultaneously uploaded.

Parameter
name	type	required	description
value	Number	Y	Maximum file size (Kb)

Sample

multiupload1.setMaxFileSize(1*1024); Set the maximum file size to upload as 1MB.

setMessageDuplicateText( label )

Sets a message to guide that there are overlapping files to be simultaneously uploaded.

Parameter
name	type	required	description
label	String	Y	Message to guide overlapping of the files

Sample

multiupload1.setMessageDuplicateText('File overlapping error');

setMessageMaxCountText( label )

Sets a message to guide the maximum number of files to be simultaneously uploaded.

Parameter
name	type	required	description
label	String	Y	Guide message

Sample

multiupload1.setMessageMaxCountText('Maximm number of files to be simultaneously uploaded');

setMessageMaxSizeText( label )

Sets a message to guide the maximum size of the files to be simultaneously uploaded.

Parameter
name	type	required	description
label	String	Y	Guide message

Sample

multiupload1.setMessageMaxSizeText('Maximum file size (byte)');

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

setParam( index , name , value )

Sets the parameter for file uploading.

Parameter
name	type	required	description
index	Number	Y	Index of the parameter
name	String	Y	Name of the parameter
value	String	Y	Value of the parameter

setParamJSON( param )

Sets different parameters for each of the files uploaded.
(Example) Sets different parameters for each of the files uploaded - each of Tiger.jpg and Lion.jpg.
Valid only for mode="html5_transparent".

Parameter
name	type	required	description
param	Object	Y	Object containing parameters

Sample

// (Example) 1. Get the file names using getFileNames or geFileInfos. 2. Create parameter data in JSON type for each file. 3. Execute setParamJSON() to send the parameters. ---------------------------------------------------------------------- var paramJSON = {} var fileNames = multiupload1.getFileNames(); for(var fileName of fileNames) { // Use the file name as the key of the paramJSON. paramJSON[fileName] = {"param1":"PARAM 1", "param2":"PARAM 2", ...}; } multiupload1.setParamJSON(paramJSON);

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

setRefCancelText( label )

Sets a message to guide that the multi-uploading is being cancelled.

Parameter
name	type	required	description
label	String	Y	Title

Sample

multiupload1.setRefProgressText('CANCEL'); Sets a message to guide that the multi-uploading is under progress.

setRefProgressText( label )

Sets a message to guide that the multi-uploading is under progress.

Parameter
name	type	required	description
label	String	Y	New text

Sample

multiupload1.setRefProgressText('PROCESSING'); Sets a message to guide that the multi-uploading is under progress.

setRefSuccessText( label )

Sets a message to guide that the multi-uploading is completed.

Parameter
name	type	required	description
label	String	Y	New text

Sample

multiupload1.setRefSuccessText('DONE'); Sets a message to guide that the multi-uploading is completed.

setSelectCallback( functionName )

Sets the selectCallback function.

Parameter
name	type	required	description
functionName	String	Y	Name of the function to be set as selectCallback.

Sample

console.log( typeof newSelectCallback ); // function multiupload1.setSelectCallback("newSelectCallback");

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

setSubDir( subDir )

Sets the subDir path of the MultiUpload.

Parameter
name	type	required	description
subDir	String	Y

setTitleInput( title )

Sets the input title when the MultiUpload is rendered in the order of div, span, and input.

Parameter
name	type	required	description
title	String	Y	Value to set

Sample

multiupload.setTitleInput("inputTitle");

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

startUpload( )

Starts multi-uploading.

Sample

multiupload1.startUpload();

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