PropertyEventMethod찾아보기
WebSquare.uiplugin.calendar - 5.0_1.3521B.20190311.114514

기본 달력 컴포넌트로 calendarClass속성을 이용하여 달력의 스킨 변경이 가능하며 calendarValueType속성을 이용하여 1줄 달력, 시분초 선택이 포함 된 달력 등을 선택 할 수 있다.
최상위에 div Tag로 감싸고 있으며 컴포넌트의 style을 손쉽게 변경할 수 없는 구조로 되어있으므로 calendarClass속성을 활용하는 것을 추천한다.

Type

uiplugin

Property Summary

calendarClass
[default:class1, class2, class3, class4, class5]스킨 종류를 정의한다
calendarValueType
[default:yearMonthDate, yearMonth, yearMonthDateHour, yearMonthDateTime, yearMonthDateTimeSec]calendar의 표현 방법을 정의한다
cancelButtonShow
[default:false, true]X(취소)모양의 버튼 표시 여부 컴포넌트의 우측 하단에 표현된다.
caption
HTML caption Tag의 값을 설정한다
delimiter
[default:/]컴포넌트 하단에 나오는 선택 된 년월일 값에 대한 구분자를 설정한다
displayHrMinSec
[default:false, true] calendarValueType="yearMonthDateTime" 설정 시 selectbox에 시,분
footerDiv
[default:false, true]선택 된 날짜등이 있는 컴포넌트 하위 영역을 table Tag가 아닌 div Tag로 표현할지 여부
id
컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다
maxYear
calendar에 표시되는 최대연도로 config
minYear
calendar에 표시되는 최소연도로 config
monthNames
월에 해당하는 selectbox에 display값을 설정하는 기능으로 1월부터 12월의 display값을 ,(comma)로 구분하여 정의한다.
ref
DataCollection의 value 경로로 컴포넌트와 DataCollection의 value를 binding을 시킬 때 사용하며 "data:"라는 prefix는 필수로 붙여주어야 한다.
renderType
[default:component, native]컴포넌트의 레이아웃 구조를 설정한다.
skipConfirm
[default: false, true] 사용자가 월(month)을 선택할 경우 자동으로 값이 설정됨. (확인 버튼이 표시 되지 않고 사용자는 확인 버튼을 클릭할 필요가 없음.)
skipConfirmOnly
[default: false, true] << < > >> 버튼을 선택하여 연도 및 월을 선택하는 월(month) 목록에서 직접 월을 선택할 경우 확인 버튼 클릭 없이 자동으로 월이 선택됨. (확인 버튼은 표시됨.)
summary
HTML의 table Tag의 summary 속성과 동일한 기능을 제공한다
title
HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다
toolTip
웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다
useMonthSelect
[default:true, false]기본 달력 타입(calendarValueType속성의 값이 yearMonthDate)일 때만 적용되며 월(month) selectbox의 disabeld 적용 여부.
userData1
사용자 정의 데이터 속성
userData2
사용자 정의 데이터 속성
userData3
사용자 정의 데이터 속성
useYearSelect
[default:true, false]기본 달력 타입(calendarValueType속성의 값이 yearMonthDate)일 때만 적용되며 년도(year) selectbox의 disabeld 적용 여부.
weekStartsOn
[default:0, 1, 2, 3, 4, 5, 6]시작 요일을 설정한다(0:일, 1:월, 2:화, 3:수, 4:목, 5:금, 6:토)
yearSuffix
연도 selectbox의 display되는 값의 숫자(연도) 뒤에 들어갈 문자열.

Event Summary

oncancel
cancelButtonShow속성의 값이 true일 경우에 보여지는 X(취소)버튼이 click 되었을 때 발생한다
onchange
선택 된 날짜가 변경될 때 발생하며 API를 이용하여 날짜를 설정한 경우에도 발생된다.
onclick
마우스로 calendar를 클릭했을 때 발생한다
onconfirm
"√"(확인)버튼 클릭 시 발생한다
ondateselect
날짜 선택시 발생한다
ondblclick
마우스로 calendar를 더블 클릭했을 때 발생한다
onviewchange
사용자 action에 의해 날짜가 변경된 경우 발생한다.

Method Summary

