WebSquare.uiplugin.tabContainer

Creates a tab-type page.

Type

uiplugin

Property Summary

alwaysDraw: Renders the contents inside the tab in advance.
class: Class of the TabContainer
contentsClass: Class to apply to all contents
id: ID of the TabContainer
selectedIndex: Index of the selected tab
tabDefaultCenterImageClass: Class of the default center image of the tab
tabDefaultCenterImageStyle: Style of the default center image of the tab
tabDefaultLeftImageClass: Class of the default left image of the tab
tabDefaultLeftImageStyle: Style of the default left image of the tab
tabDefaultRightImageClass: Class of the default right image of the tab
tabDefaultRightImageStyle: Style of the default right image of the tab
tabHoverCenterImageClass: Class of the center image upon mouse hovering over the tab
tabHoverCenterImageStyle: Style of the center image upon mouse hovering over the tab
tabHoverLeftImageClass: Class of the left image upon mouse hovering over the tab
tabHoverLeftImageStyle: Style of the left image upon mouse hovering over the tab
tabHoverRightImageClass: Class of the right image upon mouse hovering over the tab
tabHoverRightImageStyle: Style of the right image upon mouse hovering over the tab
tabPosition: Sets the position of the tab.
tabSelectedCenterImageClass: Class of the center image when the tab is selected
tabSelectedCenterImageStyle: Style of the center image when the tab is selected
tabSelectedLeftImageClass: Class of the left image when the tab is selected
tabSelectedLeftImageStyle: Style of the left image when the tab is selected
tabSelectedRightImageClass: Class of the right image when the tab is selected
tabSelectedRightImageStyle: Style of the left image when the tab is selected
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property

Event Summary

onbeforeselect: Triggered before tab selection.
onchange: Triggered upon a tab change.
ontabclick: Triggered upon the end user's clicking a tab.

Method Summary

addClass( className ): Adds a class to the component.
addTab( id , options , options.label , options.frameMode , options.src ): Adds a tab with the given ID.
bind( eventType , function ): Dynamically allocates events to the component.
changeClass( oldClassName , newClassName ): Renames the class from oldClassName to newClassName.
deleteTab( idx ): Deletes the tab of the corresponding index.
disableTab( idx ): Disables the tab of the corresponding index.
enableTab( idx ): Enables the tab of the corresponding index.
focus( ): Moves the focus to the component.
getCount( ): Returns the total tab count.
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.
getInitStyle( property ): Gets the initial style of the component.
getLabelText( idx ): Returns the label of the tab of the corresponding index.
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.
getScope( ): Returns the parent WFrame object when the component is a child of the WFrame which uses the scope feature (scope=true). Returns null if not the child of the scoping-enabled (scope=true) WFrame.
getScopeWindow( ): Returns the scope object of the parent when the component is a child of the WFrame which uses the scope feature (scope=true). Returns the window object if not a child of the scoping-enabled (scope=true) WFrame.
getSelectedID( ): Returns the ID of the selected tab.
getSelectedIndex( ): Returns the index of the selected tab.
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.
getUdcHome( ): Returns the path of the file which defines the UDC.
getUdcRoot( ): Returns the path of the file which defines the UDC.
getUserData( key ): Returns the user-defined property value set by setUserData as the user data or source (page XML).
getWindow( idx ): Returns the window contents of the specified tab index.
hasClass( className ): Checks whether the component has className received as a parameter or not.
hide( ): Hides the component.
init( options , options.excludePlugin , options.excludeId , options.fireEvent ): Initializes all component values not including components specified by options.
invoke( funcName , param , options , options.excludePlugin , options.excludeId ): Calls functions of all components.
removeClass( className ): Removes className from the component.
setDisabled( disabled ): Sets the disabled property.
setEventPause( evList , flag ): Disables or enables the component event.
setInitStyle( property ): Initializes the component style.
setLabelText( idx , label ): Returns the label of the tab.
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.
setSelectedIndex( idx ): Selects the tab of the received index.
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

