WebSquare.uiplugin.scheduleCalendar

The ScheduleCalendar displays schedule items on the calendar.

Type

uiplugin

Property Summary

class: Same as the class property in HTML standard. One or more classes defined in the CSS file or in the style block can be applied (through the use of the space as the separator).
cssRenderOrder: [default:false, true] Changes the CSS file rendering order of the the link tag in the document head to be rendered after the link tag of stylesheet_ext.css file.
dataList: [defulat:""] DataList to bind with the scheduleCalendar. The following is the dataList columns for the scheduleCalendar.
defaultDate: [default:""] Initial date to be displayed upon component loading. Must match with the ioFormat.
defaultView: [default:'month'] Sets the defaultView of the the ScheduleCalendar.
editable: [default:false, true] Edits the schedule items through mouse dragging and dropping.
endColumn: [default:""] Column ID of the DataList to be used as the end date in the ScheduleCalendar.
eventOrderColumn: [default:""] Column ID in the DataList based on which the schedule items in the ScheduleCalendar will be sorted.
headerLeftBtn: [default:true, false] Displays three buttons ("<", ">", and "Today") on the upper-left corner.
headerRightBtn: [default:true, false] Displays the schedule unit buttons (“Month”, “Week”, and “Day”) on the upper-right corner.
headerTitle: [default:true, false] Display of the header center title on the ScheduleCalanedar. [show, hide]
id: Component ID
idColumn: [default:""] Column ID of the DataList to be used as the schedule item ID in the ScheduleCalendar.
ioFormat: [default:yyyyMMdd,MMddyyyy,ddMMyyyy] Sets the date format for start and end columns.
lang: [default:ko, en] Langauge.
locale: [default:ko, en] 3
selectable: [default:false, true] Allows selection of a certain date to create schedule items. (Generates a propmpt window.)
startColumn: [default:""] Column ID of the DataList to be used as the starting date in the schedule item.
tabIndex: [default: ""] The focusing order of the component by the Tab key.
themeColumn: [default:""] Column ID in the DataList which contain the theme to apply to the schedule of the ScheduleCalendar.
titleColumn: [default:""] The title of the schedule item in the ScheduleCalendar.
tooltipDisplay: [default:false, true] Displays tooltip based on the user’s selection.
version: [default:2.3, 3.6] Library version to be used in the ScheduleCalendar. The default is fullCalendar 2.3.2.

Event Summary

onclick: Triggered upon clicking of the date.

Method Summary

addClass( className ): Adds a CSS class to the component.
addSchedule( schedule ): Adds a schedule item to the calendar.
bind( eventType , function ): Dynamically allocate an event and the handler function to the component.
changeClass( oldClassName , newClassName ): Changes the class currently applied to the corresponding WebSquare component. (Supported in all WebSquare components.)
changeView( view ): Changes the view of the ScheduleCalendar.
focus( ): Focuses the WebSquare component.
getDataListInfo( ): Returns the dataList bound with the component.
getDisabled( ): Returns the current value of the disabled property.
getGenerator( ): In case generated by the Generator component, returns the parent Generator object that created the component itself.
getID( ): Returns the ID of the WebSquare component.
getInitStyle( CSS ): Returns the initial style of the WebSquare component.
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.
getReadOnly( ): Returns the current value of the readOnly property.
getScheduleInfo( id ): Returns the schedule information.
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, height) of the WebSquare component.
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.
getView( ): Gets the current view of the Schedule CAlendar.
gotoCalendar( dateStr ): Goes to a certain date.
hasClass( className ): Checks whether the WebSquare component has a certain class.
hide( ): Hides the WebSquare component. (Supported in all WebSquare components.)
removeClass( className ): Removes a class from the WebSquare component. (Supported in all WebSquare components.)
removeschedule( id ): Deletes a date from the calendar.
setDayNameStyle( options ): Sets the style for the day column of the calendar.
setDisabled( disabled ): Sets the disabled property of the WebSquare component.
setEventPause( evList , flag ): Pauses the event.
setHeaderBtn( Options ): Sets the buttons and titles on the upper-right and the upper-left parts of the calendar.
setInitStyle( property ): Restores the initial style of the WebSquare component.
setOpacity( value ): Sets the opacity in the WebSquare component. (Supported in all WebSquare components.)
setPosition( left , top , mode ): Sets the position (left, top) of the WebSquare component.
setReadOnly( readOnly ): Sets the readOnly proprety of the WebSquare component.
setSize( width , height ): Sets the size (width, height) of the WebSquare component.
setStyle( propertyName , value ): Sets the CSS of the WebSquare component.
setUserData( key , value ): Sets random data in the WebSquare component.
show( displayType ): Shows the WebSquare component on the page. (Supported in all WebSquare components.)
toggleClass( className ): Adds or removes a CSS class to or from a WebSquare component. (Supported in all WebSquare components.)
trigger( type , array ): Triggers the specified event in the WebSquare component.
unbind( type , function ): Removes the specified event from the WebSquare component.
visible( flag ): [deprecated]

