WebSquare.uiplugin.calendar

Calendar. Displays the calendar. The user can change the calendar skin design with the calendarClass property. The user can select the calendar type with the calendarValueType property. At the top is used <div>, and directly changing the component style is not recommended. Using the calendarClass property is recommended to change the style.

Type

uiplugin

Property Summary

calendarClass: [default:class1, class2, class3, class4, class5] Skin type of the calendar.
calendarValueType: [default:yearMonthDate, yearMonth, yearMonthDateHour, yearMonthDateTime, yearMonthDateTimeSec] Date and time displaying type.
cancelButtonShow: [default:false, true] Shows the Cancel (X) button on the lower-right corner of the component.
caption: Sets the caption tag in HTML. (The Calendar component uses the table tag.)
delimiter: [default:/] String to separate year, month, and day.
displayDayType: Decides how to display days on the calendar in image or text. [default: image, text]
displayFormat: Sets the date format to be displayed under the calendar.
displayFormatFunc: Receives the name of the function, and sets the displayFormat with the return of the function. Sends the calendarValueType as a parameter when calling the function.
displayHrMinSec: [default:false, true] Displays hour, minute, and second when the calendarValueType is yearMonthDateTime.
footerDiv: [default:false, true] Uses the div tag to display the user-selected date on the calendar.
highlightSelectedWeek: Highlights the week of the selected date. [default: false, true]
id: Component ID
maxYear: The highest year in the calendar.
minYear: The lowest year in the calendar.
monthNames: The names of the months. Separate month names by comma.
ref: Value path of the DataCollection. Used with a purpose to bind a DataCollection with a WebSquare component.
renderType: [default:component, native] Decides the the layout structure rendering method.
skipConfirm: [default: false, true] IF the user selects a month, the selection will be automatically set (without the Confirm button being displayed so that the user does not need to click the Confirm button.)
skipConfirmOnly: [default: false, true] The user can select a month by clicking arrow buttons such as << < > >> and the selected month will be automatically set. (The Confirm button will be displayed.)
summary: Similar to the summary property of the table tag in HTML.
tabIndex: The focusing order by the Tab key.
title: Same as the class property in HTML.
tooltip: Text to be displayed upon the end user’s hovering the mouse over the component.
tooltipLocaleRef: Text key for the tooltip in case the tooltip text is provided in multiple languages.
topLayout: [default: false, true] Moves Today and Close buttons to the top-right corner.
useMonthSelect: [default:true, false] Allows the end user to select the month when the calendarValueType is yearMonthDate. When not allowed, the user's clicking year selection box will not function.
userData1: User-defined property
userData2: User-defined property
userData3: User-defined property
useYearSelect: [default:true, false] Allows the end user to select the year when the calendarValueType is yearMonthDate. When not allowed, the user's clicking year selection box will not function.
visibleHourList: [default:1,2,...,23,24] Hour items. Use [,] as the delimiter.
visibleMinList: [default:1,2,...,59,60] Minute items. Use [,] as the delimiter.
visibleSecList: [default:1,2,...,59,60] Second items. Use [,] as the delimiter.
visibleWeekNum: Sets the number of the weeks to display on the calendar.
weekStartsOn: [default:0, 1, 2, 3, 4, 5, 6] Starting day of the week (0: Sunday, ..., 6: Saturday)
yearSuffix: String to be added after the year.

Event Summary

oncancel: Triggered upon the end user's clicking the cancellation button which is displayed when the cancelButtonShow is true.
onchange: Triggered upon a change in the date by the user's selection or by API.
onclick: Triggered upon the end user's clicking the calendar.
onconfirm: Triggered upon the end user's clicking the confirmation button.
ondateselect: Triggered upon the end user's selecting a date.
ondblclick: Triggered upon the end user's double-clicking the calendar.
onviewchange: Triggered when the value on the list is changed through keyboard input or mouse clicking.

Method Summary

