WebSquare.uiplugin.scheduleCalendar

scheduleCalendar는 일정을 calendar에 출력한다.

Type

uiplugin

Property Summary

class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
cssRenderOrder: [default:false, true]scheduleCalendar에서 css 파일을 document head에 link태그로 랜더링되는 순서가
dataList: [defulat:""]scheduleCalendar에 바인딩될 dataList. scheduleCalendar에서 필요한 dataList의 컬럼 종류는 다음과 같다.
defaultDate: [default:""]component 로딩후 초기화면에 설정된 날짜, ioFormat와 포맷이 일치해야됨
defaultView: [default:'month'] scheduleCalendar의 defaultView 값을 설정합니다.
editable: [default:false, true] scheduleCalendar에 기 적용되어 있는 일정을 마우스 드래그 앤 드랍으로
endColumn: [default:""]scheduleCalendar에 입력하는 일정의 '종료 날짜' 값으로 사용될 dataList의 column id
headerLeftBtn: [default:true, false]scheduleCalanedar의 header 좌측버튼이 보이도록 설정[show, hide]
headerRightBtn: [default:true, false]scheduleCalanedar의 header 우측버튼이 보이도록 설정show, hide]
headerTitle: [default:true, false]scheduleCalanedar의 header 중앙 title이 보이도록 설정[show, hide]
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다
idColumn: [default:""]scheduleCalendar에 입력하는 일정의 고유한 'id'값으로 사용될 dataList의 column id
ioFormat: [default:yyyyMMdd,MMddyyyy,ddMMyyyy]start ,end column에 입력된 날짜포멧을 설정
lang: [default:ko, en]scheduleCalanedar에서 사용될 언어를 설정한다
locale: [default:ko, en] 3
selectable: [default:false, true]scheduleCalendar에서 특정 날짜를 선택해서 일정을 입력할 수 있다.(prompt창 발생)
startColumn: [default:""]scheduleCalendar에 입력하는 일정의 '시작 날짜' 값으로 사용될 dataList의 column id
tabIndex: [default:""]Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다
themeColumn: [default:""]scheduleCalendar에 입력하는 일정의 theme를 지정할 dataList의 column id
titleColumn: [default:""]scheduleCalendar에 입력하는 일정의 title 값을 설정한다
tooltipDisplay: [default:false, true]scheduleCalendar에서 tooltip을 나타내도록 하는 속성
version: [default:2.3, 3.6]scheduleCalendar에서 사용할 버전을 설정. 디폴트로 fullCalendar 2.3.2 버젼이 로딩되고

Event Summary

onclick: 마우스로 날짜를 클릭했을 때 발생한다.

Method Summary

addClass( className ): 컴포넌트에 class를 추가한다
addSchedule( 일정 ): calendar에 일정을 추가한다
bind( eventType , function ): 컴포넌트의 이벤트를 동적으로 할당한다
changeClass( oldClassName , newClassName ): 컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
changeView( view ): scheduleCalendar의 view를 바꾼다
focus( ): 컴포넌트에 focus를 준다
getDataListInfo( ): 바인딩된 데이터리스트 정보를 반환한다
getDisabled( ): 현재 설정되어있는 disabled 속성값을 반환한다
getGenerator( ): generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다
getID( ): 웹스퀘어 컴포넌트의 id를 반환한다
getInitStyle( property ): 초기 컴포넌트의 스타일을 가져옵니다
getOpacity( ): CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다
getOriginalID( ): 컴포넌트의 originalID를 반환한다. originalID란 다음과 같다.
getPluginName( ): 웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다
getPosition( positionName ): 컴포넌트의 left 또는 top의 위치 값을 반환한다
getReadOnly( ): 현재 설정되어있는 readOnly 속성값을 반환한다
getScheduleInfo( id ): calendar에 일정의 정보를 반환한다
getScope( ): 컴포넌트가 scope=true인 wframe의 자식 컴포넌트일 때 해당 부모 wframe 객체를 반환하는 함수 scope=true인 wframe의 자식 컴포넌트가 아닐 경우 null을 반환한다
getScopeWindow( ): 컴포넌트가 scope=true인 wframe의 자식 컴포넌트일 때 해당 부모 wframe의 scope객체를 반환하는 함수 scope=true인 wframe의 자식 컴포넌트가 아닐 경우 전역 window객체를 반환한다
getSize( sizeName ): 컴포넌트의 크기 값을 반환합니다
getStyle( propertyName ): 컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다
getStyleValue( style ): [deprecated]getStyle로 사용.
getTitle( ): title 속성값을 반환한다
getUdcHome( ): udc객체에서 자신의 udc를 정의한 파일이 위치한 경로를 반환하는 함수
getUdcRoot( ): udc객체에서 자신의 udc를 정의한 파일이 위치한 경로를 반환하는 함수
getUserData( key ): setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
getView( ): scheduleCalendar의 현재 view 정보를 조회한다
gotoCalendar( dateStr ): 특정 날짜로 이동할 수 있다
hasClass( className ): 컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다
hide( ): 컴포넌트를 화면에서 보이지 않도록 숨긴다.
removeClass( className ): 컴포넌트에 className의 class를 삭제한다.
removeschedule( id ): calendar에 일정을 삭제한다
setDayNameStyle( header, ): calendar에 요일컬럼에 스타일이 지정한다
setDisabled( disabled ): 컴포넌트의 disabled 속성을 설정한다
setEventPause( evList , flag ): 컴포넌트의 이벤트를 disable 또는 enable시킨다
setHeaderBtn( option.headerLeftBtn ): calendar에 header 버튼을 설정한다
setInitStyle( property ): 초기 컴포넌트의 스타일로 되돌립니다
setOpacity( value ): 컴포넌트의 CSS Opacity(불투명도)값를 설정한다
setPosition( left , top , mode ): 컴포넌트의 위치(left,top)를 설정한다
setReadOnly( readOnly ): readOnly 속성값을 설정한다
setSize( width , heigth ): 컴포넌트의 크기(width,height)를 설정한다
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

