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).
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.
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.
headerLeftBtn: [default:true, false] Display of the header left button on the ScheduleCalendar. [show, hide]
headerRightBtn: [default:true, false] Display of the header right button on the ScheduleCalendar. [show, hide]
headerTitle: [default:true, false] Display of the header center title on the ScheduleCalanedar. [show, hide]
id: ID of the component. Allocated as a global object. Scripts access the component through the 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.
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:""] Same as the tabindex property in HTML standard. Indicates the focusing order of the component by the tab key.
titleColumn: [default:""] The title of the schedule item in the ScheduleCalendar.
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 class to the component.
addSchedule( Schedule ): Adds a schedule item to the calendar.
bind( eventType , function ): Dynamically allocates events to the component.
changeClass( oldClassName , newClassName ): Renames the class from oldClassName to newClassName.
focus( ): Moves the focus to the component.
getDataListInfo( ): Returns the list of the datalists bound with 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.
getInitStyle( property ): Gets the initial style 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.
getScheduleInfo( id ): Returns the schedule information.
getScope( ): Returns the parent WFrame object when the component is a child of the WFrame which uses the scope feature (scope=true).
getScopeWindow( ): Returns the scope object of the parent when the component is a child of the WFrame which uses the scope feature (scope=true).
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).
gotoCalendar( dateStr ): Goes to a certain date.
hasClass( className ): Checks whether the component has className received as a parameter or not.
hide( ): Hides the component.
removeClass( className ): Removes className from the component.
removeschedule( id ): Deletes a date from the calendar.
setDayNameStyle( header, ): Sets the style in the day column of the calendar.
setDisabled( disabled ): Sets the disabled property.
setEventPause( evList , flag ): Disables or enables the component event.
setHeaderBtn( option.headerLeftBtn ): Sets the header button in the calendar.
setInitStyle( property ): Initializes the component style.
setOpacity( value ): Sets the opacity of the component.
setPosition( left , top , mode ): Sets the position (left, top) of the component.
setReadOnly( readOnly ): Controls the "readOnly" property.
setSize( width , heigth ): Sets the size (width, height) of the component.
setStyle( propertyName , value ): Sets the style of the specified property.
setUserData( key , value ): Sets the user data in the component.
show( displayType ): Displays the component.
toggleClass( className ): Removes a class named className, or if there is no such a class, adds a class named className.
trigger( type , array ): Triggers a certain event registered for the component.
unbind( type , function ): Removes an event registered for the component.
visible( flag ): [deprecated] Shows/Hides the component, or sets the visible property using setStyle.

Property Detail

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.
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.
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.
headerLeftBtn: [default:true, false] Display of the header left button on the ScheduleCalendar. [show, hide]
headerRightBtn: [default:true, false] Display of the header right button on the ScheduleCalendar. [show, hide]
headerTitle: [default:true, false] Display of the header center title on the ScheduleCalanedar. [show, hide]
id: ID of the component. Allocated as a global object. Scripts access the component through the 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.
selectable: [default:false, true] Allows selection of a certain date to create schedule items. (Generates a propmpt 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:""] Same as the tabindex property in HTML standard. Indicates the focusing order of the component by the tab key.
titleColumn: [default:""] The title of the schedule item in the ScheduleCalendar.
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 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");

addSchedule( Schedule )

Add a schedule to the calendar. When binding with a dataList, create an object suitable for the column ID of the dataList and send it as a parameter.

Parameter
name	type	required	description
Schedule	Object	Y

Sample

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

bind( eventType , function )

Dynamically allocates events to the component.

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

Sample

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

changeClass( oldClassName , newClassName )

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

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

Sample

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

focus( )

Moves the focus to the component.

getDataListInfo( )

Returns the list of the datalists bound with the component.

Return
type	description
Object:Y	dataList info

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

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

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

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

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"

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

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

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( header, )

Sets the style in the day column of the calendar.

Parameter
name	type	required	description
header,	Object	Y	body

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

setHeaderBtn( option.headerLeftBtn )

Sets the header button in the calendar.

Parameter
name	type	required	description
option.headerLeftBtn	Object	Y	, options.headerRightBtn, options.headerTitle

Sample

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

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

setOpacity( value )

Sets the opacity of the component.

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

Sample

componentId.setOpacity(0.45);

setPosition( left , top , mode )

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

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

Sample

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

setReadOnly( readOnly )

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

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

Sample

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

setSize( width , heigth )

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

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

Sample

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

setStyle( propertyName , value )

Sets the style of the specified property.

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

Sample

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

setUserData( key , value )

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

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

Sample

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

show( displayType )

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

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

Sample

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

toggleClass( className )

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

Parameter
name	type	required	description
className	String	Y	className to set

Sample

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

trigger( type , array )

Triggers a certain event registered for the component.

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

Sample

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

unbind( type , function )

Removes an event registered for the component.

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

Sample

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

visible( flag )

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

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