addClass( className )
컴포넌트에 class를 추가한다
bind( eventType , function )
컴포넌트의 이벤트를 동적으로 할당한다
changeClass( oldClassName , newClassName )
컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
focus( )
컴포넌트에 focus를 준다
getDateFormat( )
[default:yyyyMMdd]설정 된 dateFormat을 반환한다
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다
getFormattedValue( )
현재 선택된 날짜를 dateFormat에 적용시켜 문자열로 반환한다.
getGenerator( )
generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다
getID( )
웹스퀘어 컴포넌트의 id를 반환한다
getOpacity( )
CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다
getPluginName( )
웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다
getPosition( positionName )
컴포넌트의 left 또는 top의 위치 값을 반환한다
getReadOnly( )
현재 설정되어있는 readOnly 속성값을 반환한다
getSelectedDay( )
현재 선택된 요일을 소문자 영문으로 반환한다.
getSize( sizeName )
컴포넌트의 크기 값을 반환합니다
getStyle( propertyName )
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다
getStyleValue( style )
[deprecated]getStyle로 사용.
getTitle( )
title 속성값을 반환한다
getUserData( key )
setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
getValue( )
선택된 날짜값을 구분자 없이 반환한다
gotoCalendar( dateStr )
dateStr에 해당하는 날짜로 이동한다.
gotoLastMonth( )
현재 선택된 날짜를 1달 전으로 이동한다
gotoLastYear( )
현재 선택된 날짜에서 1년 전으로 이동한다
gotoMonth( month )
month에 해당하는 월로 이동한다.
gotoNextMonth( )
현재 선택된 날짜를 1달 뒤로 이동한다
gotoNextYear( )
현재 선택된 날짜를 1년 뒤로 이동한다
gotoTime( hour , minute )
시간을 선택 할 수 있는 달력에서 hour과 minute에 해당하는 시간으로 이동한다.
gotoToday( )
현재 날짜로 이동한다
gotoYear( year )
year에 해당하는 연도로 이동한다.
hasClass( className )
컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다
hide( )
컴포넌트를 화면에서 보이지 않도록 숨깁니다
removeAllCellClass( )
setCellClass한 모든 날짜의 class를 초기화한다
removeCellClass( dateStr )
특정 날짜에 setCellClass한 class를 초기화한다
removeClass( className )
컴포넌트에 className의 class를 삭제한다.
setCellClass( dateStr , className )
특정 날짜에 class를 지정한다
setDateFormat( format )
dateFormat을 설정하며 format이 적용 된 value는 getFormattedValue API를 이용하여 반환 받을 수 있다. calendarValueType옵션에 따라 format으로 사용할 수 있는 문자열이 다르다.
setDisabled( disabled )
달력 컴포넌트를 disabled 처리를 한다
setEventPause( evList , flag )
컴포넌트의 이벤트를 disable 또는 enable시킨다
setHoliday( dateStr )
특정 날짜에 holiday를 지정한다
setHolidayRef( setHolidayRef )
holidayRef 속성을 설정하는 기능으로 DataCollection과 연동시 "data:"라는 prefix를 꼭 붙여야한다.
setOpacity( value )
컴포넌트의 CSS Opacity(불투명도)값를 설정한다
setPosition( left , top , mode )
컴포넌트의 위치(left,top)를 설정한다
setReadOnly( readOnly )
readOnly 속성값을 설정한다
setSize( width , heigth )
컴포넌트의 크기(width,height)를 설정한다
setSkin( skinName )
skin을 설정한다
setStyle( propertyName , value )
컴포넌트의 property별 style을 설정한다
setUserData( key , value )
컴포넌트에 사용자 데이터를 설정한다
show( displayType )
컴포넌트를 화면에 보이도록 설정합니다
toggleClass( className )
컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
trigger( type , array )
컴포넌트에 등록 된 특정 이벤트를 발생시킨다
unbind( type , function )
컴포넌트에 등록 된 이벤트를 제거한다
visible( flag )
[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.

Property Detail

calendarClass
[default:class1, class2, class3, class4, class5]스킨 종류를 정의한다.
calendarValueType
[default:yearMonthDate, yearMonth, yearMonthDateHour, yearMonthDateTime, yearMonthDateTimeSec]calendar의 표현 방법을 정의한다.
cancelButtonShow
[default:false, true]X(취소)모양의 버튼 표시 여부 컴포넌트의 우측 하단에 표현된다.
해당 버튼이 click 되었을 때의 로직은 oncancel이벤트에서 구현한다.
caption
HTML caption Tag의 값을 설정한다.(본 컴포넌트는 table Tag를 이용하여 구성되어있다)
delimiter
[default:/]컴포넌트 하단에 나오는 선택 된 년월일 값에 대한 구분자를 설정한다.
displayHrMinSec
[default:false, true] calendarValueType="yearMonthDateTime" 설정 시 selectbox에 시,분.초를 표시하는 기능
footerDiv
[default:false, true]선택 된 날짜등이 있는 컴포넌트 하위 영역을 table Tag가 아닌 div Tag로 표현할지 여부
id
컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다.
maxYear
calendar에 표시되는 최대연도로 config.xml의 calendar하위의 maxYear의 value 속성값이 기본값으로 설정된다.
minYear
calendar에 표시되는 최소연도로 config.xml의 calendar하위의 minYear의 value 속성값이 기본값으로 설정된다.
monthNames
월에 해당하는 selectbox에 display값을 설정하는 기능으로 1월부터 12월의 display값을 ,(comma)로 구분하여 정의한다.
ex) Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
ref
DataCollection의 value 경로로 컴포넌트와 DataCollection의 value를 binding을 시킬 때 사용하며 "data:"라는 prefix는 필수로 붙여주어야 한다.
작성 방법은 data:[DataCollection ID].[Key id 또는 Column id]와 같다. 예시)data:dataMap1.name
DataList와 연동 된 경우는 GridView에서 선택 된 Row의 값이 binding 된다.
Instance Data와 연동 할 경우 연동 할 XML 데이터의 XPath를 명시한다. 예시)res/userInfo/name/@value
renderType
[default:component, native]컴포넌트의 레이아웃 구조를 설정한다.
component : 내부적으로 div 및 table을 이용하여 달력을 표현합니다. 웹 접근성을 위해서는 사용을 지양해야 합니다.
native : 주로 웹 접근성을 위해 사용되는 속성으로 달력 내부의 selectbox를 html의 select태그를 사용하여 렌더링하며, 달력의 숫자 및 버튼들을 html의 button태그로 렌더링합니다.
skipConfirm
[default: false, true] 사용자가 월(month)을 선택할 경우 자동으로 값이 설정됨. (확인 버튼이 표시 되지 않고 사용자는 확인 버튼을 클릭할 필요가 없음.)
true: 확인 버튼 클릭 없이 자동 설정.
false (기본 값): 사용자가 확인 버튼을 클릭해야 선택한 값이 설정.
skipConfirmOnly
[default: false, true] << < > >> 버튼을 선택하여 연도 및 월을 선택하는 월(month) 목록에서 직접 월을 선택할 경우 확인 버튼 클릭 없이 자동으로 월이 선택됨. (확인 버튼은 표시됨.)
true: 월 목록에서 월을 선택할 경우 해당 값이 자동으로 설정. (확인 버튼은 표시됨.)
false (기본 값): 월 목록에서 월을 선택하고 확인 버튼을 클릭해야 해당 값이 설정됨.
summary
HTML의 table Tag의 summary 속성과 동일한 기능을 제공한다. 일반적으로 웹접근성 화면 구현시 사용된다.
title
HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다.
toolTip
웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다. 마우스 over시 표현된다.
useMonthSelect
[default:true, false]기본 달력 타입(calendarValueType속성의 값이 yearMonthDate)일 때만 적용되며 월(month) selectbox의 disabeld 적용 여부.
실제 내부적으로는 disabled 속성을 이용하지는 않으며 사용자가 selectbox를 click 했을 때 항목이 열리지 않도록 한다.
userData1
사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2
사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3
사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.
useYearSelect
[default:true, false]기본 달력 타입(calendarValueType속성의 값이 yearMonthDate)일 때만 적용되며 년도(year) selectbox의 disabeld 적용 여부.
실제 내부적으로는 disabled 속성을 이용하지는 않으며 사용자가 selectbox를 click 했을 때 항목이 열리지 않도록 한다.
weekStartsOn
[default:0, 1, 2, 3, 4, 5, 6]시작 요일을 설정한다(0:일, 1:월, 2:화, 3:수, 4:목, 5:금, 6:토)
yearSuffix
연도 selectbox의 display되는 값의 숫자(연도) 뒤에 들어갈 문자열.
연도만 display 시킬 때는 $blank로 정의한다.