class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
기본적으로 엔진 내부에서 컴포넌트별로 class를 적용하고 있으며 해당 class를 이용하여 컴포넌트의 css를 공통으로 적용할 수 있다.
cssRenderOrder: [default:false, true]scheduleCalendar에서 css 파일을 document head에 link태그로 랜더링되는 순서가
stylesheet_ext.css 파일에 해당하는 link태그 바로 다음으로 조정하는 속성
dataList: [defulat:""]scheduleCalendar에 바인딩될 dataList. scheduleCalendar에서 필요한 dataList의 컬럼 종류는 다음과 같다.
"idCol", "startCol", "endCol", "titleCol" 으로 4종류이다.(컬럼ID는 변경해도 무관).
scheduleCalendar컴포넌트의 dataList속성에 생성한 dataList ID를 설정하고 그 외에 "idColumn" 속성 및 "startColumn" 속성 등에는 생성한 dataList의 "컬럼ID"값들을 설정해준다.
예를 들어서, 생성된 dataList의 ID는 "dataList1"이다.
"dataList1"에 추가된 컬럼은 총 4개이며, 컬럼 ID는 "idCol", "startCol", "endCol", "titleCol"으로 되어 있다.
scheduleCalendar에는 다음과 같이 설정한다.
dataList = "dataList1" idColumn = "idCol" startColumn = "startCol" endColumn = "endCol" titleColumn = "titleCol"
defaultDate: [default:""]component 로딩후 초기화면에 설정된 날짜, ioFormat와 포맷이 일치해야됨.
defaultView: [default:'month'] scheduleCalendar의 defaultView 값을 설정합니다.
defaultView의 종류로는 [ month, basicWeek, basicDay, agendaWeek, agendaDay ] 등이 있습니다.
editable: [default:false, true] scheduleCalendar에 기 적용되어 있는 일정을 마우스 드래그 앤 드랍으로
옮겨서 start와 end 날짜를 변경할 수 있는 기능을 설정한다.
endColumn: [default:""]scheduleCalendar에 입력하는 일정의 '종료 날짜' 값으로 사용될 dataList의 column id
headerLeftBtn: [default:true, false]scheduleCalanedar의 header 좌측버튼이 보이도록 설정[show, hide]
headerRightBtn: [default:true, false]scheduleCalanedar의 header 우측버튼이 보이도록 설정show, hide]
headerTitle: [default:true, false]scheduleCalanedar의 header 중앙 title이 보이도록 설정[show, hide]
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다.
idColumn: [default:""]scheduleCalendar에 입력하는 일정의 고유한 'id'값으로 사용될 dataList의 column id
ioFormat: [default:yyyyMMdd,MMddyyyy,ddMMyyyy]start ,end column에 입력된 날짜포멧을 설정
lang: [default:ko, en]scheduleCalanedar에서 사용될 언어를 설정한다.
locale: [default:ko, en] 3.6 이상 버전의 scheduleCalanedar에서 사용될 언어를 설정한다. 2.3 버전에서는 lang속성 사용.
selectable: [default:false, true]scheduleCalendar에서 특정 날짜를 선택해서 일정을 입력할 수 있다.(prompt창 발생)
여러 날짜를 마우스로 드래그해서 다중 선택 후, 기간으로 일정을 입력할 수 있다.
startColumn: [default:""]scheduleCalendar에 입력하는 일정의 '시작 날짜' 값으로 사용될 dataList의 column id
tabIndex: [default:""]Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다.
themeColumn: [default:""]scheduleCalendar에 입력하는 일정의 theme를 지정할 dataList의 column id
themeColumn의 내용은 JSON 형식으로 작성해야하며, rendering, class, color, backgroundColor, borderColor, textColor를 지정할 수 있다.
1. rendering: [ "" | "background" | "inverse-background" ] 일정의 렌더링 방법을 지정한다. ( 기본값 : "" )
2. class : 일정에 적용할 class를 배열 혹은 문자열로 지정할 수 있다.
3. color : 일정에 적용할 색상을 지정할 수 있다. (red, #FF0000, rgb(0,0,0,0) 형식을 지원하며, color를 설정하면 backgroundColor, borderColor가 동시에 적용된다.)
4. backgroundColor : 일정에 적용할 배경색을 지정할 수 있다. (red, #ff0000, rgb(0, 0, 0, 0) 형식을 지원한다.)
5. borderColor: 일정에 적용할 테두리색을 지정할 수 있다. (red, #ff0000, rgb(0, 0, 0, 0) 형식을 지원한다.)
6. textColor: 일정에 적용할 글자색을 지정할 수 있다. (red, #ff0000, rgb(0, 0, 0, 0) 형식을 지원한다.)
(예) dataList: data:dataList1, themeColumn: themeColumn, themeColumn의 값이 { "color":"yellow", "textColor":"#000000" } 일 때
ScheduleClaendar에 생성된 해당 일정은 배경색과 테두리색이 노랑색으로, 글자색은 검정색으로 표시된다.
titleColumn: [default:""]scheduleCalendar에 입력하는 일정의 title 값을 설정한다.
tooltipDisplay: [default:false, true]scheduleCalendar에서 tooltip을 나타내도록 하는 속성
version: [default:2.3, 3.6]scheduleCalendar에서 사용할 버전을 설정. 디폴트로 fullCalendar 2.3.2 버젼이 로딩되고
"3.6"을 선택하면 3.6.2 버젼이 로딩된다.

Event Detail

onclick

마우스로 날짜를 클릭했을 때 발생한다.
click 시에 포커스된 날짜 값을 반환 받을 수 있다.

Parameter
name	type	description
retObj	JSON	start, end를 포함한 JSON을 반환한다.

Sample

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

Method Detail

addClass( className )

컴포넌트에 class를 추가한다.

Parameter
name	type	required	description
className	String	Y	추가하고 싶은 class의 이름

Sample

//input1 컴포넌트에 oddClass 라는 class를 추가 할 때 input1.addClass("oddClass");

addSchedule( 일정 )

calendar에 일정을 추가한다. dataList와 연동 시에는 dataList의 컬럼ID에 맞는 object를 생성해서 파라미터로 전달한다.

Parameter
name	type	required	description
일정	Object	Y

Sample

dataList(columnID : "colTitle", "colEnd", "colId", "colStart")와 연동된 경우, 다음과 같이 명령어를 실행한다. scheduleCalendar1.addSchedule({"colTitle": "추가타이틀 2222","colEnd": "20171222","colId": "ADD_id_223","colStart": "20171222"}); dataList와 연동되어 있지 않는 경우, 다음과 같이 실행한다. scheduleCalendar1.addSchedule({"title": "추가타이틀 2222","end": "20171222","id": "ADD_id_223","start": "20171222"});

bind( eventType , function )

컴포넌트의 이벤트를 동적으로 할당한다.

Parameter
name	type	required	description
eventType	String	Y	할당 할 이벤트명.
function	Function	Y	동적으로 할당 할 이벤트의 핸들러 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
name	type	required	description
oldClassName	String	Y	삭제 할 class의 이름
newClassName	String	Y	추가 할 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");

changeView( view )

scheduleCalendar의 view를 바꾼다.

Parameter
name	type	required	description
view	String	Y	바꿀 View의 종류 ( month, basicWeek, basicDay, agendaWeek, agendaDay )

Sample

sheculeCalendar1.changeView("basicWeek");

focus( )

컴포넌트에 focus를 준다.

getDataListInfo( )

바인딩된 데이터리스트 정보를 반환한다.

Return
type	description
Object:Y	dataList info

getDisabled( )

현재 설정되어있는 disabled 속성값을 반환한다.

Return
type	description
Boolean	disabled 속성값

Sample

var returnValue = componentId.getDisabled(); return 예시 ) false

getGenerator( )

generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다.

Return
type	description
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에 찍힌다.

getID( )

웹스퀘어 컴포넌트의 id를 반환한다.

Return
type	description
String	웹스퀘어 컴포넌트의 id

Sample

//동적으로 웹스퀘어 컴포넌트를 파라메터로 받았을 경우 아래와 같이 사용 할 수 있다. function fn_validCheck(tmpObj){ //tmpObj가 input1 이라는 ID를 가지고 있는 경우 var compID = tmpObj.getID(); //return 예시 ) "input1" }

getInitStyle( property )

초기 컴포넌트의 스타일을 가져옵니다.

Parameter
name	type	required	description
property	String	N	속성명 (지정하지 않으면 모든정보 출력)

getOpacity( )

CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다.

Return
type	description
Integer	Opacity 값

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"

getOriginalID( )

컴포넌트의 originalID를 반환한다. originalID란 다음과 같다.
scope="true"인 wframe 내부의 컴포넌트는 원래 입력된 id값 앞에 prefix(wframeID + "_")가 붙어서 id값이 변한다.
이 때, prefix가 붙기 전 원래 입력된 id를 originalID라고 한다.

Return
type	description
String	컴포넌트의 originalID

Sample

//아래와 같은 다중 wframe 구조를 갖는 화면에서 wframe 화면에 있는 컴포넌트의 getID, getOriginalID는 다음과 같다. //화면구조 //(main.xml) <w2:wframe id="wframe1" src="wframe1.xml" scope="true"/> //(wframe.xml) <w2:textbox id="textbox1"/> // 이 때 wframe.xml 내부스크립트에서 textbox1에 대해 getID, getOriginalID를 실행한 결과는 아래와 같다. textbox1.getID(); // 실행 결과는 "wframe1_textbox1" textbox1.getOriginalID(); // 실행 결과는 "textbox1"

getPluginName( )

웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다.

Return
type	description
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
name	type	required	description
positionName	String	Y	[left,top]위치 종류

Return
type	description
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
type	description
Boolean	현재 설정되어있는 readOnly 속성

Sample

var returnValue = componentId.getReadOnly(); //return 예시 ) false

getScheduleInfo( id )

calendar에 일정의 정보를 반환한다.

Parameter
name	type	required	description
id	String	Y	일정의 id 값

Return
type	description
Object:Y	event 일정(id, title, start, end 정보 포함한 객체)

getScope( )

컴포넌트가 scope=true인 wframe의 자식 컴포넌트일 때 해당 부모 wframe 객체를 반환하는 함수 scope=true인 wframe의 자식 컴포넌트가 아닐 경우 null을 반환한다.

Return
type	description
Object	wframe 객체 또는 null

Sample

// 메인페이지에 wframe1이 있고 wframe1안에 wframe11이 있고 그 안에 textbox1이 있는 경우 textbox1.getScope(); // wframe11 객체를 반환한다.

getScopeWindow( )

컴포넌트가 scope=true인 wframe의 자식 컴포넌트일 때 해당 부모 wframe의 scope객체를 반환하는 함수 scope=true인 wframe의 자식 컴포넌트가 아닐 경우 전역 window객체를 반환한다.

Return
type	description
Object	wframe객체의 scope객체 또는 전역window객체

Sample

// 메인페이지에 wframe1이 있고 wframe1안에 wframe11이 있고 그 안에 textbox1이 있는 경우 var scope = textbox1.getScopeWindow(); scope.wframe11 === textbox1.getScope(); // true

getSize( sizeName )

컴포넌트의 크기 값을 반환합니다.%로 설정된 경우, 픽셀로 변환하여 반환한다.

Parameter
name	type	required	description
sizeName	String	Y	[height,innerHeight,outerHeight,outerMarginHeight,width,innerWidth,outerWidth,outerMarginWidth]크기 값의 종류. szieName별 계산 방법은 아래를 참고.

Return
type	description
Number	컴포넌트의 크기 값

Sample

var returnValue = componentId.getSize("width"); // returnValue는 픽셀 단위의 크기 값이다. %로 설정된 경우, 픽셀로 변환하여 반환한다. //return 예시 ) 100

getStyle( propertyName )

컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다.

Parameter
name	type	required	description
propertyName	String	Y	반환 할 style의 property 이름

Return
type	description
String	style의 속성값

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
name	type	required	description
style	String	Y	정의 된 style에서 사용자가 반환 받고자하는 속성명.

Return
type	description
String	style 속성에 정의 된 값(색을 반환하는 경우에는 색HexCode로 반환)

getTitle( )

title 속성값을 반환한다.

Return
type	description
String	title 속성값.

Sample

//아래와 같이 input 컴포넌트에 title이 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); //return 예시 ) "이름 입력"

getUdcHome( )

udc객체에서 자신의 udc를 정의한 파일이 위치한 경로를 반환하는 함수. 마지막 .xml까지 포함된다. .xml을 제외한 경로가 필요한 경우에는 getUdcRoot API를 사용하면 된다. udc객체가 아닌 컴포넌트에서 호출 시에는 undefined를 반환한다.

Return
type	description
String	udc파일이 위치한 경로. udc가 아닐 경우 undefined 리턴

Sample

udc파일이 /a/b/udc.xml 위치에 있고, 화면 xml파일이 /a/c/main.xml이고 udc객체 id가 udc1인 경우 udc1.getUdcHome(); // 실행 결과는 /a/b/udc.xml

getUdcRoot( )

udc객체에서 자신의 udc를 정의한 파일이 위치한 경로를 반환하는 함수. 마지막 .xml은 포함되지 않는다. .xml을 포함한 경로가 필요한 경우에는 getUdcHome API를 사용하면 된다. udc객체가 아닌 컴포넌트에서 호출 시에는 undefined를 반환한다.

Return
type	description
String	udc파일이 위치한 경로. udc가 아닐 경우 undefined 리턴

Sample

udc파일이 /a/b/udc.xml 위치에 있고, 화면 xml파일이 /a/c/main.xml이고 udc객체 id가 udc1인 경우 udc1.getUdcHome(); // 실행 결과는 /a/b/

getUserData( key )

setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다.

Parameter
name	type	required	description
key	String	Y	임의 데이터의 키

Return
type	description
String	key에 해당하는 데이터

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"

getView( )

scheduleCalendar의 현재 view 정보를 조회한다.

Sample

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

gotoCalendar( dateStr )

특정 날짜로 이동할 수 있다.

Parameter
name	type	required	description
dateStr	String	Y	이동할 날짜

Sample

shecule1.gotoCalendar("20171013");

hasClass( className )

컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다.

Parameter
name	type	required	description
className	String	Y	검색 할 className

Return
type	description
Boolean	class를 가지고 있는지의 여부

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

컴포넌트를 화면에서 보이지 않도록 숨긴다.
엔진 내부적으로는 CSS를 display:none;과 visibility:hidden;으로 처리한다.

Sample

componentId.hide();

removeClass( className )

컴포넌트에 className의 class를 삭제한다.
기본 설정은 addClass API를 통해 추가 된 class만 적용되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	삭제 할 class명

Sample

removeschedule( id )

calendar에 일정을 삭제한다. dataCollection에 id컬럼이 없는 경우, id값은 title값으로 대체된다.

Parameter
name	type	required	description
id	String	Y	일정의 id값

setDayNameStyle( header, )

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 )

컴포넌트의 disabled 속성을 설정한다. disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력한다.

Parameter
name	type	required	description
disabled	Boolean	Y	disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false

Sample

//컴포넌트의 disabled 적용 componentId.setDisabled(true);

setEventPause( evList , flag )

컴포넌트의 이벤트를 disable 또는 enable시킨다.

Parameter
name	type	required	description
evList	String	N	대상 이벤트 목록. 해당 인자가 주어지지 않을 경우 해당 컴포넌트의 모든 사용자 이벤트가 대상이 된다. (null을 지정하면 된다.)
flag	Boolean	Y	true인 경우 pause시키며, false인 경우 pause를 해제한다.

Sample

input1.setEventPause("onclick", true); //onclick이벤트를 동적으로 pause 한다. input1.setEventPause("onfocus,onblur", false); //onfocus이벤트와 onblur이벤트의 pause를 해제한다. input1.setEventPause(null, true); //input에 등록된 모든 사용자 이벤트를 pause 한다.

setHeaderBtn( option.headerLeftBtn )

calendar에 header 버튼을 설정한다.

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

Sample

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

setInitStyle( property )

초기 컴포넌트의 스타일로 되돌립니다.

Parameter
name	type	required	description
property	String	N	속성명 (지정하지 않으면 모든속성을 되돌림)

Sample

group1.getInitStyle();

setOpacity( value )

컴포넌트의 CSS Opacity(불투명도)값를 설정한다.

Parameter
name	type	required	description
value	Number	Y	Opacity 값 (0과 1사이의 실수)

Sample

componentId.setOpacity(0.45);

setPosition( left , top , mode )

컴포넌트의 위치(left,top)를 설정한다.

Parameter
name	type	required	description
left	Number	Y	left의 값 또는 null.
top	Number	Y	top의 값 또는 null.
mode	String	N	[defulat:absolute, delta]absolute이면 x,y로 현재 값을 설정하고 delta이면 현재 값에 x,y값만큼을 더해서 설정.

Sample

//컴포넌트의 top만 100px로 설정. componentId.setPosition(null, 100);

setReadOnly( readOnly )

readOnly 속성값을 설정한다. readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력합니다.

Parameter
name	type	required	description
readOnly	Boolean	Y	readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false

Sample

//컴포넌트의 readonly 적용. componentId.setReadOnly(true);

setSize( width , heigth )

컴포넌트의 크기(width,height)를 설정한다.

Parameter
name	type	required	description
width	Number	Y	새로 설정할 컴포넌트의 width값 또는 null
heigth	Number	Y	새로 설정할 컴포넌트의 height값 또는 null

Sample

//컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);

setStyle( propertyName , value )

컴포넌트의 property별 style을 설정한다.

Parameter
name	type	required	description
propertyName	String	Y	style 속성 이름
value	String	Y	적용 할 style의 값

Sample

//컴포넌트의 width를 200px로 설정 할 경우 componentId.setStyle("width", "200px"); //배경색을 olive로 변경 할 경우 componentId.setStyle("background-color","olive");

setUserData( key , value )

컴포넌트에 사용자 데이터를 설정한다. 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하며 log에 관련 내용이 출력 된다.

Parameter
name	type	required	description
key	String	Y	임의 데이터의 키
value	String	Y	임의 데이터의 값

Sample

//컴포넌트에 'data'라는 key로 'WebSquare'라는 값을 설정 할 경우 componentId.setUserData("data", "WebSquare"); //아래와 같이 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하다. componentId.setUserData("title", "WebSquare"); //log 표현 예시 ) !!!WARNING - [title] can't define as UserData

show( displayType )

컴포넌트를 화면에 보이도록 설정한다.
엔진 내부적으로는 CSS를 display속성과 visibility:show;으로 처리한다.

Parameter
name	type	required	description
displayType	String	N	[default:block ,inline ,none ,""]display의 속성 값.

Sample

//display 속성이 "block"이 된다. componentId.show(); //class에 적용된 display 속성 값을 다시 복구. componentId.show("");

toggleClass( className )

컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
기본 설정은 addClass API를 통해 추가 된 class만 삭제되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	설정 할 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
name	type	required	description
type	String	Y	발생시킬 이벤트 이름
array	Array	N	이벤트 핸들러에 전달할 파라미터 배열

Sample

//input1 컴포넌트에 onclick이벤트를 발생시킨다. input1.trigger("onclick"); //input1에 onviewchange이벤트를 발생시키고 핸들러 함수에 (1,2) 인자를 전달하여 호출한다. input1.trigger("onviewchange", [1,2]);

unbind( type , function )

컴포넌트에 등록 된 이벤트를 제거한다.

Parameter
name	type	required	description
type	String	N	제거할 이벤트 이름. 생략할 경우 해당 컴포넌트의 모든 이벤트를 제거한다.
function	Function	N	제거할 이벤트의 핸들러 함수. 생략할 경우 해당 이벤트 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
name	type	required	description
flag	Boolean	Y	visibility 값을 설정할 값(true이면 "visible", false이면 "hidden"을 설정)