WebSquare.uiplugin.widgetContainer

The WidgetContainer contains widgets and manages interactions among the widgets.
The WidgetContainer is based on a two-dimensional map. The unit height is the width of the WidgetContainer divided by the number of the columns, and the unit height is the unitHeightPixel.
The WidgetContainer allows the end users to move the widgets or resize the widgets on the two dimensional map.
The WidgetContainer allows the developers to extract widget information JSON And restore them to save certain widget screen settings.

Type

uiplugin

Property Summary

cols: Number of the columns in the WidgetContainer
horizontalMargin: Horizontal margin among the widgets in pixels
id: ID of the component. Allocated as a global object. Scripts access the component through the ID.
maxUnitHeight: Maximum unit height of the widget
maxUnitHeight: Maximum unit height of the widget
maxUnitWidth: Maximum unit width of the widget
minUnitHeight: Minimum unit height of the widget
minUnitWidth: Minimum unit width of the widget
mode: Basic operation mode for the interactions among the widgets
params: User-defined data stored in the widget object
threshold: If the width of the WidgetContainer is smaller than the threshold, widgets will be placed on a single column.
unitHeightPixel: Unit height of the WidgetContainer in pixels
verticalMargin: Vertical margin of the widget in pixels
widgetMove: Allows moving of the widgets.
widgetResize: Allows resizing of the widdgets.

Event Summary

onafterwidgetclose: Triggered after a widget is closed by closeWidget.
onbeforewidgetclose: Triggerd before a widget is closed by closeWidget. If the event handler returns false, closing of the widget will be cancelled.
onclickcustombtn: Triggered upon the end user’s clicking the customized button.
onload: Triggered after all widgets contained in the WidgetContainer are loaded.
onwidgetfix: Triggered after the widget is fixed by setFixed.
onwidgetload: Triggered upon all widgets contained in the WidgetContainer are completely loaded.
onwidgetmaximize: Triggered after the widget is maximized by toggleMaximized.
onwidgetminimize: Triggered after the widget is minimized by toggleminimized.
onwidgetmove: Triggered upon a widget being moved by an API or end user’s action.
onwidgetresize: Triggered upon a widget being resized by an API or end user’s action.
onwidgetrestore: Triggered upon a minimized or maximized widget being restored.

Method Summary

addClass( className ): Adds a class to the component.
addWidgets( option ): Adds a new widgets based on the options object or option object array of the widget received.
bind( eventType , function ): Dynamically allocates events to the component.
changeClass( oldClassName , newClassName ): Renames the class from oldClassName to newClassName.
enableWidgetMove( isMovable ): Sets moving of the widget within the WidgetContainer.
enableWidgetResize( isResizable ): Allows resizing of the widget contained in the WidgetContainer.
enableWidgetTitle( showTitle ): Controls the title bars of all widgets in the WidgetContainer.
exportWidget( widgetId ): Returns the widget of the specified ID among the widgets contained in the WidgetContainer.
exportWidgets( ): REturns current widget information in the WidgetContainer as JSON data.
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.
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.
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).
getWidgetById( id ): Returns the widget object of the corresponding widget ID.
getWidgetByTitle( id ): Returns the widget object of the corresponding widget title. If there is no corresponding widget, null will be returned.
hasClass( className ): Checks whether the component has className received as a parameter or not.
hide( ): Hides the component.
importWidget( id , jsonObj ): Obtains information of a single widget currently existing as JSON and adds it to the WidgetContainer.
importWidgets( jsonArr , clearFlag ): Imports multiple widgets currently not existing to the WidgetContainer based on the received JSON data.
isValidPos( x , y , unitWidth , unitHeight ): Returns the validity of the location based on the received informaiton.
moveWidget( widgetId , newX , newY ): Moves the widget of the corresponding ID to the specified location (newX, newY).
redraw( ): Renders the widgets in the WidgetContainer accordingly.
removeClass( className ): Removes className from the component.
removeTitleClass( id , className ): Removes the class from the title according to the titleClass property.
removeWidgets( widgetIds ): Removes widgets of the specified IDs.
resizeWidget( widgetId , newWidth , newHeight , options ): Resizes the widget of the specified ID into the new size (newWidth, newHeight).
setCols( cols ): Sets the number of the columns in the two-dimensional map based on which the widgets are placed.
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.
setTitleClass( id , className ): Adds a class to the title based on the titleClass 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