Event Detail

oncancel
cancelButtonShow속성의 값이 true일 경우에 보여지는 X(취소)버튼이 click 되었을 때 발생한다.
Sample
//취소를 누르면 2002년 04월 15일(인스웨이브 창립일)로 이동. this.gotoCalendar("20020415"); //event 핸들러 안에서 this로 접근하면 컴포넌트에 바로 접근가능하다.
onchange
선택 된 날짜가 변경될 때 발생하며 API를 이용하여 날짜를 설정한 경우에도 발생된다.
사용자의 action에 의해 날짜가 변경된 경우의 이벤트는 onviewchange를 사용한다.
onclick
마우스로 calendar를 클릭했을 때 발생한다.
Parameter
nametypedescription
eObject이벤트 객체
onconfirm
"√"(확인)버튼 클릭 시 발생한다. calendarValueType의 초기값인 yearMonthDate일 경우, "√"(확인)버튼이 없으며 onconfirm 이벤트를 사용할 수 없다.
ondateselect
날짜 선택시 발생한다
Parameter
nametypedescription
dateStrString선택한 날짜의 문자열
dateObjDate선택한 날짜의 Date 객체
Sample
//사용자가 2002년 04월 15일을 선택 한 경우 엔진에서 넘겨주는 파라메터 예시 dateStr : "20020415" (String 객체) dateObj : Mon Apr 15 2002 00:00:00 GMT+0900 (Date 객체)
ondblclick
마우스로 calendar를 더블 클릭했을 때 발생한다.
Parameter
nametypedescription
eObject이벤트 객체
onviewchange
사용자 action에 의해 날짜가 변경된 경우 발생한다.
스크립트(API)를 통해 값이 변경된 경우에는 해당 이벤트가 발생하지 않는다. (native onchange 이벤트와 유사)
Parameter
nametypedescription
infoJSONoldValue, newValue를 포함한 JSON을 반환한다. <String> info.oldValue : 이전 값 <String> info.newValue : 변경된 값
Sample
//사용자가 2002년 04월 15일로 설정 되어있던 값을 2099년 12월 31일로 설정 한 경우 <script ev:event="onviewchange( info )"><![CDATA[ var oldValue = info.oldValue; //이전 값 //return 예시 ) "20020415" var newValue = info.newValue; //선택 된 값 //return 예시 ) "20991231" ]]></script>

