WebSquare.uiplugin.tabContainer

탭 컨테이너. 탭 형태의 화면을 생성. 다수의 Layer 내에 여러 화면들을 탭으로 구성하여 사용자가 선택한 탭에 포함된 화면을 표시.

Type

uiplugin

Property Summary

alwaysDraw: contents안의 내용을 미리 그려줄지 여부
class: HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
contentsClass: 모든 contents에 적용할 class
id: 컴포넌트 ID.
selectedIndex: 선택된 tab의 index
tabDefaultCenterImageClass: tab의 기본적인 중앙 이미지 class
tabDefaultCenterImageStyle: tab의 기본적인 중앙 이미지 style
tabDefaultLeftImageClass: tab의 기본적인 왼쪽 이미지 class
tabDefaultLeftImageStyle: tab의 기본적인 왼쪽 이미지 style
tabDefaultRightImageClass: tab의 기본적인 오른쪽 이미지 class
tabDefaultRightImageStyle: tab의 기본적인 오른쪽 이미지 style
tabHoverCenterImageClass: tab의 마우스가 올라갔을때 중앙 이미지 class
tabHoverCenterImageStyle: tab의 위에 마우스가 올라갔을때 중앙 이미지 style
tabHoverLeftImageClass: tab의 위에 마우스가 올라갔을때 왼쪽 이미지 class
tabHoverLeftImageStyle: tab의 위에 마우스가 올라갔을때 왼쪽 이미지 style
tabHoverRightImageClass: tab의 마우스가 올라갔을때 오른쪽 이미지 class
tabHoverRightImageStyle: tab의 위에 마우스가 올라갔을때 오른쪽 이미지 style
tabPosition: tab의 위치를 자동으로 해줄지 사용자가 absolute로 해줄지 여부
tabSelectedCenterImageClass: tab이 선택되었을때 중앙 이미지 class
tabSelectedCenterImageStyle: tab의 선택되었을때 중앙 이미지 style
tabSelectedLeftImageClass: tab이 선택되었을때 왼쪽 이미지 class
tabSelectedLeftImageStyle: tab의 선택되었을때 왼쪽 이미지 style
tabSelectedRightImageClass: tab이 선택되었을때 오른쪽 이미지 class
tabSelectedRightImageStyle: tab의 선택되었을때 오른쪽 이미지 style
userData1: 사용자 정의 데이터 속성
userData2: 사용자 정의 데이터 속성
userData3: 사용자 정의 데이터 속성

Event Summary

onbeforeselect: tab이 선택되기 전에 발생
onchange: tab이 바뀐 경우에 발생
ontabclick: tab이 클릭된 경우 발생

Method Summary