cols: Number of the columns in the WidgetContainer. The WidgetContainer divides its width by the numer of the columns to determine the unit width.
horizontalMargin: Horizontal margin among the widgets in pixels
id: ID of the component. Allocated as a global object. Scripts access the component through the ID.
maxUnitHeight: Maximum unit height of the widget
maxUnitHeight: Maximum unit height of the widget
maxUnitWidth: Maximum unit width of the widget
minUnitHeight: Minimum unit height of the widget
minUnitWidth: Minimum unit width of the widget
mode: Basic operation mode for the interactions among the widgets
pushpull : Pulls up as may widgets as possible. Conflicting widgets will be pulled down.
switch : Tries to switch with the conflicting widget. However, switching is possible only with a smaller widget.
params: User-defined data stored in the widget object
Can be redefined by setParams during runtime, and can be obtained by getParams.
Moreover, this value will be extracted as ‘params’ by getWidgetInfo or exportWidgets.
threshold: If the width of the WidgetContainer is smaller than the threshold, widgets will be placed on a single column.
Moreover, upon the threshold being crossed, moving and resizing will not be allowed.
Designed for mobile environment. If not set, the widgets will be rendered in original locations although the size of the WidgetContainer gets smaller.
unitHeightPixel: Unit height of the WidgetContainer in pixels. The unitHeightPixel will become the actual height of the widget with height === 1.
verticalMargin: Vertical margin of the widget in pixels
widgetMove: Allows moving of the widgets.
widgetResize: Allows resizing of the widdgets.

Event Detail

onafterwidgetclose

Triggered after a widget is closed by closeWidget.

Parameter
name	type	description
id	String	ID of the executed widget

Sample

onbeforewidgetclose

Triggered before a widget is closed by closeWidget. If the event handler returns false, closing of the widget will be canceled.

Parameter
name	type	description
id	String	ID of the tried widget

Sample

onclickcustombtn

Triggered upon the end user’s clicking the customized button.

Parameter
name	type	description
id	String	Widget ID.
btnId	String	Button ID.

Sample

onload

Triggered after all widgets contained in the WidgetContainer are loaded. Triggered after onwidgetload of all widgets occur.

Sample

onwidgetfix

Triggered after the widget is fixed by setFixed.

Parameter
name	type	description
id	String	ID of the executed widget

Sample

onwidgetload

Triggered upon all widgets contained in the WidgetContainer are completely loaded.

Parameter
name	type	description
id	String	Widget ID.

Sample

onwidgetmaximize

Triggered after the widget is maximized by toggleMaximized.

Parameter
name	type	description
id	String	ID of the executed widget

Sample

onwidgetminimize

Triggered after the widget is minimized by toggleminimized.

Parameter
name	type	description
id	String	ID of the executed widget

Sample

onwidgetmove

Triggered upon a widget being moved by an API or end user’s action.

Parameter
name	type	description
id	String	Widget ID
newRect	Object	Location information object of the widget after moving
oldRect	Object	Location information object of the widget before moving

Sample

onwidgetresize

Triggered upon a widget being resized by an API or end user’s action.

Parameter
name	type	description
id	String	Widget ID
newRect	Object	Location information object of the widget after resizing
oldRect	Object	Location information object of the widget before moving

Sample

onwidgetrestore

Triggered upon a minimized or maximized widget being restored.

Parameter
name	type	description
id	String	Widget ID.

Sample

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

addWidgets( option )

Adds a new widgets based on the options object or option object array of the widget received.
In case an error occurs during widget creation, all creation will be cancel-led and rolled back.

Parameter
name	type	required	description
option	Object	Y	Options for widget creation

Return
type	description
Array:Y	Array of the added widgets

Sample

// Create a single widget. var options = {id : "widget1", title : "widget1", titleClass : "w2widget_blue", src : null, scope : true, x : 0, y : 1, unitWidth : 1, unitHeight : 1}; var newWidget = widgetContainer1.addWidgets(options); // Create multiple widgets at the same time. var optionsArr = []; optionsArr[0] = {id : "widget0", title : "widget0", src : "widget.xml", scope : true, x : 0, y : 0, unitWidth : 1, unitHeight : 1}; var newWidgets = widgetContainer1.addWidgets(optionsArr);

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