addClass( className ): Adds a CSS class to the component.
bind( eventType , function ): Dynamically allocate an event and the handler function to the component.
changeClass( oldClassName , newClassName ): Changes the class currently applied to the corresponding WebSquare component. (Supported in all WebSquare components.)
disableAfterDate( dateStr ): Disables the dates after the inputted date.
disableBeforeDate( dateStr ): Disables the dates before the inputted date.
disableDate( dateStr ): Disables certain dates.
enableAllDate( ): Enables the dates disabled by the properties of disableAfterDate and disableBeforeDate.
enableDate( dateStr ): Enables certain dates.
focus( ): Focuses the WebSquare component.
getDataListInfo( ): Returns the dataList bound with the component.
getDateFormat( ): [default:yyyyMMdd] Gets the defined dateFormat.
getDisabled( ): Returns the current value of the disabled property.
getFormattedValue( ): Returns the currently selected date in the define dateFormat.
getGenerator( ): In case generated by the Generator component, returns the parent Generator object that created the component itself.
getID( ): Returns the ID of the WebSquare component.
getInitStyle( CSS ): Returns the initial style of the WebSquare component.
getOpacity( ): Returns the opacity of the WebSquare component. (Supported in all WebSquare components.)
getOriginalID( ): Returns the originalID of the WebSquare component. (Supported in all WebSquare components.)
getPluginName( ): Returns the name of the WebSquare component.
getPosition( positionName ): Returns the position (left and top) of the WebSquare component. (Supported in all WebSquare components.)
getReadOnly( ): Returns the current value of the readOnly property.
getScope( ): For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
getScopeWindow( ): For the child component of a scope="true" WFrame, returns the parent WFrame object. (Supported in all WebSquare components.)
getSelectedDay( ): Returns the currently selected day in lower-case characters.
getSize( sizeName ): Sets the size (width and height) of the WebSquare component. (Supported in all WebSquare components.)
getStyle( propertyName ): Returns the CSS setting of the WebSquare component.
getStyleValue( style ): [deprecated]
getTitle( ): Returns the title of the WebSquare component.
getUdcHome( ): Returns the path of the UDC file including the file name in which the UDC object is defined. (Supported in all WebSquare components.)
getUdcRoot( ): Returns the path of the UDC file in which the UDC object is defined. (Supported in all WebSquare components.)
getUserData( key ): Returns the value set by setUserData or directly defined by the user in the XML file.
getValue( ): Gets the value of the selected date.
gotoCalendar( dateStr ): Goes to the date of the specified dateStr on the calendar.
gotoLastMonth( ): Goes to the date that is one month prior to the selected date on the calendar.
gotoLastYear( ): Goes to the date that is one year prior to the selected date on the calendar.
gotoMonth( month ): Goes to the selected month on the calendar.
gotoNextMonth( ): Goes to the date that is one month after the selected date on the calendar.
gotoNextYear( ): Goes to the date that is one year after the selected date on the calendar.
gotoTime( hour , minute ): Goes to the selected time.
gotoToday( ): Goes to the present date on the calendar.
gotoYear( year ): Goes to the selected year on the calendar.
hasClass( className ): Checks whether the WebSquare component has a certain class.
hide( ): Hides the component.
removeAllCellClass( ): Initializes all classes of the date to which setCellClass is applied.
removeCellClass( dateStr ): Removes the class set for a certain date by setCellClass.
removeClass( className ): Removes a class from the WebSquare component. (Supported in all WebSquare components.)
setCellClass( dateStr , className ): Sets a class on the selected date.
setDateFormat( format ): Sets the dateFormat. Use getFormattedValue to get the formatted value. Depending on the calendarValueType, some strings cannot be used in the format.
setDisabled( disabled ): Sets the disabled property.
setEventPause( evList , flag ): Pauses the event.
setHoliday( dateStr ): Sets a holiday to a certain date.
setHolidayRef( setHolidayRef ): Sets the holidayRef property. To bind with the DataCollection, add "data:" prefix.
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.
setSkin( skinName ): Selects the skin to use.
setStyle( propertyName , value ): Sets the CSS of the WebSquare component.
setUserData( key , value ): Sets random data in the WebSquare component. (Supported in all WebSquare components.)
show( displayType ): Displays the component on the page.
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