addClass( className ): 컴포넌트에 CSS class를 추가
addTab( id , options ): id를 아이디로 가진 tab을 추가.
bind( eventType , function ): 컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당
changeClass( oldClassName , newClassName ): 웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
deleteTab( idx ): 해당 idx의 tab을 찾아서 삭제합니다
disableTab( idx ): 해당 idx의 tab을 찾아서 disable시킵니다
enableTab( idx ): 해당 idx의 tab을 찾아서 enable시킵니다
focus( ): 웹스퀘어 컴포넌트에 포커스를 줌
getCount( ): tab의 전체 갯수를 반환합니다
getDisabled( ): 현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환
getGenerator( ): 컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환
getID( ): 웹스퀘어 컴포넌트의 ID를 반환
getInitStyle( CSS ): 웹스퀘어 컴포넌트의 초기 스타일을 반환
getLabelText( idx ): idx로 tab을 찾아서 tab의 label을 반환합니다
getOpacity( ): 웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
getOriginalID( ): 웹스퀘어 컴포넌트의 originalID를 반환. (웹스퀘어 컴포넌트 공통.)
getPluginName( ): 웹스퀘어 컴포넌트의 이름(pluginName)을 반환
getPosition( positionName ): 웹스퀘어 컴포넌트의 위치(left, top)를 반환. (웹스퀘어 컴포넌트 공통.)
getReadOnly( ): 현재 웹스퀘어 컴포넌트에 설정된 readOnly 속성 값을 반환
getScope( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getScopeWindow( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getSelectedID( ): 선택된 tab의 id를 반환합니다
getSelectedIndex( ): 선택된 tab의 index를 반환합니다
getSize( sizeName ): 웹스퀘어 컴포넌트의 크기(width, height)를 반환. (웹스퀘어 컴포넌트 공통.)
getStyle( propertyName ): 웹스퀘어 컴포넌트의 CSS 속성 값을 반환
getStyleValue( style ): [deprecated]
getTitle( ): 컴포넌트의 title 속성 값을 반환
getUdcHome( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 파일명을 포함해서 반환. (웹스퀘어 컴포넌트 공통.)
getUdcRoot( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 반환. (웹스퀘어 컴포넌트 공통.)
getUserData( key ): setUserData로 웹스퀘어 컴포넌트에 설정한 key의 value 혹은 사용자가 직접 페이지 소스(XML)에 속성으로 정의한 value를 반환
getWindow( idx ): Tab Index에 해당하는 window content를 반환한다.
hasClass( className ): 웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인
hide( ): 웹스퀘어 컴포넌트를 화면에서 숨김. (웹스퀘어 컴포넌트 공통.)
init( options ): 컴포넌트 하위의 옵션에 해당하는 컴포넌트를 제외한 컴포넌트의 값을 초기화
invoke( funcName , param , options ): 컴포넌트 하위의 모든 컴포넌트의 함수를 동일하게 호출.
removeClass( className ): 웹스퀘어 컴포넌트에서 class를 삭제. (웹스퀘어 컴포넌트 공통.)
setDisabled( disabled ): 웹스퀘어 컴포넌트의 disabled 속성을 설정
setEventPause( evList , flag ): 지정한 이벤트를 중단함
setInitStyle( property ): 웹스퀘어 컴포넌트의 초기 스타일을 복구
setLabelText( idx , label ): idx로 tab을 찾아서 tab의 label을 바꿔줍니다
setOpacity( value ): 웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
setPosition( left , top , mode ): 웹스퀘어 컴포넌트의 위치(left, top)를 설정
setReadOnly( readOnly ): 웹스퀘어 컴포넌트의 readOnly 속성을 설정
setSelectedIndex( idx ): tab의 index를 인자로 받아 그 index로 tab을 선택해줍니다
setStyle( propertyName , value ): 웹스퀘어 컴포넌트의 CSS 속성을 설정
setUserData( key , value ): 웹스퀘어 컴포넌트에 임의의 데이터를 설정. (웹스퀘어 컴포넌트 공통.)
show( displayType ): 웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
toggleClass( className ): 웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
trigger( type , array ): 컴포넌트에서 특정 이벤트를 발생시킴
unbind( type , function ): 컴포넌트에서 이벤트를 제거
visible( flag ): [deprecated]

Property Detail

alwaysDraw: contents안의 내용을 미리 그려줄지 여부
class: HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
Engine 내부에서 각 컴포넌트 별로 지정된 class를 적용하나, class 속성을 이용하여 컴포넌트의 CSS를 제어 가능.
contentsClass: 모든 contents에 적용할 class
id: 컴포넌트 ID.
컴포넌트 ID는 전역 객체로 할당됨. 각 컴포넌트 ID를 통해 Script에서 해당 컴포넌트에 접근 가능.
selectedIndex: 선택된 tab의 index
tabDefaultCenterImageClass: tab의 기본적인 중앙 이미지 class
tabDefaultCenterImageStyle: tab의 기본적인 중앙 이미지 style
tabDefaultLeftImageClass: tab의 기본적인 왼쪽 이미지 class
tabDefaultLeftImageStyle: tab의 기본적인 왼쪽 이미지 style
tabDefaultRightImageClass: tab의 기본적인 오른쪽 이미지 class
tabDefaultRightImageStyle: tab의 기본적인 오른쪽 이미지 style
tabHoverCenterImageClass: tab의 마우스가 올라갔을때 중앙 이미지 class
tabHoverCenterImageStyle: tab의 위에 마우스가 올라갔을때 중앙 이미지 style
tabHoverLeftImageClass: tab의 위에 마우스가 올라갔을때 왼쪽 이미지 class
tabHoverLeftImageStyle: tab의 위에 마우스가 올라갔을때 왼쪽 이미지 style
tabHoverRightImageClass: tab의 마우스가 올라갔을때 오른쪽 이미지 class
tabHoverRightImageStyle: tab의 위에 마우스가 올라갔을때 오른쪽 이미지 style
tabPosition: tab의 위치를 자동으로 해줄지 사용자가 absolute로 해줄지 여부
tabSelectedCenterImageClass: tab이 선택되었을때 중앙 이미지 class
tabSelectedCenterImageStyle: tab의 선택되었을때 중앙 이미지 style
tabSelectedLeftImageClass: tab이 선택되었을때 왼쪽 이미지 class
tabSelectedLeftImageStyle: tab의 선택되었을때 왼쪽 이미지 style
tabSelectedRightImageClass: tab이 선택되었을때 오른쪽 이미지 class
tabSelectedRightImageStyle: tab의 선택되었을때 오른쪽 이미지 style
userData1: 사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있음.
userData2: 사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있음.
userData3: 사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있음.

Event Detail

onbeforeselect

tab이 선택되기 전에 발생

Parameter
name	type	description
selectedIndex	Number:Y	현재 선택된 인덱스
index	Number:Y	사용자가 선택하려는 인덱스

Sample

ev:event="onbeforeselect(selectedIndex, index)" 로 이벤트의 인자가 정의된 예: tab1에서 tab2를 선택. <script ev:event="onbeforeselect(selectedIndex, index)" type="javascript"><![CDATA[ output1.setValue(selectedIndex +"->" +index); return true; // 탭이동한다. (return false;: 탭이동이 없음.) ]]></script> output1의 표현되는 값은 0 -> 1 이며, tab2로 이동.

onchange

tab이 바뀐 경우에 발생

ontabclick

tab이 클릭된 경우 발생

Method Detail

addClass( className )

컴포넌트에 CSS class를 추가. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
className	String	Y	추가할 class의 이름

Sample

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

addTab( id , options )

id를 아이디로 가진 tab을 추가.
같은 id의 tab이 존재하면 해당 탭을 선택.

Parameter
name	type	required	description
id	String	Y	새로만들 tab의 아이디
options	Object	Y	새로만들 tab의 옵션

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, var options = { label : "addTab", frameMode : "iframe", src : "/addTabContent.xml" }; tabContainer1.addTab('tab4', options); 4번째 tab이 생성된다.

bind( eventType , function )

컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
eventType	String	Y	할당할 이벤트
function	Function	Y	이벤트에 대한 핸들러 함수.

Sample

// (예제 1) // input1의 onclick 이벤트에 대한 핸들러 함수를 직접 정의하여 할당. input1.bind("onclick", function(e){ alert(input1.getValue();})); // (예제 2) // 미리 commObj.ev_click 함수를 정의. var commObj = {}; commObj.ev_click = function(e){ alert("click :: "+this.id); }; // input1 컴포넌트에 onclick 이벤트와 정의한 핸들러 함수를 동적으로 할당. input1.bind("onclick", commObj.ev_click );

changeClass( oldClassName , newClassName )

웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
기본적으로 addClass를 통해 추가된 class만 변경 가능.
웹스퀘어 컴포넌트의 class 속성에 직접 정의된 class를 삭제하려면 config.xml 파일에 아래 설정을 추가해야 함. // config.xml에 아래 설정을 추가. <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
oldClassName	String	Y	변경할 class
newClassName	String	Y	새로 사용할 class

Sample

// inputBox 컴포넌트에 class가 속성으로 직접 정의됨. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // config.xml 파일에 아래를 추가. <style> <removeDefaultClass value="true" /> </style> // class를 변경 가능. // (tmpInputClass class를 tmpInputWarninClass로 변경.) input1.changeClass("tmpInputClass","tmpInputWarninClass");

deleteTab( idx )

해당 idx의 tab을 찾아서 삭제합니다.

Parameter
name	type	required	description
idx	Number	Y	index or id

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer1.deleteTab(0); 첫번째 tab(tab1)이 삭제된다.

disableTab( idx )

해당 idx의 tab을 찾아서 disable시킵니다.

Parameter
name	type	required	description
idx	Number	Y	disable시킬 tab의 인덱스

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer1.disableTab(0); 첫번째 tab(tab1)이 비활성화된다. 만약 첫번째 tab(tab1)이 선택되어 있는 경우, 두번째 tab(tab2)이 선택된다.

enableTab( idx )

해당 idx의 tab을 찾아서 enable시킵니다.

Parameter
name	type	required	description
idx	Number	Y	enable시킬 tab의 인덱스

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, 첫번째 tab이 비활성화 되어 있다. tabContainer1.enableTab(0); 첫번째 tab(tab1)이 활성화된다.

focus( )

웹스퀘어 컴포넌트에 포커스를 줌. (웹스퀘어 컴포넌트 공통.)

getCount( )

tab의 전체 갯수를 반환합니다.

Return
type	description
Number	tab의 전체 갯수

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, var returnValue = tabContainer1.getCount(); returnValue는 3이다.

getDisabled( )

현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
Boolean	disabled 속성 값

Sample

// 컴포넌트의 disabled 속성 값 확인 예제 var returnValue = componentId.getDisabled(); // (반환 값 예시) false

getGenerator( )

컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
Object	부모 Generator 객체

Sample

//부모 Generator가 자식으로 Trigger를 생성한 예제 <w2:generator id="generator1"> <w2:trigger id="trigger1" ev:onclick="scwin.trigger1_onclick"></w2:trigger></w2:generator> // 아래 예제의 경우 trigger1을 클릭하면 generator1 객체가 console에 표시됨. scwin.trigger1.onclick = function(){ console.log(this.getGenerator());}

getID( )

웹스퀘어 컴포넌트의 ID를 반환. (웹스퀘어 컴포넌트 공통.)

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

Sample

// 동적으로 웹스퀘어 컴포넌트를 받을 경우, 아래와 같이 ID 확인 가능. function fn_validCheck(tmpObj){ var compID = tmpObj.getID(); } // 위의 예제 에서 tmpObj가 "input1" ID를 가지고 있는 경우, // (반환 값) "input1"

getInitStyle( CSS )

웹스퀘어 컴포넌트의 초기 스타일을 반환. (웹스퀘어 컴포넌트 공통.)

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

getLabelText( idx )

idx로 tab을 찾아서 tab의 label을 반환합니다.

Parameter
name	type	required	description
idx	Number	Y	tab의 index

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, 각 tab의 value는 1 ,2 ,3 이고 tabContainer의 두번째 tab(tab2)가 선택되어 있을 때. var returnValue = tabContainer1.getLabelText(); returnValue는 2이다.

getOpacity( )

웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
엔진 내부적으로 CSS의 opacity 속성 값을 반환.

Return
type	description
Integer	Opacity 값

Sample

// inputBox 컴포넌트에 opacity CSS를 적용. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;opacity:0.2;"></xf:input> // inputBox 컴포넌트의 opacity 값을 반환. var returnValue = input1.getOpacity(); // returnValue는 0 ~ 1 사이의 실수. // (반환 값) "0.2"

getOriginalID( )

웹스퀘어 컴포넌트의 originalID를 반환. (웹스퀘어 컴포넌트 공통.)
originalID는 Scope 기능을 사용할 경우 존재.
scope="true"인 WFrame를 사용할 경우, WFrame 내부의 컴포넌트 ID는 원래 사용자가 정의한 값(originalID) 앞에 prefix(wframeID + "_")가 추가되는 방식으로 변경됨.
originalID는 이 때, prefix가 추가되기 전 ID를 의미.

Return
type	description
String	컴포넌트의 originalID

Sample

// WFrame을 사용하는 다중 화면 구조 예시 // WFrame을 포함한 메인 화면 (main.xml) <w2:wframe id="wframe1" src="text.xml" scope="true"/> // 메인 화면 WFrame에 연결되는 소스 화면 (text.xml) <w2:textbox id="textbox1"/> // text.xml 화면의 내부 스크립트에서 ID 및 originalID 확인하는 예제. // getID 실행 textbox1.getID(); // 실행 결과는 "wframe1_textbox1" // getOriginalID 실행 textbox1.getOriginalID(); // 실행 결과는 "textbox1"

getPluginName( )

웹스퀘어 컴포넌트의 이름(pluginName)을 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
String	웹스퀘어 컴포넌트의 이름 (pluginName)

Sample

// 아래와 같이 공통 함수에서 동적으로 웹스퀘어 객체를 받는 경우, 컴포넌트 종류에 따른 분기 처리가 가능. 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 컴포넌트에 CSS 속성 margin이 적용된 경우, <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin:10px;"></xf:input> // (예제) 위의 inputBox 컴포넌트의 top 값을 확인 var returnValue = input1.getPosition("top"); // 픽셀 단위의 위치 값이 반환됨. // (반환 값) 10

getReadOnly( )

현재 웹스퀘어 컴포넌트에 설정된 readOnly 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)

Return
type	description
Boolean	현재 설정되어있는 readOnly 속성

Sample

// 컴포넌트의 readOnly 속성 값 확인 예제 var returnValue = componentId.getReadOnly(); // (반환 값 예시) false

getScope( )

scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
scope="true"인 WFrame의 자식 컴포넌트가 아닌 경우, null을 반환.

Return
type	description
Object	WFrame 객체 또는 null

Sample

// (예제) // 메인페이지에 wframe1이 있고, wframe1 내부에 wframe11이 존재. // 그리고, wframe11 내부에 textbox1이 존재. textbox1.getScope(); // (반환 값) wframe11 객체

getScopeWindow( )

scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
scope="true"인 WFrame의 자식 컴포넌트가 아닌 경우, 전역 window 객체를 반환.

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

Sample

// (예제) // 메인페이지에 wframe1이 있고, wframe1 내부에 wframe11이 존재. // 그리고, wframe11 내부에 textbox1이 존재. var scope = textbox1.getScopeWindow(); scope.wframe11 === textbox1.getScope(); // true

getSelectedID( )

선택된 tab의 id를 반환합니다.

Return
type	description
String	선택된 tab의 id

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer의 두번째 tab(tab2)가 선택되어 있을 때. var returnValue = tabContainer1.getSelectedID(); returnValue는 tab2이다.

getSelectedIndex( )

선택된 tab의 index를 반환합니다.

Return
type	description
Number	선택된 tab의 index

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer의 두번째 tab(tab2)가 선택되어 있을 때. var returnValue = tabContainer1.getSelectedIndex(); returnValue는 1이다.

getSize( sizeName )

웹스퀘어 컴포넌트의 크기(width, height)를 반환. (웹스퀘어 컴포넌트 공통.)
%로 설정된 경우, 픽셀로 변환된 값을 반환.

Parameter
name	type	required	description
sizeName	String	Y	크기 값의 종류. sizeName 별 계산 방법은 아래 표를 참고.

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

Sample

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

getStyle( propertyName )

웹스퀘어 컴포넌트의 CSS 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
propertyName	String	Y	반환할 CSS 속성

Return
type	description
String	CSS 속성 값

Sample

//아래와 같이 input 컴포넌트가 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;"></xf:input> // (예제) 위의 inputBox 컴포넌트의 width 값을 확인 var returnValue = input1.getStyle("width"); // (반환 값) "144px"

getStyleValue( style )

[deprecated]
getStyle 사용 권장.
웹스퀘어 컴포넌트에 적용된 해당 CSS 속성 값을 반환.

Parameter
name	type	required	description
style	String	Y	반환하려는 CSS 속성.

Return
type	description
String	style 해당 CSS 속성 값 (색을 반환하는 경우, 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(); // (반환 값 예시) "이름 입력"

getUdcHome( )

UDC 객체가 자신을 정의한 UDC 파일 경로를 파일명을 포함해서 반환. (웹스퀘어 컴포넌트 공통.)
파일명은 마지막 .xml까지 포함. .xml을 제외한 경로는 getUdcRoot를 사용해서 반환.
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 파일 경로를 반환. (웹스퀘어 컴포넌트 공통.)
파일명을 포함하지 않음. 파일명을 포함한 경로는 getUdcHome을 사용해서 반환.
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로 웹스퀘어 컴포넌트에 설정한 key의 value 혹은 사용자가 직접 페이지 소스(XML)에 속성으로 정의한 value를 반환. (웹스퀘어 컴포넌트 공통.)

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

Return
type	description
String	key에 해당하는 value

Sample

// Input 컴포넌트에 사용자 속성(setTest)을 설정하는 예제 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" setTest="Hello"></xf:input> // 위에서 설정한 setTest을 값을 반환하는 예제. input1.getUserData("setTest"); // (반환 값) "Hello" //setUserData를 통해 'valueTest'(key)와 'WebSquare'(data)로 설정하는 예제. input1.setUserData("valueTest","WebSquare"); // 위에서 설정한 setTest을 값을 반환하는 예제. input1.getUserData("WebSquare"); // (반환 값) "WebSquare"

getWindow( idx )

Tab Index에 해당하는 window content를 반환한다.
index가 없으며 현재 선택된 Tab의 window content를 반환한다.

Parameter
name	type	required	description
idx	Number	N	Tab Index

Return
type	description
Object	window

hasClass( className )

웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
className	String	Y	검색할 class 이름

Return
type	description
Boolean	class의 포함 여부

Sample

// inputBox 컴포넌트에 class가 속성으로 직접 정의됨. <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> var returnValue = input1.hasClass("tmpInputClass"); // (반환 값) true

hide( )

웹스퀘어 컴포넌트를 화면에서 숨김. (웹스퀘어 컴포넌트 공통.)
display:none; 및 visibility:hidden; CSS를 적용.

Sample

// (예제) 컴포넌트를 숨김 componentId.hide();

init( options )

컴포넌트 하위의 옵션에 해당하는 컴포넌트를 제외한 컴포넌트의 값을 초기화. (calendar, checkbox, grid, input, inputCalendar, multiselect, radio, selectbox, textarea)

Parameter
name	type	required	description
options	Object	N	초기화 동작에서 제외되는 컴포넌트를 설정하는 값의 객체(excludePlugin, excludeId을 속성으로 지정)

Sample

tabContainer1.init(); tabContainer 컴포넌트 하위에 있는 초기화가 가능한 컴포넌트에 대하여 초기화. var options = { excludePlugin : "grid radio", excludeId : "input1 calendar1", fireEvent : true }; tabContainer1.init(options); tabContainer 컴포넌트 하위에 있는 grid, radio, id가 input1인 input, id가 calendar1인 calendar 컴포넌트를 제외한 컴포넌트 가운데 초기화가 가능한 컴포넌트에 대해 초기화하며, 값 변경에 따른 이벤트를 발생시킨다.

invoke( funcName , param , options )

컴포넌트 하위의 모든 컴포넌트의 함수를 동일하게 호출.
예) tabContainer 이하의 모든 컴포넌트에 setValue를 실행 가능.

Parameter
name	type	required	description
funcName	String	Y	호출하려는 함수의 이름
param	Object	N	호출하려는 함수에 넘겨질 인자 혹은 그 인자를 반환하는 함수 객체
options	Object	N	함수 호출에서 제외되는 컴포넌트를 설정하는 값의 객체.

Sample

tabContainer1.invoke("setValue", "WebSquare"); tabContainer 하위의 모든 컴포넌트에 componentId.setValue("WebSquare"); 한것과 같다. 만약 하위의 컴포넌트에 setValue 함수를 가지지 않는 컴포넌트(예:grid)가 있다면 에러. function createValue(obj){ var pluginName = obj.getPluginName(); // 컴포넌트의 종류. var id = obj.getID(); // 컴포넌트의 id. ... } var options = { excludePlugin : "grid calendar", excludeId : "radio1" }; tabContainer1.invoke("setValue", createValue, options); tabContainer 하위의 grid와 calendar, id가 radio1인 컴포넌트를 제외하고 componentId.setValue(사용자 정의 함수(createValue)를 호출하여 반환된 리턴 값); 한것과 같다.

removeClass( className )

웹스퀘어 컴포넌트에서 class를 삭제. (웹스퀘어 컴포넌트 공통.)
기본적으로 addClass를 통해 추가된 class만 삭제 가능.
컴포넌트의 속성으로 직접 정의된 class를 삭제하기 위해서는 config.xml 파일에 아래 설정을 추가해야 함. // config.xml 파일에 아래 설정 추가 <style><removeDefaultClass value="true" /></style>

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

Sample

// inputBox의 속성으로 class가 직접 정의된 경우, <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" class="tmpInputClass"></xf:input> // config.xml 파일에 아래 항목을 추가. <style> <removeDefaultClass value="true" /> </style> // removeClass를 통해 삭제 가능. input1.removeClass("tmpInputClass");

setDisabled( disabled )

웹스퀘어 컴포넌트의 disabled 속성을 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
disabled	Boolean	Y	disabled 상태.

Sample

// 컴포넌트의 disabled 속성을 활성화. componentId.setDisabled(true);

setEventPause( evList , flag )

지정한 이벤트를 중단함. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
evList	String	N	중단할 이벤트 목록. (null을 지정할 경우 해당 컴포넌트의 모든 사용자 이벤트가 중단되거나 중단 해제됨.)
flag	Boolean	Y	이벤트 중단 여부.

Sample

// (예제 1) // onclick 이벤트를 중단. input1.setEventPause("onclick", true); // (예제 2) // onfocus 및 onblur 이벤트의 중단을 해제. input1.setEventPause("onfocus,onblur", false); // (예제 3) // input1에 등록된 모든 사용자 이벤트를 중단. input1.setEventPause(null, true);

setInitStyle( property )

웹스퀘어 컴포넌트의 초기 스타일을 복구. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
property	String	N	CSS 속성 (지정하지 않으면 모든 속성의 초기 값으로 복구.)

Sample

// (예제) group1.setInitStyle();

setLabelText( idx , label )

idx로 tab을 찾아서 tab의 label을 바꿔줍니다.

Parameter
name	type	required	description
idx	Number	Y	label을 바꿀 tab의 인덱스
label	String	Y	바꿔줄 label값

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer1.setLabelText(0, "TAB_1"); 첫번째 tab(tab1)의 텍스트를 TAB_1로 설정한다.

setOpacity( value )

웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
엔진 내부적으로 CSS 속성인 opacity(불투명도)를 설정.

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

Sample

// (예제) 불투명도를 0.45로 설정 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	위치 설정 방법. [default: absolute, delta]

Sample

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

setReadOnly( readOnly )

웹스퀘어 컴포넌트의 readOnly 속성을 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
readOnly	Boolean	Y	readOnly 속성 활성화 여부. ( "true" : 활성화, "false" : 비활성화)

Sample

// 컴포넌트의 readOnly 속성을 true로 설정하는 예. componentId.setReadOnly(true);

setSelectedIndex( idx )

tab의 index를 인자로 받아 그 index로 tab을 선택해줍니다.

Parameter
name	type	required	description
idx	Number	Y	선택하려는 index

Sample

예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer1.setSelectedIndex(0); tabContainer의 첫번째 tab(tab1) contents가 보인다. tab2, tab3의 contents는 보이지 않는다.

setStyle( propertyName , value )

웹스퀘어 컴포넌트의 CSS 속성을 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
propertyName	String	Y	설정할 CSS 속성
value	String	Y	해당 CSS 속성에 적용할 값

Sample

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

setUserData( key , value )

웹스퀘어 컴포넌트에 임의의 데이터를 설정. (웹스퀘어 컴포넌트 공통.)
컴포넌트에 설정 가능한 key를 입력해야 함. 설정 가능한 key가 아닌 경우, 해당 내용이 로그에 출력됨.

Parameter
name	type	required	description
key	String	Y	설정할 데이터의 key
value	String	Y	설정한 데이터의 value

Sample

// 컴포넌트에 'data'라는 key로 'WebSquare'라는 value를 설정하는 예제. componentId.setUserData("data", "WebSquare"); // 컴포넌트에 설정이 불가능한 key를 임력할 경우, key 설정이 불가능. componentId.setUserData("title", "WebSquare"); // 아래와 같이 로그가 출력됨. // !!!WARNING - [title] can't be defined as UserData.

show( displayType )

웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
CSS display 속성을 주어진 값으로 설정하고 "visibility: show;"를 적용.

Parameter
name	type	required	description
displayType	String	N	적용할 CSS display 속성의 값.

Sample

// (예제) display: block; CSS를 설정. componentId.show(); // (예제) 위제 설정한 display 속성 값을 취소하고 원래의 display 값을 복구. componentId.show("");

toggleClass( className )

웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
웹스퀘어 컴포넌트가 파라미터로 주어진 class를 포함한 경우, 해당 class를 제거.
웹스퀘어 컴포넌트에 파라미터로 주어진 class가 없는 경우, 해당 class를 추가.
기본적으로 addClass를 통해 추가된 class만 삭제 가능.
웹스퀘어 컴포넌트의 속성으로 직접 정의된 class를 삭제하기 위해서는 config.xml 파일에 아래 설정을 추가. // config.xml 파일에 아래 설정 추가 <style><removeDefaultClass value="true" /></style>

Parameter
name	type	required	description
className	String	Y	추가/삭제할 class

Sample

// inputBox 컴포넌트에 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

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

unbind( type , function )

컴포넌트에서 이벤트를 제거. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
type	String	N	제거할 이벤트. (생략할 경우 해당 컴포넌트의 모든 이벤트를 제거.)
function	Function	N	제거할 이벤트의 핸들러 함수. (생략할 경우 해당 위에 지정한 이벤트에 등록된 모든 핸들러 함수를 제거.)

Sample

// (예제 1) // input1에 등록된 모든 이벤트를 제거. input1.unbind(); // (예제 2) // input1의 onviewchange 이벤트에 대한 모든 핸들러 함수를 제거. input1.unbind("onviewchange"); // (예제 3) // input1의 onviewchange 이벤트에 대한 func1 이벤트 핸들러 함수를 제거. input1.unbind("onviewchange", func1);

visible( flag )

[deprecated]
show/hide 혹은 setStyle 사용을 권장.
엔진 내부적으로 CSS visibility 속성을 설정.

Parameter
name	type	required	description
flag	Boolean	Y	설정할 CSS visibility 속성 값