enableWidgetMove( isMovable )

Sets moving of the widget within the WidgetContainer.

Parameter
name	type	required	description
isMovable	Boolean	Y	Whether to allow moving or not.

enableWidgetResize( isResizable )

Allows resizing of the widget contained in the WidgetContainer.

Parameter
name	type	required	description
isResizable	Boolean	Y	Whether to allow resizing or not.

enableWidgetTitle( showTitle )

Controls the title bars of all widgets in the WidgetContainer.

Parameter
name	type	required	description
showTitle	Boolean	Y	Shows the title.

Sample

// Hide the title of all widgets in the WidgetContainer. widgetContainer1.enableWidgetTitle(false);

exportWidget( widgetId )

Returns the widget of the specified ID among the widgets contained in the WidgetContainer.
If no ID is given, null will be returned.
Related Function: exportWidgets can return information of all widgets currently contained in the WidgetContainer.

Parameter
name	type	required	description
widgetId	String	Y	Widget ID

Return
type	description
Object	Widget object

Sample

// Save a certain widget information using exportWidget(). var jsonObj = widgetContainer1.exportWidget('widget1'); var jsonObj2 = widgetContainer1.exportWidget('widgetContainer1_widget1'); // Output the saved JSON. console.log(jsonObj); console.log(jsonObj2);

exportWidgets( )

REturns current widget information in the WidgetContainer as JSON data.

Return
type	description
Object[]	Array of the widget objects

Sample

// Save current widgets information in jsonArr using exportWidgets(). var jsonArr = widgetContainer1.exportWidgets(); // Output the saved JSON. console.log(jsonArr);

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" }

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

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"

getWidgetById( id )

Returns the widget object of the corresponding widget ID. If there is no corresponding widget, null will be returned.

Parameter
name	type	required	description
id	String	Y	Widget ID

Return
type	description
Object	Widget of the corresponding ID

Sample

// Save a widget object of which ID is 'widget0' in the widget parameter. var widget = widgetContainer1.getWidgetById('widget0'); // If no corresponding widget is found, null will be returned. widgetContainer1.getWidgetById('NoSuchId') === null; // true;

getWidgetByTitle( id )

Returns the widget object of the corresponding widget title. If there is no corresponding widget, null will be returned.
If the widget is overlapping, the first-fund widget will be returned.

Parameter
name	type	required	description
id	String	Y	Widget ID

Return
type	description
Object	Widget of the corresponding ID

Sample

// Save a widget object of which title is 'widget0' in the widget parameter. var widget = widgetContainer1.getWidgetByTitle('widget0'); // If no corresponding widget is found, null will be returned. widgetContainer1.getWidgetByTitle('NoSuchTitle') === null; // true;

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

importWidget( id , jsonObj )

Obtains information of a single widget currently existing as JSON and adds it to the WidgetContainer.
The internal operation is to remove the widget of the corresponding ID and to render it again. However, the ID is maintained.
Related Function: importWidgets is to add multiple widgets not existing currently to the WidgetContainer.

Parameter
name	type	required	description
id	String	Y	Widget ID
jsonObj	Object	Y	Array of widget objects

Return
type	description
Boolean	Execution status

importWidgets( jsonArr , clearFlag )

Imports multiple widgets currently not existing to the WidgetContainer based on the received JSON data.
If the clearFlag is true, all existing widgets will be removed and a new widget will be added.

Parameter
name	type	required	description
jsonArr	Object[]	Y	Array of widget objects
clearFlag	Boolean	Y	Whether to remove existing widgets or not

Return
type	description
Object[]	Array of the imported widget objects

Sample

// Save jsonArr of the current widgets using exportWidgets(). var jsonArr = widgetContainer1.exportWidgets(); // Display the widgets of the jsonArr after removing the existing widgets. widgetContainer1.importWidgets(jsonArr, true);

isValidPos( x , y , unitWidth , unitHeight )