calendarClass: [default:class1, class2, class3, class4, class5] Skin type of the calendar.
calendarValueType: [default:yearMonthDate, yearMonth, yearMonthDateHour, yearMonthDateTime, yearMonthDateTimeSec] Date and time displaying type.
cancelButtonShow: [default:false, true] Shows the Cancel (X) button on the lower-right corner of the component.
Use the oncancel event to define the logic for the clicking event of the Cancel button.
caption: Sets the caption tag in HTML. (The Calendar component uses the table tag.)
delimiter: [default:/] String to separate year, month, and day.
displayDayType: Decides how to display days on the calendar in image or text. [default: image, text]
displayFormat: Sets the date format to be displayed under the calendar.
displayFormatFunc: Receives the name of the function, and sets the displayFormat with the return of the function. Sends the calendarValueType as a parameter when calling the function.
Will be ignored when the displayFormat is defined.
displayHrMinSec: [default:false, true] Displays hour, minute, and second when the calendarValueType is yearMonthDateTime.
footerDiv: [default:false, true] Uses the div tag to display the user-selected date on the calendar.
highlightSelectedWeek: Highlights the week of the selected date. [default: false, true]
id: Component ID
The component ID is allocated as a global object. The script can access each object through the component ID.
maxYear: The highest year in the calendar. The default is the maxYear value under calendar node in config.xml.
minYear: The lowest year in the calendar. The default is the minYear value under calendar node in config.xml.
monthNames: The names of the months. Separate month names by comma.
ex) Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
ref: Value path of the DataCollection. Used with a purpose to bind a DataCollection with a WebSquare component.
(Format: data: [DataCollection ID].[Key id or Column id])
When bound with a DataList, the value of the selected row in the GridView will be bound.

Specify the XPath of the XML data to interface with the instance data.
renderType: [default:component, native] Decides the the layout structure rendering method.
component : Uses div and table tags. Not recommended for web accessibility.
native : Uses the select tag of HTML to display the select box and the button tags for numbers and buttons on the calendar. Recommended for web accessibility.
skipConfirm: [default: false, true] IF the user selects a month, the selection will be automatically set (without the Confirm button being displayed so that the user does not need to click the Confirm button.)
true: Automatically set without the user’s clicking the Confirm button.
false (Default): Set upon the user’s clicking the Confirm button.
skipConfirmOnly: [default: false, true] The user can select a month by clicking arrow buttons such as << < > >> and the selected month will be automatically set. (The Confirm button will be displayed.)
true: Automatically set the selected month. (The Confirm button is displayed.)
false (Default): Set upon the user’s clicking the Confirm button after selecting a month.
summary: Similar to the summary property of the table tag in HTML. Mostly used to enhance web accessibility.
tabIndex: The focusing order by the Tab key.
Same as the tabindex property in HTML.
title: Same as the title property in HTML. The title is displayed upon the end user’s moving the mouse over the component. Generally used to support web accessibility.
tooltip: Text to be displayed upon the end user’s hovering the mouse over the component. Provided by WebSquare, and specifies additional information of the component.
tooltipLocaleRef: Text key for the tooltip in case the tooltip text is provided in multiple languages.
When there is no text for the key, "global_undefined" will be displayed on the screen.
topLayout: [default: false, true] Moves Today and Close buttons to the top-right corner.
true: Displays Today and Close buttons on the top-right corner. false: Displays in the original location (lower part of the component.)
useMonthSelect: [default:true, false] Allows the end user to select the month when the calendarValueType is yearMonthDate. When not allowed, the user's clicking year selection box will not function.
When not allowed, the user's clicking year selection box will not function.
userData1: User-defined property. Use getUserData("userData3") to get the data.
userData2: User-defined property. Use getUserData("userData2") to get the data.
userData3: User-defined property. Use getUserData("userData3") to get the data.
useYearSelect: [default:true, false] Allows the end user to select the year when the calendarValueType is yearMonthDate. When not allowed, the user's clicking year selection box will not function.
When not allowed, the user's clicking year selection box will not function.
visibleHourList: [default:1,2,...,23,24] Hour items. Use [,] as the delimiter.
(ex) In case of calendarValueType="yearMonthDateTime", visibleHourList="5,10,15,20", [5,10,15,20] will be displayed.
visibleMinList: [default:1,2,...,59,60] Minute items. Use [,] as the delimiter.
(ex) In case of calendarValueType="yearMonthDateTime", visibleMinList="0,5,10,15,20,25,30,35,40,45,50,55", only the multiples of 5 will be displayed.
visibleSecList: [default:1,2,...,59,60] Second items. Use [,] as the delimiter.
(ex) In case of calendarValueType="yearMonthDateTime", visibleSecList="0,5,10,15,20,25,30,35,40,45,50,55", only multiples of 5 will be displayed.
visibleWeekNum: Sets the number of the weeks to display on the calendar.
weekStartsOn: [default:0, 1, 2, 3, 4, 5, 6] Starting day of the week (0: Sunday, ..., 6: Saturday)
yearSuffix: String to be added after the year.
Enter $blank to use empty space.