alwaysDraw: Renders the contents inside the tab in advance.
class: Class of the TabContainer
contentsClass: Class to apply to all contents
id: ID of the TabContainer
selectedIndex: Index of the selected tab
tabDefaultCenterImageClass: Class of the default center image of the tab
tabDefaultCenterImageStyle: Style of the default center image of the tab
tabDefaultLeftImageClass: Class of the default left image of the tab
tabDefaultLeftImageStyle: Style of the default left image of the tab
tabDefaultRightImageClass: Class of the default right image of the tab
tabDefaultRightImageStyle: Style of the default right image of the tab
tabHoverCenterImageClass: Class of the center image upon mouse hovering over the tab
tabHoverCenterImageStyle: Style of the center image upon mouse hovering over the tab
tabHoverLeftImageClass: Class of the left image upon mouse hovering over the tab
tabHoverLeftImageStyle: Style of the left image upon mouse hovering over the tab
tabHoverRightImageClass: Class of the right image upon mouse hovering over the tab
tabHoverRightImageStyle: Style of the right image upon mouse hovering over the tab
tabPosition: Sets the position of the tab.
tabSelectedCenterImageClass: Class of the center image when the tab is selected
tabSelectedCenterImageStyle: Style of the center image when the tab is selected
tabSelectedLeftImageClass: Class of the left image when the tab is selected
tabSelectedLeftImageStyle: Style of the left image when the tab is selected
tabSelectedRightImageClass: Class of the right image when the tab is selected
tabSelectedRightImageStyle: Style of the left image when the tab is selected
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

onbeforeselect

Triggered before tab selection.

Parameter
name	type	description
selectedIndex	Number:Y	Currently selected index
index	Number:Y	Index to be selected by the user

Sample