Method Detail

addClass( className )
컴포넌트에 class를 추가한다.
Parameter
nametyperequireddescription
classNameStringY추가하고 싶은 class의 이름
Sample
//input1 컴포넌트에 oddClass 라는 class를 추가 할 때 input1.addClass("oddClass");
bind( eventType , function )
컴포넌트의 이벤트를 동적으로 할당한다.
Parameter
nametyperequireddescription
eventTypeStringY할당 할 이벤트명.
functionFunctionY동적으로 할당 할 이벤트의 핸들러 function.
Sample
//input1에 onclick 이벤트에 핸들러 function을 직접 정의하여 bind. input1.bind("onclick", function(e){ alert(input1.getValue();})); //input1에 onclick 이벤트에 미리 정의 한 commObj.ev_click function을 bind. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; input1.bind("onclick", commObj.ev_click );
changeClass( oldClassName , newClassName )
컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
기본 설정은 addClass API를 통해 추가 된 class만 적용되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>
Parameter
nametyperequireddescription
oldClassNameStringY삭제 할 class의 이름
newClassNameStringY추가 할 class의 이름
Sample
//아래와 같이 input 컴포넌트에 class를 정의 한 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> //config.xml 파일에 아래와 같이 정의. <style> <removeDefaultClass value="true" /> </style> //tmpInputClass class를 tmpInputWarninClass로 변경 input1.changeClass("tmpInputClass","tmpInputWarninClass");
focus( )
컴포넌트에 focus를 준다.
getDateFormat( )
[default:yyyyMMdd]설정 된 dateFormat을 반환한다.
Return
typedescription
StringdateFormat 문자열 (yyyyMMdd, yyyy-MM-dd 등)
Sample
//setDateFormat API를 이용하여 dateFormat을 설정하지 않은경우 var returnValue = calendar1.getDateFormat(); //return 예시 ) "yyyyMMdd"
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다.
Return
typedescription
Booleandisabled 속성값
Sample
var returnValue = componentId.getDisabled(); return 예시 ) false
getFormattedValue( )
현재 선택된 날짜를 dateFormat에 적용시켜 문자열로 반환한다.
dateFormat을 적용하지 않은 경우 년월일시초의 순서로 별도의 구분자 없이 return 값이 반환된다. (calendarValueType에 따라 년월일시초의 적용 범위가 다르다)
참고 ) dateFormat은 setDateFormat API로 설정한다.
Return
typedescription
Stringformat이 적용 된 선택 된 날짜의 문자열
Sample
//별도의 dateFormat을 적용하지 않고 선택 된 날짜가 2002년 04월 15일 인 경우 //calendarValueType="yearMonthDate" 로 정의 된 경우 - 기본달력 var tmpRs1 = calendar1.getFormattedValue(); //return 예시 ) "20020415" //calendarValueType="yearMonth" 로 정의 된 경우 var tmpRs2 = calendar1.getFormattedValue(); //return 예시 ) "200204" //아래와 같이 dateFormat을 적용 한 경우(setDateFormat API는 calendarValueType옵션을 고려해서 사용해야 한다. setDateFormat 참조) calendar1.setDateFormat("yyyy MM-dd"); //calendarValueType="yearMonthDate" 로 정의 된 경우 - 기본달력 var tmpRs3 = calendar1.getFormattedValue(); //return 예시 ) ""2002 04-15""
getGenerator( )
generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다.
Return
typedescription
Object부모 generator 객체
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());} // trigger1 클릭 시 generator1 객체가 console에 찍힌다. // https://inswave.com/jira/browse/WPF-1425 참조
getID( )
웹스퀘어 컴포넌트의 id를 반환한다.
Return
typedescription
String웹스퀘어 컴포넌트의 id
Sample
//동적으로 웹스퀘어 컴포넌트를 파라메터로 받았을 경우 아래와 같이 사용 할 수 있다. function fn_validCheck(tmpObj){ //tmpObj가 input1 이라는 ID를 가지고 있는 경우 var compID = tmpObj.getID(); //return 예시 ) "input1" }
getOpacity( )
CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다.
Return
typedescription
IntegerOpacity 값
Sample
//아래와 같이 input 컴포넌트에 opcacity css를 적용 한 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> var returnValue = input1.getOpacity(); // returnValue는 0~1사이의 실수이다. //return 예시 ) "0.2"
getPluginName( )
웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다.
Return
typedescription
String웹스퀘어 컴포넌트의 pluginName
Sample
//아래와 같이 공통 function에서 동적으로 웹스퀘어 객체를 받았을 때 컴포넌트의 종류에 따른 분기처리를 할수 있다. var commObj = {}; commObj.fn_makeReqData = function(tmpObj){ var tmpID = tmpObj.getID(); //컴포넌트 ID var tmpCompType = tmpObj.getPluginName(); //컴포넌트 종류 if(tmpCompType == "input"){ //..로직.. }else if(tmpCompType == "gridView"){ //..로직 .. }else{ //..로직.. } };
getPosition( positionName )
컴포넌트의 left 또는 top의 위치 값을 반환한다. %로 설정된 경우, 픽셀로 변환하여 반환한다.
Parameter
nametyperequireddescription
positionNameStringY[left,top]위치 종류
Return
typedescription
Number컴포넌트의 위치 값
Sample
//아래와 같이 input 컴포넌트에 margin css를 적용했을 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> var returnValue = input1.getPosition("top"); // returnValue는 픽셀 단위의 위치 값이다. //return 예시 ) 10
getReadOnly( )
현재 설정되어있는 readOnly 속성값을 반환한다.
Return
typedescription
Boolean현재 설정되어있는 readOnly 속성
Sample
var returnValue = componentId.getReadOnly(); //return 예시 ) false
getSelectedDay( )
현재 선택된 요일을 소문자 영문으로 반환한다.
날짜 선택이 없는 경우 ""(empty string)을 반환한다.
Return
typedescription
String[sunday, monday, tuesday, wednesday, thursday, friday, saturday]영문 요일 문자열
Sample
//2011년 1월 1일 토요일이 선택 된 경우 var returnValue = calendar1.getSelectedDay(); //return 예시 ) "saturday"
getSize( sizeName )
컴포넌트의 크기 값을 반환합니다.%로 설정된 경우, 픽셀로 변환하여 반환한다.
Parameter
nametyperequireddescription
sizeNameStringY[height,innerHeight,outerHeight,outerMarginHeight,width,innerWidth,outerWidth,outerMarginWidth]크기 값의 종류. szieName별 계산 방법은 아래를 참고.
height : element.clientHeight innerHeight : element.clientHeight + padding outerHeight : element.clientHeight + padding + border outerMarginHeight : element.clientHeight + padding + border + margin width : element.clientWidth innerWidth : element.clientWidth + padding outerWidth : element.clientWidth + padding + border outerMarginWidth : element.clientWidth + padding + border + margin
Return
typedescription
Number컴포넌트의 크기 값
Sample
var returnValue = componentId.getSize("width"); // returnValue는 픽셀 단위의 크기 값이다. %로 설정된 경우, 픽셀로 변환하여 반환한다. //return 예시 ) 100
getStyle( propertyName )
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다.
Parameter
nametyperequireddescription
propertyNameStringY반환 할 style의 property 이름
Return
typedescription
Stringstyle의 속성값
Sample
//아래와 같이 input 컴포넌트가 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;"></xf:input> var returnValue = input1.getStyle("width"); //return 예시 ) "144px"
getStyleValue( style )
[deprecated]getStyle로 사용.
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다.
Parameter
nametyperequireddescription
styleStringY정의 된 style에서 사용자가 반환 받고자하는 속성명.
Return
typedescription
Stringstyle 속성에 정의 된 값(색을 반환하는 경우에는 색HexCode로 반환)
getTitle( )
title 속성값을 반환한다.
Return
typedescription
Stringtitle 속성값.
Sample
//아래와 같이 input 컴포넌트에 title이 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); //return 예시 ) "이름 입력"
getUserData( key )
setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다.
Parameter
nametyperequireddescription
keyStringY임의 데이터의 키
Return
typedescription
Stringkey에 해당하는 데이터
Sample
//아래와 같이 input 컴포넌트의 사용자 속성(eduTest)이 적용 된 경우. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" eduTest="Hello"></xf:input> input1.getUserData("eduTest"); //return 예시 ) "Hello" //setUserData를 통해 set한 경우 input1.setUserData("eduTest","WebSquare"); input1.getUserData("WebSquare"); //return 예시 ) "Hello"
getValue( )
선택된 날짜값을 구분자 없이 반환한다.
Return
typedescription
String구분자 없는 날짜 문자열.
Sample
//선택된 날짜가 2011년 1월 1일 인 경우 //별도의 설정이 없는 기본 달력 또는 calendarValueType속성이 yearMonthDate인 경우, yyyyMMdd 형태. var returnValue = calendar1.getValue(); //return 예시 ) "20110101" //calendarValueType속성이 yearMonth인 경우, yyyyMM 형태. //return 예시 ) "201101" calendarValueType속성이 yearMonthDateTime인 경우, yyyyMMddHHmm 형태. //return 예시 ) "201101010000" calendarValueType속성이 yearMonthDateTimeSec인 경우, yyyyMMddHHmmss 형태. //return 예시 ) "20110101000000"
gotoCalendar( dateStr )
dateStr에 해당하는 날짜로 이동한다.
dateStr의 값은 구분자없이 yyyyMMdd 형태이다.
Parameter
nametyperequireddescription
dateStrStringY이동할 날짜 (yyyyMMdd 형태)
Sample
//2002년 04월 15일로 이동 calendar1.gotoCalendar("20020415");
gotoLastMonth( )
현재 선택된 날짜를 1달 전으로 이동한다.
Sample
//현재 선택된 날짜가 2011년 1월 1일 인 경우 calendar1.gotoLastMonth(); //display 예시 ) 2010년 12월 1일이 선택된다.
gotoLastYear( )
현재 선택된 날짜에서 1년 전으로 이동한다.
Sample
//현재 선택된 날짜가 2011년 1월 1일 인 경우 calendar1.gotoLastYear(); //display 예시 ) 2010년 1월 1일이 선택된다.
gotoMonth( month )
month에 해당하는 월로 이동한다.
해당 월이 유효하지 않는 경우, 최초 월(1)로 이동한다.
Parameter
nametyperequireddescription
monthString||NumberY이동하려는 월의 문자 또는 숫자.("02","2",2 모두 1월로 이동)
Sample
//현재 선택된 날짜가 2011년 1월 1일 인경우 calendar1.gotoMonth(5); // "05" , "5" , 5 동일 한 결과가 나타난다 //display 예시 ) 2011년 5월 1일이 선택된다.
gotoNextMonth( )
현재 선택된 날짜를 1달 뒤로 이동한다.
Sample
//현재 선택된 날짜가 2011년 1월 1일 인 경우 calendar1.gotoNextMonth(); //display 예시 ) 2011년 2월 1일이 선택된다.
gotoNextYear( )
현재 선택된 날짜를 1년 뒤로 이동한다.
Sample
//현재 선택된 날짜가 2011년 1월 1일 인 경우 calendar1.gotoNextYear(); //display 예시 ) 2012년 1월 1일이 선택된다.
gotoTime( hour , minute )
시간을 선택 할 수 있는 달력에서 hour과 minute에 해당하는 시간으로 이동한다.
해당 시간이 유효하지 않는 경우, 최초 시(0)와 분(0)으로 설정한다.
Parameter
nametyperequireddescription
hourNumber||StringY이동하려는 시간.("02", "2", 2 모두 2시로 설정)
minuteNumber||StringY이동하려는 분.("05", "5", 5 모두 5분으로 설정)
Sample
//시간을 선택 할 수 있는 달력 타입에서만 동작 calendar1.gotoTime("01","11"); //"01", "1", 1 모두 1시로 이동 //display 예시 ) 1시 11분으로 이동.
gotoToday( )
현재 날짜로 이동한다.
Sample
//yearMonthDate타입의 달력에서 "Today" 또는 "현재일" 버튼을 클릭한 것과 동일한 효과. calendar1.gotoToday();
gotoYear( year )
year에 해당하는 연도로 이동한다.
해당 년도가 유효하지 않는 경우, 최초년도로 이동한다.
Parameter
nametyperequireddescription
yearString||NumberY이동하려는 연도.("2002", 2002 모두 2002년으로 이동)
Sample
//현재 선택된 날짜가 2011년 1월 1일인 경우 calendar1.gotoYear("2020"); //display 예시 ) 2020년 1월 1일이 선택된다.
hasClass( className )
컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다.
Parameter
nametyperequireddescription
classNameStringY검색 할 className
Return
typedescription
Booleanclass를 가지고 있는지의 여부
Sample
//아래와 같이 input 컴포넌트에 class가 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> var returnValue = input1.hasClass("tmpInputClass"); //return 예시 ) true
hide( )
컴포넌트를 화면에서 보이지 않도록 숨깁니다.
removeAllCellClass( )
setCellClass한 모든 날짜의 class를 초기화한다.
Sample
//아래와 같이 style영역에 tmpColor01 class가 정의 된 경우 <style type="text/css"><![CDATA[ .tmpColor01{ color:orange; } ]]></style> calendar1.setCellClass( "20151015","tmpColor01" ); calendar1.setCellClass( "20150915","tmpColor01" ); calendar1.setCellClass( "20150815","tmpColor01" ); calendar1.removeAllCellClass(); // 각 cell에 적용했던 모든 class 삭제됨.
removeCellClass( dateStr )
특정 날짜에 setCellClass한 class를 초기화한다.
Parameter
nametyperequireddescription
dateStrStringYclass를 지정할 날짜
Sample
//아래와 같이 style영역에 tmpColor01 class가 정의 된 경우 <style type="text/css"><![CDATA[ .tmpColor01{ color:orange; } ]]></style> calendar1.setCellClass("20020415", "tmpColor01"); calendar1.removeCellClass("20020415"); //display 예시 ) 2002년 04월 15일에 해당하는 날짜의 글자색이 orange를 초기화 한다.
removeClass( className )
컴포넌트에 className의 class를 삭제한다.
기본 설정은 addClass API를 통해 추가 된 class만 적용되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>
Parameter
nametyperequireddescription
classNameStringY삭제 할 class명
Sample
//아래와 같이 input 컴포넌트에 class를 정의 한 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> //config.xml 파일에 아래와 같이 정의. <style> <removeDefaultClass value="true" /> </style> //tmpInputClass class 삭제 input1.removeClass("tmpInputClass");
setCellClass( dateStr , className )
특정 날짜에 class를 지정한다.
Parameter
nametyperequireddescription
dateStrStringYclass를 지정할 날짜
classNameStringY지정할 class명
Sample
//아래와 같이 style영역에 tmpColor01 class가 정의 된 경우 <style type="text/css"><![CDATA[ .tmpColor01{ color:orange; } ]]></style> calendar1.setCellClass("20020415", "tmpColor01"); //display 예시 ) 2002년 04월 15일에 해당하는 날짜의 글자색이 orange로 적용된다.
setDateFormat( format )
dateFormat을 설정하며 format이 적용 된 value는 getFormattedValue API를 이용하여 반환 받을 수 있다. calendarValueType옵션에 따라 format으로 사용할 수 있는 문자열이 다르다.
calendarValueType옵션이 yearMonthDate인 경우 사용할 수 있는 문자열은 yyyy, MM, dd이고,
calendarValueType옵션이 yearMonth인 경우 사용할 수 있는 문자열은 yyyy, MM이고,
calendarValueType옵션이 yearMonthDateTime인 경우 사용할 수 있는 문자열은 yyyy, MM, dd, HH, mm이고,
calendarValueType옵션이 yearMonthDateTimeSec인 경우 사용할 수 있는 문자열은 yyyy, MM, dd, HH, mm, SS입니다.
Parameter
nametyperequireddescription
formatStringY적용할 dateFormat.(yyyy-MM-dd와 같은 문자열)
Sample
//2002년 04월 15일이 선택 되고 아래와 같이 format을 적용 한 경우 calendar1.setDateFormat("yyyy MM-dd"); //format 된 value를 반환. var tmpVal1 = calendar1.getFormattedValue(); //return 예시 ) "2002 04-15" //value를 반환. var tmpVal2 = calendar1.getValue(); //return 예시 ) "20020415" //format이 적용되어 있지 않다.
setDisabled( disabled )
달력 컴포넌트를 disabled 처리를 한다.
Parameter
nametyperequireddescription
disabledBooleanYdisabled 처리를 위한 boolean값(true, false)
Sample
calendar1.setDisabled(true);
setEventPause( evList , flag )
컴포넌트의 이벤트를 disable 또는 enable시킨다.
Parameter
nametyperequireddescription
evListStringN대상 이벤트 목록. 해당 인자가 주어지지 않을 경우 해당 컴포넌트의 모든 사용자 이벤트가 대상이 된다. (null을 지정하면 된다.)
flagBooleanYtrue인 경우 pause시키며, false인 경우 pause를 해제한다.
Sample
input1.setEventPause("onclick", true); //onclick이벤트를 동적으로 pause 한다. input1.setEventPause("onfocus,onblur", false); //onfocus이벤트와 onblur이벤트의 pause를 해제한다. input1.setEventPause(null, true); //input에 등록된 모든 사용자 이벤트를 pause 한다.
setHoliday( dateStr )
특정 날짜에 holiday를 지정한다.
Parameter
nametyperequireddescription
dateStrStringYholiday를 지정할 날짜
Sample
calendar1.setHoliday("20160627"); 또는 전체 연도에 적용시에는 calendar1.setHoliday("*0815");로 설정한다. //display 예시 ) 2016년 06월 27일에 해당하는 날짜의 글자색이 빨간색으로 적용된다.
setHolidayRef( setHolidayRef )
holidayRef 속성을 설정하는 기능으로 DataCollection과 연동시 "data:"라는 prefix를 꼭 붙여야한다.
명시하지 않는 경우 InstanceData의 XPath로 인식한다.
Parameter
nametyperequireddescription
setHolidayRefStringY적용할 setHolidayRef 경로.
Sample
//dataList1의 col1과 calendar 컴포넌트의 공휴일 표시하려는 경우 calendar.setHolidayRef("data:dataList1.col1"); //InstanceData의 test/holiday와 연동 할 경우. calendar.setHolidayRef("test/holiday");
setOpacity( value )
컴포넌트의 CSS Opacity(불투명도)값를 설정한다.
Parameter
nametyperequireddescription
valueNumberYOpacity 값 (0과 1사이의 실수)
Sample
componentId.setOpacity(0.45);
setPosition( left , top , mode )
컴포넌트의 위치(left,top)를 설정한다.
Parameter
nametyperequireddescription
leftNumberYleft의 값 또는 null.
topNumberYtop의 값 또는 null.
modeStringN[defulat:absolute, delta]absolute이면 x,y로 현재 값을 설정하고 delta이면 현재 값에 x,y값만큼을 더해서 설정.
Sample
//컴포넌트의 top만 100px로 설정. componentId.setPosition(null, 100);
setReadOnly( readOnly )
readOnly 속성값을 설정한다. readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력합니다.
Parameter
nametyperequireddescription
readOnlyBooleanYreadOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false
Sample
//컴포넌트의 readonly 적용. componentId.setReadOnly(true);
setSize( width , heigth )
컴포넌트의 크기(width,height)를 설정한다.
Parameter
nametyperequireddescription
widthNumberY새로 설정할 컴포넌트의 width값 또는 null
heigthNumberY새로 설정할 컴포넌트의 height값 또는 null
Sample
//컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);
setSkin( skinName )
skin을 설정한다.
Parameter
nametyperequireddescription
skinNameStringY[class1, class2, class3, class4, class5]사용할 skin명
Sample
calendar1.setSkin("class2");
setStyle( propertyName , value )
컴포넌트의 property별 style을 설정한다.
Parameter
nametyperequireddescription
propertyNameStringYstyle 속성 이름
valueStringY적용 할 style의 값
Sample
//컴포넌트의 width를 200px로 설정 할 경우 componentId.setStyle("width", "200px"); //배경색을 olive로 변경 할 경우 componentId.setStyle("background-color","olive");
setUserData( key , value )
컴포넌트에 사용자 데이터를 설정한다. 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하며 log에 관련 내용이 출력 된다.
Parameter
nametyperequireddescription
keyStringY임의 데이터의 키
valueStringY임의 데이터의 값
Sample
//컴포넌트에 'data'라는 key로 'WebSquare'라는 값을 설정 할 경우 componentId.setUserData("data", "WebSquare"); //아래와 같이 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하다. componentId.setUserData("title", "WebSquare"); //log 표현 예시 ) !!!WARNING - [title] can't define as UserData
show( displayType )
컴포넌트를 화면에 보이도록 설정합니다.
Parameter
nametyperequireddescription
displayTypeStringNdisplay의 속성 값
toggleClass( className )
컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
기본 설정은 addClass API를 통해 추가 된 class만 삭제되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>
Parameter
nametyperequireddescription
classNameStringY설정 할 className
Sample
//아래와 같이 input 컴포넌트에 class를 정의 한 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> //config.xml 파일에 아래와 같이 정의. <style> <removeDefaultClass value="true" /> </style> //적용 된 tmpInputClass class 삭제 input1.toggleClass("tmpInputClass"); //tmpInputClass class를 다시 추가 input1.toggleClass("tmpInputClass");
trigger( type , array )
컴포넌트에 등록 된 특정 이벤트를 발생시킨다.
Parameter
nametyperequireddescription
typeStringY발생시킬 이벤트 이름
arrayArrayN이벤트 핸들러에 전달할 파라미터 배열
Sample
//input1 컴포넌트에 onclick이벤트를 발생시킨다. input1.trigger("onclick"); //input1에 onviewchange이벤트를 발생시키고 핸들러 함수에 (1,2) 인자를 전달하여 호출한다. input1.trigger("onviewchange", [1,2]);
unbind( type , function )
컴포넌트에 등록 된 이벤트를 제거한다.
Parameter
nametyperequireddescription
typeStringN제거할 이벤트 이름. 생략할 경우 해당 컴포넌트의 모든 이벤트를 제거한다.
functionFunctionN제거할 이벤트의 핸들러 함수. 생략할 경우 해당 이벤트 type으로 등록된 모든 핸들러 함수를 제거한다.
Sample
//input1에 등록된 모든 이벤트를 제거 input1.unbind(); //input1에 등록된 onviewchange이벤트 핸들러 함수를 모두 제거 input1.unbind("onviewchange"); //input1에 등록된 onviewchange이벤트에서 func1 이벤트 핸들러를 제거 input1.unbind("onviewchange", func1);
visible( flag )
[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.
컴포넌트의 style 중 visibility 값을 설정한다. true이면 "visible", false이면 "hidden"을 설정.
Parameter
nametyperequireddescription
flagBooleanYvisibility 값을 설정할 값(true이면 "visible", false이면 "hidden"을 설정)