Event Detail

oncancel

Triggered upon the end user's clicking the cancellation button which is displayed when the cancelButtonShow is true.

Sample

// Clicking the cancellation button will move to 2002-Apr-15. this.gotoCalendar("20020415"); // Use this to directly access the Calendar component within the event handler.

onchange

Triggered upon a change in the date by the user's selection or by API.
For the changes triggered by the user's action only, use the onviewchange event.

onclick

Triggered upon the end user's clicking the calendar.

Parameter
name	type	description
e	Object	Event object

onconfirm

Triggered upon the end user's clicking the confirmation button. When the calendarValueType is yearMonthDate, the onconfirm event is only triggered by the configmration button.

ondateselect

Triggered upon the end user's selecting a date.

Parameter
name	type	description
dateStr	String	Selected date
dateObj	Date	Date object of the selected date

Sample

// Parameters upon the end user's selecting 2002-Apr-15. dateStr : "20020415" (String object) dateObj : Mon Apr 15 2002 00:00:00 GMT+0900 (Date object)

ondblclick

Triggered upon the end user's double-clicking the calendar.

Parameter
name	type	description
e	Object	Event object

onviewchange

Triggered when the value on the list is changed through keyboard input or mouse clicking.
In case the change was made by a script, the event will not be triggered. (Similar to the native onchange event.)

Parameter
name	type	description
info	JSON	Returns JSON data containing oldValue and newValue.

Sample

// Upon user's changing the date from 2002-Apr-15 to 2099-Dec-31. <script ev:event="onviewchange( info )"><![CDATA[ var oldValue = info.oldValue; //이전 값 //return 예시 ) "20020415" var newValue = info.newValue; //선택 된 값 //return 예시 ) "20991231" ]]></script>

Method Detail

addClass( className )

Adds a CSS class to the component. (Supported in all WebSquare components.)

Parameter
name	type	required	description
className	String	Y	Name of the class to add

Sample

// (Example) // Add oddClass to input1 component. input1.addClass("oddClass");

bind( eventType , function )

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

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

Sample

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

changeClass( oldClassName , newClassName )

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

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

Sample

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

disableAfterDate( dateStr )

Disables the dates after the inputted date.

Parameter
name	type	required	description
dateStr	String	Y	Date after which dates will be disabled

Sample

calendar.disableAfterDate("20170410"); // (Display) Dates after Aril 1 2017 will be disabled and cannot be selected.