ev:event="onbeforeselect(selectedIndex, index)" will select tab2 from tab1. <script ev:event="onbeforeselect(selectedIndex, index)" type="javascript"><![CDATA[ output1.setValue(selectedIndex +"->" +index); return true; // 탭이동한다. (return false;: 탭이동이 없음.) ]]></script> output1 will be 0 -> 1 , and the focus will move to tab2.

onchange

Triggered upon a tab change.

ontabclick

Triggered upon the end user's clicking a tab.

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

addTab( id , options , options.label , options.frameMode , options.src )

Adds a tab with the given ID.
If the ID is already in use by another tab, the corresponding tab will be selected instead of another tab being added.

Parameter
name	type	required	description
id	String	Y	ID of the new tab
options	Object	Y	Options of the new tab
options.label	String	Y	: Label text of the tab
options.frameMode	String	Y	: iframe.
options.src	String	Y	: Source of the file containing the contents.

Sample

Example: (id가 tab1, tab2, tab3) There are three tabs in the TabContainer. var options = { label : "addTab", frameMode : "iframe", src : "/addTabContent.xml" }; tabContainer1.addTab('tab4', options); The fourth tab will be created.

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

deleteTab( idx )

Deletes the tab of the corresponding index.

Parameter
name	type	required	description
idx	Number	Y	index or id

Sample

Example: (id가 tab1, tab2, tab3) There are three tabs in the TabContainer. tabContainer1.deleteTab(0); The first tab (tab1) will be deleted.

disableTab( idx )

Disables the tab of the corresponding index.

Parameter
name	type	required	description
idx	Number	Y	Index of the tab to disable

Sample

Example: (id가 tab1, tab2, tab3) There are three tabs in the TabContainer. tabContainer1.disableTab(0); The first tab (tab1) will be disabled. In case the first tab (tab1) is selected, the second tab (tab2) will be selected.

enableTab( idx )

Enables the tab of the corresponding index.

Parameter
name	type	required	description
idx	Number	Y	Index of the tab to enable

Sample

Example: (id가 tab1, tab2, tab3) There are three tabs in the TabContainer. tabContainer1.enableTab(0); The first tab (tab1) will be enabled.

focus( )

Moves the focus to the component.

getCount( )

Returns the total tab count.

Return
type	description
Number	Total tab count

Sample

Example: (Ids of tab1, tab2, and tab3) There are three tabs in the TabContainer. var returnValue = tabContainer1.getCount(); The returnValue is 3.

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

getInitStyle( property )

Gets the initial style of the component.

Parameter
name	type	required	description
property	String	N	Name of the attribute (If not specified, all information will be ouputted.)

getLabelText( idx )

Returns the label of the tab of the corresponding index.

Parameter
name	type	required	description
idx	Number	Y	Tab index

Sample

Example: (Ids of tab1, tab2, and tab3) There are three tabs in the TabContainer. Each tab value is 1, 2, and 3, and the second tab (tab2) is selected. var returnValue = tabContainer1.getLabelText(); 2 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

getScope( )

Returns the parent WFrame object when the component is a child of the WFrame which uses the scope feature (scope=true). Returns null when the component is not a child of the WFrame using the scope feature (scope=true).

Return
type	description
Object	wframe object or null

Sample

// The main page contains wframe1, and wframe1 contains wframe11 which contains textbox1. textbox1.getScope(); // Returns wframe11 object.

getScopeWindow( )

Returns the scope object of the parent when the component is a child of the WFrame which uses the scope feature (scope=true). Returns a global window object when the component is not a child of the WFrame using the scope feature (scope=true.

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

Sample

// The main page contains wframe1, and wframe1 contains wframe11 which contains textbox1. var scope = textbox1.getScopeWindow(); scope.wframe11 === textbox1.getScope(); // true

getSelectedID( )

Returns the ID of the selected tab.

Return
type	description
String	ID of the selected tab

Sample

Example: (Ids of tab1, tab2, and tab3) There are three tabs in the TabContainer. var returnValue = tabContainer1.getSelectedID(); The returnValue is tab2.

getSelectedIndex( )

Returns the index of the selected tab.

Return
type	description
Number	Index of the selected tab

Sample

Example: (Ids of tab1, tab2, and tab3) There are three tabs in the TabContainer. var returnValue = tabContainer1.getSelectedIndex(); “1” 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"

getUdcHome( )

Returns the path of the file which defines the UDC. Includes the file extension of .xml. For a path without .xml, use getUdcRoot. When called by a component, not a UDC object, undefined will be returned.

Return
type	description
String	When called by a component, not a UDC object, undefined will be returned.

Sample

The udc file is /a/b/udc.xml, the XML file is /a/c/main.xml, and the UDC object ID is udc1. udc1.getUdcHome(); // The execution result is /a/b/udc.xml.

getUdcRoot( )

Returns the path of the file which defines the UDC. udc1.getUdcHome(); // The execution result is /a/b/udc.xml. For a path including .xml, use getUdcHome. When called by a component, not a UDC object, undefined will be returned.

Return
type	description
String	When called by a component, not a UDC object, undefined will be returned.

Sample

The udc file is /a/b/udc.xml, the XML file is /a/c/main.xml, and the UDC object ID is udc1. udc1.getUdcHome(); // The execution result is /a/b/udc.xml.

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"

getWindow( idx )

Returns the window contents of the specified tab index.
If the index is not specified, the window content of the tab will be returned.

Parameter
name	type	required	description
idx	Number	N	Tab Index

Return
type	description
Object	window

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 , options.excludePlugin , options.excludeId , options.fireEvent )

Initializes all component values not including components specified by options. (calendar, checkbox, grid, input, inputCalendar, multiselect, radio, selectbox, textarea)

Parameter
name	type	required	description
options	Object	N	Specifies the components to exclude from initialization (through the use of excludePlugin and excludeId)
options.excludePlugin	String	N	: Name of the component not to initialize. Use space to separate multiple components.
options.excludeId	String	N	: ID of the component not to initialize. Use space to separate multiple components.
options.fireEvent	Boolean	N	: Event triggering option. The default is false. Prevents events from being triggered.

Sample

tabContainer1.init(); Initializes the components under the TabContainer. var options = { excludePlugin : "grid radio", excludeId : "input1 calendar1", fireEvent : true }; tabContainer1.init(options); Initializes the components that can be initialized under the TabContainer except grid, radio, input1, calendar1, and generates events accordingly.

invoke( funcName , param , options , options.excludePlugin , options.excludeId )

Calls functions of all components.
Example) Executes setValue on all components under the TabContainer.

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.
options.excludePlugin	String	N	: Name of the component not to be affected by function calling. Use space to separate multiple components.
options.excludeId	String	N	: ID of the component not to be affected by function calling. Use space to separate multiple components.

Sample

tabContainer1.invoke("setValue", "WebSquare"); Same as executing componentId.setValue("WebSquare"); on all components under the TabContainer. If there is a component without setValue (for example, grid), an error will be returned. function createValue(obj){ var pluginName = obj.getPluginName(); // Component type var id = obj.getID(); // Component ID ... } var options = { excludePlugin : "grid calendar", excludeId : "radio1" }; tabContainer1.invoke("setValue", createValue, options); Same as executing componentId.setValue on the components under the TabContainer exept grid, calendar, and radio1 and returning the result.

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.

setInitStyle( property )

Initializes the component style.

Parameter
name	type	required	description
property	String	N	Name of the property (If not specified, all properties will be returned.)

Sample

group1.getInitStyle();

setLabelText( idx , label )

Returns the label of the tab.

Parameter
name	type	required	description
idx	Number	Y	Index of the tab to change the label
label	String	Y	New label

Sample

Example: (Ids of tab1, tab2, and tab3) There are three tabs in the TabContainer. tabContainer1.setLabelText(0, "TAB_1"); Sets the text of the first tab (tab1) as TAB_1.

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

setSelectedIndex( idx )

Selects the tab of the received index.

Parameter
name	type	required	description
idx	Number	Y	Index to select

Sample

Example: (Ids of tab1, tab2, and tab3) There are three tabs in the TabContainer. tabContainer1.setSelectedIndex(0); The contents of the first tab (tab1) of the TabContainer is displayed. Not the contents of tab2 and tab3.

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