Returns the validity of the location based on the received information.
However, conflict among the widgets will not be checked. Only, the boundary and min/max limits will be checked.

Parameter
name	type	required	description
x	Number	Y	X value of the widget
y	Number	Y	Y value of the widget
unitWidth	Number	Y	unitWidth of the widget
unitHeight	Number	Y	unitHeight of the widget

Return
type	description
Boolean	Validity of the location

Sample

//x === -1 is not a valid location so result === false will be returned. var result = isValidPos(-1, 3, 2, 3);

moveWidget( widgetId , newX , newY )

Moves the widget of the corresponding ID to the specified location (newX, newY).
If newX or newY is not valid, the existing widget will be maintained.
Rolled back to the previous status and tries again.
If successful after resolving of the conflicts, commit will be executed. Otherwise, rollback will be executed.
Upon successful moving, true will be returned. Otherwise, false will be returned.

Parameter
name	type	required	description
widgetId	String	Y	ID of the widget to control.
newX	Number	N	New X value of the widget
newY	Number	N	New Y value of the widget

Return
type	description
Boolean	Execution result

Sample

// Move the widget0 to (2,2). widgetContainer1.moveWidget('widget0', 2, 2);

redraw( )

Renders the widgets in the WidgetContainer accordingly.
Called upon execution completion of the API. In case drag&drop is used, called upon changes in real-time locations of the widgets.
All rendering operations including oneColumn, maximize, minimize, and ghost are made by calling _renderWithRect.

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

removeTitleClass( id , className )

Removes the class from the title according to the titleClass property.
Related Property: titleClass

Parameter
name	type	required	description
id	String	Y	Widget ID
className	String	Y	Name of the class to remove from the widget

Sample

Dynamically remove the class ("w2widget_disable") applied to the title of the widget ("widget1"). widgetContinerID.removeTitleClass("widget1","w2widget_disable");

removeWidgets( widgetIds )

Removes widgets of the specified IDs.
The internal operation is to call _removeWidgets to actually remove the widgets. Upon successful removal, array of the deleted widget IDs will be returned.
A widget object or an array of the widget objects will enable widget removal. However, ID or ID array is recommended.

Parameter
name	type	required	description
widgetIds	String \| String[]	Y	Array of the widget IDs to remove

Return
type	description
String[]	Array of the removed widget IDs

Sample

var ids = ['widget0', 'widget1', 'widget2']; // Remove widgets of which IDs are widget0, widget1, and widget2. widgetContainer1.removeWidgets(ids); widgetContainer1.getWidgetById('widget0') === null // true;

resizeWidget( widgetId , newWidth , newHeight , options )

Resizes the widget of the specified ID into the new size (newWidth, newHeight).
If newWidth or newHeight is not valid, the current widget status will be maintained.
Rolled back to the previous status and tries again.
If successful after resolving of the conflicts, commit will be executed. Otherwise, rollback will be executed.
Upon successful resizing, true will be returned. Otherwise, false will be returned.

Parameter
name	type	required	description
widgetId	String	Y	ID of the widget to control.
newWidth	Number	N	New unitWidth of the widget
newHeight	Number	N	New unitHeight of the widget
options	Object \| Object[]	Y	Other options

Return
type	description
Boolean	Execution result

Sample

// Resize widget1 into (2,2). Even when resizeWidget is false, forced resizing is possible. widgetContainer1.resizeWidget("widget1", 2, 2, {"force" : true});

setCols( cols )

Sets the number of the columns in the two-dimensional map based on which the widgets are placed. However, the number of the columns must be the same with or larger than the current widget width.

Parameter
name	type	required	description
cols	String	Y	Columns to newly set in the WidgetContainer

Sample

// The following functions when the widget width is 1, 2, 3, or 4. If the widget width is larger than 4, the following example will not function. widgetContainer1.setCols(4);

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

setTitleClass( id , className )

Adds a class to the title based on the titleClass property.
Related Property: titleClass

Parameter
name	type	required	description
id	String	Y	Widget ID
className	String	Y	Name of the class to apply to the widget

Sample

Dynamically apply a new class ("w2widget_disable") to the title area of the widget ("widget1"). widgetContinerID.setTitleClass("widget1","w2widget_disable");

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