disableBeforeDate( dateStr )

Disables the dates before the inputted date.

Parameter
name	type	required	description
dateStr	String	Y	Date before which dates will be disabled

Sample

calendar.disableBeforeDate("20170410"); // (Display) Dates before April 10 2017 will be disabled.

disableDate( dateStr )

Disables certain dates.

Parameter
name	type	required	description
dateStr	String	Y	Date(s) to disable

Sample

calendar1.disableDate("20160627 20180627"); or to disable all dates. Use calendar1.disableDate("*");. (However, note that the dates enabled by enableDate API will not be disabled.)

enableAllDate( )

Enables the dates disabled by the properties of disableAfterDate and disableBeforeDate.

Sample

calendar.enableAllDate(); // (Result) All disabled dates will be enabled and become selectable.

enableDate( dateStr )

Enables certain dates.

Parameter
name	type	required	description
dateStr	String	Y	Date(s) to enable

Sample

calendar1.enableDate("20160627 20180627"); // Enagles the dates of 2016-06-27 and 2018-06-27. calendar1.enableDate("*"); // Enables all dates exept those disabled by the disableDate API.

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 calendar1.getDataListInfo();

getDateFormat( )

[default:yyyyMMdd] Gets the defined dateFormat.

Return
type	description
String	dateFormat string such as yyyy/MM/dd or yyyy-MM-dd"

Sample

// If dateFormat has not been specified by setDateFormat, var returnValue = calendar1.getDateFormat(); // (Return Example) "yyyyMMdd"

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 Example) false

getFormattedValue( )

Returns the currently selected date in the define dateFormat.
If dateFormat is not applied, date and time information will be returned without separators. (Depending on the calendarValueType, the date and time format will differ.)
(Remarks) Use setDateFormat to set the dateFormat.

Return
type	description
String	Formatted date string

Sample

// No dateFormat is applied, and the current selection is 2002-Apr-15. // No dateFormat is applied, and the current selection is 2002-Apr-15. var tmpRs1 = calendar1.getFormattedValue(); // (Return Example) "20020415" // calendarValueType="yearMonth" var tmpRs2 = calendar1.getFormattedValue(); // (Return Example) "200204" // Apply the dateFormat. (Use setDateFormat depending on the calendarValueType option. See setDateFormat.) calendar1.setDateFormat("yyyy MM-dd"); // No dateFormat is applied, and the current selection is 2002-Apr-15. var tmpRs3 = calendar1.getFormattedValue(); // (Return Example) ""2002 04-15""

getGenerator( )

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

Return
type	description
Object	Parent Generator object

Sample

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

getID( )

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

Return
type	description
String	WebSquare component ID

Sample

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

getInitStyle( CSS )

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

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

getOpacity( )

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

Return
type	description
Integer	Opacity

Sample

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

getOriginalID( )

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

Return
type	description
String	originalID of the component

Sample

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

getPluginName( )

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

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

Sample

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

getPosition( positionName )

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

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

Return
type	description
Number	Position of the component

Sample

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

getReadOnly( )

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

Return
type	description
Boolean	The current setting of the readOnly property

Sample

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

getScope( )

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

Return
type	description
Object	WFrame object or null

Sample

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

getScopeWindow( )

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

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

Sample

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

getSelectedDay( )

Returns the currently selected day in lower-case characters.
If not specified, "" (empty string) will be returned.

Return
type	description
String	[sunday, monday, tuesday, wednesday, thursday, friday, saturday] Day string

Sample

// Current selection: 2011-Jan-01 var returnValue = calendar1.getSelectedDay(); // (Return Example) "saturday"

getSize( sizeName )

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

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

Return
type	description
Number	Size of the component

Sample

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

getStyle( propertyName )

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

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

Return
type	description
String	CSS value

Sample

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

getStyleValue( style )

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

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

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

getTitle( )

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

Return
type	description
String	Title

Sample

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

getUdcHome( )

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

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

Sample

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