Property Detail

class: Same as the class property in HTML standard. One or more classes defined in the CSS file or in the style block can be applied (through the use of the space as the separator).
WebSquare5 Engine applies different classes to different components. By defining a common class, the common class can be applied to multiple components.
cssRenderOrder: [default:false, true] Changes the CSS file rendering order of the the link tag in the document head to be rendered after the link tag of stylesheet_ext.css file.
Applied after the stylesheet_ext.css file.
dataList: [defulat:""] DataList to bind with the scheduleCalendar. The following is the dataList columns for the scheduleCalendar.
Four kinds - "idCol", "startCol", "endCol", and "titleCol". (The column ID is changeable.)
Set the dataList Id in the scheduleCalendar setting as well as "idColumn" and "startColumn" of the defined dataList.
For example, dataList1 is newly bound.
Four columns have been added to "dataList1", and column IDs are "idCol", "startCol", "endCol", and "titleCol".
Set the following in the scheduleCalendar.
dataList = "dataList1" idColumn = "idCol" startColumn = "startCol" endColumn = "endCol" titleColumn = "titleCol"
defaultDate: [default:""] Initial date to be displayed upon component loading. Must match with the ioFormat.
defaultView: [default:'month'] Sets the defaultView of the the ScheduleCalendar.
defaultView options include [ month, basicWeek, basicDay, agendaWeek, agendaDay ].
editable: [default:false, true] Edits the schedule items through mouse dragging and dropping.
Sets a function to change the starting and the ending dates.
endColumn: [default:""] Column ID of the DataList to be used as the end date in the ScheduleCalendar.
eventOrderColumn: [default:""] Column ID in the DataList based on which the schedule items in the ScheduleCalendar will be sorted.
headerLeftBtn: [default:true, false] Displays three buttons ("<", ">", and "Today") on the upper-left corner.
("<" - Displays previous month/week/day. ">" - Displays next month/week/day. "Today" - Displays current month/week/day.)
true (Default): Displays the buttons.
false: Hides the buttons.
headerRightBtn: [default:true, false] Displays the schedule unit buttons (“Month”, “Week”, and “Day”) on the upper-right corner.
("Month" - Shows monthly schedules. "Week" - Shows weekly schedules. "Day" - Shows daily schedules.)
true (Default): Displays the buttons.
false: Hides the buttons.
headerTitle: [default:true, false] Display of the header center title on the ScheduleCalanedar. [show, hide]
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
idColumn: [default:""] Column ID of the DataList to be used as the schedule item ID in the ScheduleCalendar.
ioFormat: [default:yyyyMMdd,MMddyyyy,ddMMyyyy] Sets the date format for start and end columns.
lang: [default:ko, en] Langauge.
locale: [default:ko, en] Set the language to use in the ScheduleCalanedar of which version is 3.6 or higher. In version 2.3, use the lang property.
selectable: [default:false, true] Allows selection of a certain date to create schedule items. (Generates a prompt window.)
The end user can drag multiple dates and set them as period.
startColumn: [default:""] Column ID of the DataList to be used as the starting date in the schedule item.
tabIndex: [default: ""] The focusing order of the component by the Tab key.
Same as the tabindex property in HTML.
themeColumn: [default:""] Column ID in the DataList which contain the theme to apply to the schedule of the ScheduleCalendar.
themeColumn must be in JSON format. The supported options include rendering, class, color, backgroundColor, borderColor, and textColor.
1. rendering: [ "" | "background" | "inverse-background" ] The method to render the schedule. (Default: "" )
2. class : Class to apply to the schedule (as an array or string).
3. color : Color of the schedule (in the formats such as red, #FF0000, rgb(0,0,0,0)). Once the color is set, the backgroundColor and the borderColor will be also applied.
4. backgroundColor : Background color. (Example: red, #ff0000, rgb(0, 0, 0, 0))
5. borderColor: Border color (Example: red, #ff0000, rgb(0, 0, 0, 0))
6. textColor: Text color (Example: red, #ff0000, rgb(0, 0, 0, 0))
(Example) dataList: data:dataList1, themeColumn: themeColumn, and themeColumn data is { "color":"yellow", "textColor":"#000000" }
Each schedule item will be displayed in black text on the yellow background bordered with yellow line.
titleColumn: [default:""] The title of the schedule item in the ScheduleCalendar.
tooltipDisplay: [default:false, true] Displays tooltip based on the user’s selection.
version: [default:2.3, 3.6] Library version to be used in the ScheduleCalendar. The default is fullCalendar 2.3.2.
"3.6" will load 3.6.2 version.

Event Detail

onclick

Triggered upon clicking of the date.
Returns the focused date upon clicking.

Parameter
name	type	description
retObj	JSON	Returns JSON containing start and end.

Sample

scwin.scheduleCalendar_onclick = function(retObj) { console.log("start = [" + retObj.start + "], end = [" + WebSquare.date.getFormattedDate(retObj.end, "yyyy-MM-dd") + "]"); };

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

addSchedule( schedule )

Adds a schedule to the calendar. When bound with the dataList. An object for the DataList column ID can be created and sent as a parameter.

Parameter
name	type	required	description
schedule	Object	Y	Schedule to add

Sample

// When bound with the dataList(columnID : "colTitle", "colEnd", "colId", "colStart"), use the following script. scheduleCalendar1.addSchedule({"colTitle": "Additional Title 2222","colEnd": "20171222","colId": "ADD_id_223","colStart": "20171222"}); // If not bound with the dataList, use the following script. scheduleCalendar1.addSchedule({"title": "Additional Title 2222","end": "20171222","id": "ADD_id_223","start": "20171222"});

bind( eventType , function )

Dynamically allocate an event and the handler function to the component. (Supported in all WebSquare components.)

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

Sample

// (Example 1) // Define a function for the onclick event of input1. input1.bind("onclick", function(e){ alert(input1.getValue();})); // (Example 2) // Define commObj.ev_click function in advance. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; // Dynamically allocate onclick event and the handler function to input1 component. input1.bind("onclick", commObj.ev_click );

changeClass( oldClassName , newClassName )

Changes the class currently applied to the corresponding WebSquare component. (Supported in all WebSquare components.)
Only the classes added by addClass can be changed.
In order to remove classes directly defined in the class propert of the WebSquare component, add the following in config.xml. // Add the following in config.xml.

Parameter
name	type	required	description
oldClassName	String	Y	Class to change
newClassName	String	Y	Class to newly use

Sample

// The class is directly defined in the inputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following in config.xml. <style> <removeDefaultClass value="true" /> </style> // The class can be changed. (Change the class from tmpInputClass to tmpInputWarninClass.) input1.changeClass("tmpInputClass","tmpInputWarninClass");

changeView( view )

Changes the view of the ScheduleCalendar.

Parameter
name	type	required	description
view	String	Y	Type of the view to change. ( month, basicWeek, basicDay, agendaWeek, agendaDay )

Sample

sheculeCalendar1.changeView("basicWeek");

focus( )

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

getDataListInfo( )

Returns the dataList bound with the component.

Return
type	description
Object	Returns nodeset, label, and value id as an object.

Sample

// Example scheduleCalendar1.getDataListInfo();

getDisabled( )

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

Return
type	description
Boolean	Value of the disabled property

Sample

// (Example) Check the current value of the disabled property. var returnValue = componentId.getDisabled(); // (Return) false

getGenerator( )

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

Return
type	description
Object	Parent Generator object

Sample

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

getID( )

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

Return
type	description
String	WebSquare component ID

Sample

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

getInitStyle( CSS )

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

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

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

getScheduleInfo( id )

Returns the schedule information.

Parameter
name	type	required	description
id	String	Y	ID of the schedule

Return
type	description
Object:Y	Event schedule (Object containing id, title, start, and end data)

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, height) of the WebSquare component. (Supported in all WebSquare components.) If set in %, the value will be converted into pixels.

Parameter
name	type	required	description
sizeName	String	Y	[height, innerHeight, outerHeight, outerMarginHeight, width, innerWidth, outerWidth, outerMarginWidth] Position type. For the details, see 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 ) "Input 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"); // (Reurn) "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"

getView( )

Gets the current view of the Schedule Calendar.

Sample

sheculeCalendar1.getView(); // { name: "", title: "", intervalStart: "", intervalEnd: "" }

gotoCalendar( dateStr )

Goes to a certain date.

Parameter
name	type	required	description
dateStr	String	Y	Date to go to

Sample

shecule1.gotoCalendar("20171013");

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

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

removeschedule( id )

Deletes a date from the calendar. If ID column is not found in the DataCollection, the title will be used instead of the ID.

Parameter
name	type	required	description
id	String	Y	ID of the schedule item

setDayNameStyle( options )

Define the style to apply to the day column of the calendar.

Parameter
name	type	required	description
options	Object	Y	Style

Sample

var options = { sun : { header : { "color":"#ff0000" }, body : { background : { "background-color":"#ff0000","opacity":"0.2" }, num: { "color" : "#0000ff" } } } }; scheduleCalendar1.setDayNameStyle(options);

setDisabled( disabled )

Sets the disabled property of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
disabled	Boolean	Y	Setting of the disabled property. (true: Used. false: Not used.)

Sample

// Sets the disabled property in the component. componentId.setDisabled(true);

setEventPause( evList , flag )

Pauses the event. (Supported in all WebSquare components.)

Parameter
name	type	required	description
evList	String	N	List of the events to pause. (in case of null, all events of the corresponding WebSquare component is paused or restarted.)
flag	Boolean	Y	Whether to pause the event or not. (true: Pause. false: Restart.)

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

setHeaderBtn( Options )

Sets the buttons on the upper-right and the upper-left corners and the title.

Parameter
name	type	required	description
Options	Object	Y	Header button setting

Sample

scheduleCalendar1.setHeaderBtn({headerLeftBtn:false,headerRightBtn:false,headerTitle:false});

setInitStyle( property )

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

Parameter
name	type	required	description
property	String	N	CSS property (If not spcified, all properties will be restored.)

Sample

// (Example) group1.setInitStyle();

setOpacity( value )

Sets the opacity in the WebSquare component. (Supported in all WebSquare components.)
The engine sets the opacity property (of CSS).

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

Sample

// (Example) Set the opacity as 0.45. componentId.setOpacity(0.45);

setPosition( left , top , mode )

Sets the position (left, top) of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
left	Number	Y	Left position value or null
top	Number	Y	Top position value or null
mode	String	N	[default: absolute, delta]

Sample

// (Example) Set the top position as 100px. componentId.setPosition(null, 100);

setReadOnly( readOnly )

Sets the readOnly proprety of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
readOnly	Boolean	Y	Setting of the readOnly property. (true: Used. false: Not used.)

Sample

// Set the readOnly property as true. componentId.setReadOnly(true);

setSize( width , height )

Sets the size (width, height) of the WebSquare component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
width	Number	Y	Width of the component or null.
height	Number	Y	Height of the component or null.

Sample

// (Example) Set the height of the component as 100px. componentId.setSize(null,100);

setStyle( propertyName , value )

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

Parameter
name	type	required	description
propertyName	String	Y	CSS property to set.
value	String	Y	Value to set as the specified CSS property

Sample

// (Example 1) Set the width as 200px. componentId.setStyle("width", "200px"); // (Example 2) Set the background as olive. componentId.setStyle("background-color","olive");

setUserData( key , value )

Sets random data in the WebSquare component. (Supported in all WebSquare components.) Enter key values supported by the component. In case a key value not supported by the component is entered, corresponding logs will be displayed.

Parameter
name	type	required	description
key	String	Y	Data key to set
value	String	Y	Defined data value

Sample

// Set 'data' key and 'WebSquare' value in the component. componentId.setUserData("data", "WebSquare"); // The key must be supported in the component. componentId.setUserData("title", "WebSquare"); // Following logs will be displayed. // !!!WARNING - [title] can't be defined as UserData.

show( displayType )

Shows the WebSquare component on the page. (Supported in all WebSquare components.)
Sets the display property as specified and applies "visibility: show;" CSS.

Parameter
name	type	required	description
displayType	String	N	[default: block, inline, none, ""] CSS display setting.

Sample

// (Example) display: block; componentId.show(); // (Example) Restore the previous display setting. componentId.show("");

toggleClass( className )

Adds or removes a CSS class to or from a WebSquare component. (Supported in all WebSquare components.)
Removes the class from the WebSquare component.
If the WebSquare component does not have the specified class, adds the class.
Only the classes added by addClass can be removed.
In order to remove classes directly defined as a property of the component, add the following in config.xml. // Add the following in config.xml. <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	Class to add or remove

Sample

// The class is directly defined in the inputBox component. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // Add the following in config.xml. <style> <removeDefaultClass value="true" /> </style> // Remove tmpInputClass class. input1.toggleClass("tmpInputClass"); // Add the (previously removed) tmpInputClass. input1.toggleClass("tmpInputClass");

trigger( type , array )

Triggers a certain event in the component. (Supported in all WebSquare components.)

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

Sample

// (Example 1) // Trigger the onclick event in input1 component. input1.trigger("onclick"); // (Example 2) // Trigger the onviewchange event in input1, and send (1, 2) parameter to the handler function. input1.trigger("onviewchange", [1,2]);

unbind( type , function )

Removes the event from the component. (Supported in all WebSquare component.)

Parameter
name	type	required	description
type	String	N	Event to remove. (If not specified, all events of the component will be removed.)
function	Function	N	Handler function of the event to remove. (If not specified, all handler functions of the event will be removed.)

Sample

// (Example 1) // Remove all events registered in the input1 component. input1.unbind(); // (Example 2) // Remove all handler functios 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