getUdcRoot( )

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

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

Sample

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

getUserData( key )

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

Parameter
name	type	required	description
key	String	Y	Data key

Return
type	description
String	Value for the given key

Sample

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

getValue( )

Gets the value of the selected date.

Return
type	description
String	String without delimiters

Sample

// Current selection: 2011-Jan-01 // In case the calendarValueType is yearMonthDate or not specified, the return will be in yyyyMMdd format. var returnValue = calendar1.getValue(); // (Return Example) "20110101" // In case the calendarValueType is yearMonth, the return will be in yyyyMM format. // (Return Example) "201101" In case the calendarValueType is yearMonthDateTime, the return will be in yyyyMMddHHmm format. // (Return Example) "201101010000" In case the calendarValueType is yearMonthDateTimeSec, the return will be in yyyyMMddHHmmss format. // (Return Example) "20110101000000"

gotoCalendar( dateStr )

Goes to the date of the specified dateStr on the calendar.
dateStr is in yyyyMMdd format without delimiters.

Parameter
name	type	required	description
dateStr	String	Y	Date to go to (in yyyyMMdd format)

Sample

// Go to 2002-Apr-15. calendar1.gotoCalendar("20020415");

gotoLastMonth( )

Goes to the date that is one month prior to the selected date on the calendar.

Sample

// Current selection: 2011-Jan-01 calendar1.gotoLastMonth(); // (Display Example) 2010-Dec-01 will be selected.

gotoLastYear( )

Goes to the date that is one year prior to the selected date on the calendar.

Sample

// Current selection: 2011-Jan-01 calendar1.gotoLastYear(); // (Display Example) Jan 01 2010 will be selected.

gotoMonth( month )

Goes to the selected month on the calendar.
If not valid, moves to the first month (1).

Parameter
name	type	required	description
month	String\|\|Number	Y	Month to go to ("02", "2", and 2 are all to go to February.)

Sample

// Current selection: 2011-Jan-01 calendar1.gotoMonth(5); // "05" , "5" , and 5 are all same. // (Display Example) May-01-2011 will be selected.

gotoNextMonth( )

Goes to the date that is one month after the selected date on the calendar.

Sample

// Current selection: 2011-Jan-01 calendar1.gotoNextMonth(); // (Display Example) 2011-May-01 will be selected.

gotoNextYear( )

Goes to the date that is one year after the selected date on the calendar.

Sample

// Current selection: 2011-Jan-01 calendar1.gotoNextYear(); // (Display Example) 2012-Jan-01 will be selected.

gotoTime( hour , minute )

Goes to the selected time.
If not valid, initial hour (0) and initial minute (0) will be selected.

Parameter
name	type	required	description
hour	Number\|\|String	Y	Hour to go to.("02", "2", and 2 are all to set two o'clock.)
minute	Number\|\|String	Y	Minute to go to.("05", "5", and 5 are all to set minute 5.)

Sample

// Can be used for a calendar of yearMonthDateTime type. calendar1.gotoTime("01","11"); // All of "01", "1", and 1 are for one o'clock. // (Display Example) Goes to 1:11.

gotoToday( )

Goes to the present date on the calendar.

Sample

// Create same effects such as clicking Today or Now on the calendar of the yearMonthDate format. calendar1.gotoToday();

gotoYear( year )

Goes to the selected year on the calendar.
If not valid, the first year will be selected.

Parameter
name	type	required	description
year	String\|\|Number	Y	Year to go to.("2002", and 2002 are all to go to 2002.)

Sample

// Current selection: 2011-Jan-01 calendar1.gotoYear("2020"); // (Display Example) 2020-Jan-01 will be selected.

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

removeAllCellClass( )

Initializes all classes of the date to which setCellClass is applied.

Sample

// Define tmpColor01 class in the style. <style type="text/css"><![CDATA[ .tmpColor01{ color:orange; } ]]></style> calendar1.setCellClass( "20151015","tmpColor01" ); calendar1.setCellClass( "20150915","tmpColor01" ); calendar1.setCellClass( "20150815","tmpColor01" ); calendar1.removeAllCellClass(); // All classes will be removed from the cells.

removeCellClass( dateStr )

Removes the class set for a certain date by setCellClass.

Parameter
name	type	required	description
dateStr	String	Y	Date for which the class is set

Sample

// Define tmpColor01 class in the style. <style type="text/css"><![CDATA[ .tmpColor01{ color:orange; } ]]></style> calendar1.setCellClass("20020415", "tmpColor01"); calendar1.removeCellClass("20020415"); // (Display Example) The date of 2002-Apr-15 will be displayed in orange.

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

setCellClass( dateStr , className )

Sets a class on the selected date.

Parameter
name	type	required	description
dateStr	String	Y	Date for which the class is set
className	String	Y	Name of the class to set

Sample

// Define tmpColor01 class in the style. <style type="text/css"><![CDATA[ .tmpColor01{ color:orange; } ]]></style> calendar1.setCellClass("20020415", "tmpColor01"); // (Display Example) The date of 2002-Apr-15 will be displayed in orange color.

setDateFormat( format )

Sets the dateFormat. Use getFormattedValue to get the formatted value. Depending on the calendarValueType, some strings cannot be used in the format.
When the calendarValueType is yearMonthDate, yyyy, MM, and dd can be used.
When the calendarValueType is yearMonth, yyyy and MM can be used.
When the calendarValueType is yearMonthDateTime, yyyy, MM, dd, HH, and mm can be used.
When calendarValueType is yearMonthDateTimeSec, yyyy, MM, dd, HH, mm, and SS can be used.

Parameter
name	type	required	description
format	String	Y	dateFormat (A string like yyyy-MM-dd)

Sample

// The current selection is 2002-Apr-15. Apply the format. calendar1.setDateFormat("yyyy MM-dd"); // Return the formatted value. var tmpVal1 = calendar1.getFormattedValue(); // (Return Example) "2002 04-15" // Return the value. var tmpVal2 = calendar1.getValue(); // (Return Example) "20020415" // Not formatted.

setDisabled( disabled )

Sets the disabled property.

Parameter
name	type	required	description
disabled	Boolean	Y	Disabled status

Sample

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

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

setHoliday( dateStr )

Sets a holiday to a certain date.

Parameter
name	type	required	description
dateStr	String	Y	Date of the holiday

Sample

calendar1.setHoliday("20160627"); // calendar1.setHoliday("*0815"); is to set the holiday for all years. // (Display Example) The date of 2016-Jun-27 will be displayed in red.

setHolidayRef( setHolidayRef )

Sets the holidayRef property. To bind with the DataCollection, add "data:" prefix.
If not specified, XPath of the InstanceData will be used.

Parameter
name	type	required	description
setHolidayRef	String	Y	Path of the setHolidayRef to apply.

Sample

// Set holidays in col of dataList1 in the Calendar component. calendar.setHolidayRef("data:dataList1.col1"); // Bind with test/holiday of the InstanceData. calendar.setHolidayRef("test/holiday");

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	Position setting method. [default: absolute, delta]

Sample

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

setReadOnly( readOnly )

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

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

Sample

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

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

setSkin( skinName )

Selects the skin to use.

Parameter
name	type	required	description
skinName	String	Y	[class1, class2, class3, class4, class5] Name of the skin to use.

Sample

calendar1.setSkin("class2");

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 )

Displays the component on the page.

Parameter
name	type	required	description
displayType	String	N	Value of the display property

toggleClass( className )

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

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

Sample

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

trigger( type , array )

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

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

Sample

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

unbind( type , function )

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

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

Sample

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

visible( flag )

[deprecated]
Use show/hide or setStyle instead.
The Engine sets the CSS visibility property.

Parameter
name	type	required	description
flag	Boolean	Y	CSS visibility setting