PropertyEventMethod찾아보기
TabContainer - 5.0_1.2484A.20170126.120903

tab형태의 화면을 구성할때 사용하는 컴포넌트 입니다.

Type

uiplugin

Property Summary

alwaysDraw
contents안의 내용을 미리 그려줄지 여부
class
tabContainer의 class 속성
contentsClass
모든 contents에 적용할 class
id
tabContainer 컴포넌트의 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 )
컴포넌트에 class를 추가한다
addTab( id , options , options.label , options.frameMode , options.src )
id를 아이디로 가진 tab을 추가합니다.
bind( eventType , function )
컴포넌트의 이벤트를 동적으로 할당한다
changeClass( oldClassName , newClassName )
컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
deleteTab( idx )
해당 idx의 tab을 찾아서 삭제합니다
disableTab( idx )
해당 idx의 tab을 찾아서 disable시킵니다
enableTab( idx )
해당 idx의 tab을 찾아서 enable시킵니다
focus( )
컴포넌트에 focus를 준다
getCount( )
tab의 전체 갯수를 반환합니다
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다
getID( )
웹스퀘어 컴포넌트의 id를 반환한다
getLabelText( idx )
idx로 tab을 찾아서 tab의 label을 반환합니다
getOpacity( )
CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다
getPluginName( )
웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다
getPosition( positionName )
컴포넌트의 left 또는 top의 위치 값을 반환한다
getReadOnly( )
현재 설정되어있는 readOnly 속성값을 반환한다
getSelectedID( )
선택된 tab의 id를 반환합니다
getSelectedIndex( )
선택된 tab의 index를 반환합니다
getSize( sizeName )
컴포넌트의 크기 값을 반환합니다
getStyle( propertyName )
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다
getStyleValue( style )
[deprecated]getStyle로 사용.
getTitle( )
title 속성값을 반환한다
getUserData( key )
setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
getWindow( idx )
Tab Index에 해당하는 window content를 반환한다.
hasClass( className )
컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다
hide( )
컴포넌트를 화면에서 보이지 않도록 숨긴다.
init( options , options.excludePlugin , options.excludeId , options.fireEvent )
컴포넌트 하위의 옵션에 해당하는 컴포넌트를 제외한 컴포넌트의 값을 초기화 시킵니다
invoke( funcName , param , options , options.excludePlugin , options.excludeId )
컴포넌트 하위의 모든 컴포넌트의 함수를 동일하게 호출시켜주는 함수입니다.
removeClass( className )
컴포넌트에 className의 class를 삭제한다.
setDisabled( disabled )
컴포넌트의 disabled 속성을 설정한다
setEventPause( evList , flag )
컴포넌트의 이벤트를 disable 또는 enable시킨다
setLabelText( idx , label )
idx로 tab을 찾아서 tab의 label을 바꿔줍니다
setOpacity( value )
컴포넌트의 CSS Opacity(불투명도)값를 설정한다
setPosition( left , top , mode )
컴포넌트의 위치(left,top)를 설정한다
setReadOnly( readOnly )
readOnly 속성값을 설정한다
setSelectedIndex( idx )
tab의 index를 인자로 받아 그 index로 tab을 선택해줍니다
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

alwaysDraw
contents안의 내용을 미리 그려줄지 여부
class
tabContainer의 class 속성
contentsClass
모든 contents에 적용할 class
id
tabContainer 컴포넌트의 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
사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2
사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3
사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.

Event Detail

onbeforeselect
tab이 선택되기 전에 발생
Parameter
nametypedescription
selectedIndexNumber:Y현재 선택된 인덱스
indexNumber: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 )
컴포넌트에 class를 추가한다.
Parameter
nametyperequireddescription
classNameStringY추가하고 싶은 class의 이름
Sample
//input1 컴포넌트에 oddClass 라는 class를 추가 할 때 input1.addClass("oddClass");
addTab( id , options , options.label , options.frameMode , options.src )
id를 아이디로 가진 tab을 추가합니다.
같은 id의 tab이 존재하면 추가가 아니라 선택합니다.
Parameter
nametyperequireddescription
idStringY새로만들 tab의 아이디
optionsObjectY새로만들 tab의 옵션
options.labelStringY: tab의 라벨 텍스트.
options.frameModeStringY: iframe.
options.srcStringY: contents안 쪽의 내용을 가지고있는 파일 주소.
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
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");
deleteTab( idx )
해당 idx의 tab을 찾아서 삭제합니다.
Parameter
nametyperequireddescription
idxNumberYindex or id
Sample
예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer1.deleteTab(0); 첫번째 tab(tab1)이 삭제된다.
disableTab( idx )
해당 idx의 tab을 찾아서 disable시킵니다.
Parameter
nametyperequireddescription
idxNumberYdisable시킬 tab의 인덱스
Sample
예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer1.disableTab(0); 첫번째 tab(tab1)이 비활성화된다. 만약 첫번째 tab(tab1)이 선택되어 있는 경우, 두번째 tab(tab2)이 선택된다.
enableTab( idx )
해당 idx의 tab을 찾아서 enable시킵니다.
Parameter
nametyperequireddescription
idxNumberYenable시킬 tab의 인덱스
Sample
예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, 첫번째 tab이 비활성화 되어 있다. tabContainer1.enableTab(0); 첫번째 tab(tab1)이 활성화된다.
focus( )
컴포넌트에 focus를 준다.
getCount( )
tab의 전체 갯수를 반환합니다.
Return
typedescription
Numbertab의 전체 갯수
Sample
예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, var returnValue = tabContainer1.getCount(); returnValue는 3이다.
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다.
Return
typedescription
Booleandisabled 속성값
Sample
var returnValue = componentId.getDisabled(); return 예시 ) false
getID( )
웹스퀘어 컴포넌트의 id를 반환한다.
Return
typedescription
String웹스퀘어 컴포넌트의 id
Sample
//동적으로 웹스퀘어 컴포넌트를 파라메터로 받았을 경우 아래와 같이 사용 할 수 있다. function fn_validCheck(tmpObj){ //tmpObj가 input1 이라는 ID를 가지고 있는 경우 var compID = tmpObj.getID(); //return 예시 ) "input1" }
getLabelText( idx )
idx로 tab을 찾아서 tab의 label을 반환합니다.
Parameter
nametyperequireddescription
idxNumberYtab의 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
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
getSelectedID( )
선택된 tab의 id를 반환합니다.
Return
typedescription
String선택된 tab의 id
Sample
예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer의 두번째 tab(tab2)가 선택되어 있을 때. var returnValue = tabContainer1.getSelectedID(); returnValue는 tab2이다.
getSelectedIndex( )
선택된 tab의 index를 반환합니다.
Return
typedescription
Number선택된 tab의 index
Sample
예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer의 두번째 tab(tab2)가 선택되어 있을 때. var returnValue = tabContainer1.getSelectedIndex(); returnValue는 1이다.
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"
getWindow( idx )
Tab Index에 해당하는 window content를 반환한다.
index가 없으며 현재 선택된 Tab의 window content를 반환한다.
Parameter
nametyperequireddescription
idxNumberNTab Index
Return
typedescription
Objectwindow
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( )
컴포넌트를 화면에서 보이지 않도록 숨긴다.
엔진 내부적으로는 CSS를 display:none;과 visibility:hidden;으로 처리한다.
Sample
componentId.hide();
init( options , options.excludePlugin , options.excludeId , options.fireEvent )
컴포넌트 하위의 옵션에 해당하는 컴포넌트를 제외한 컴포넌트의 값을 초기화 시킵니다. (calendar, checkbox, grid, input, inputCalendar, multiselect, radio, selectbox, textarea)
Parameter
nametyperequireddescription
optionsObjectN초기화 동작에서 제외되는 컴포넌트를 설정하는 값의 객체(excludePlugin, excludeId을 속성으로 지정)
options.excludePluginStringN: 초기화 기능에서 제외되는 컴포넌트의 명칭. 복수 개를 정의할 경우, 공백을 구분자로 한다.
options.excludeIdStringN: 초기화 기능에서 제외되는 컴포넌트 ID. 복수 개를 정의할 경우, 공백을 구분자로 한다.
options.fireEventBooleanN: 초기화로 인한 값 변동에 따라 이벤트 발생 여부로 기본값은 false. 이벤트 발생을 막는다.
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 , options.excludePlugin , options.excludeId )
컴포넌트 하위의 모든 컴포넌트의 함수를 동일하게 호출시켜주는 함수입니다.
예) tabContainer 이하의 모든 컴포넌트에 setValue를 하고 싶을 경우
Parameter
nametyperequireddescription
funcNameStringY호출하려는 함수의 이름
paramObjectN호출하려는 함수에 넘겨질 인자 혹은 그 인자를 반환하는 함수 객체
optionsObjectN함수 호출에서 제외되는 컴포넌트를 설정하는 값의 객체.
options.excludePluginStringN: 함수 호출에서 제외되는 컴포넌트의 명칭. 복수 개를 정의할 경우, 공백을 구분자로 한다.
options.excludeIdStringN: 함수 호출에서 제외되는 컴포넌트 ID. 복수 개를 정의할 경우, 공백을 구분자로 한다.
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 )
컴포넌트에 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");
setDisabled( disabled )
컴포넌트의 disabled 속성을 설정한다. disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력한다.
Parameter
nametyperequireddescription
disabledBooleanYdisabled 속성을 활성화 시키려면 true 비활성화 시키려면 false
Sample
//컴포넌트의 disabled 적용 componentId.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 한다.
setLabelText( idx , label )
idx로 tab을 찾아서 tab의 label을 바꿔줍니다.
Parameter
nametyperequireddescription
idxNumberYlabel을 바꿀 tab의 인덱스
labelStringY바꿔줄 label값
Sample
예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer1.setLabelText(0, "TAB_1"); 첫번째 tab(tab1)의 텍스트를 TAB_1로 설정한다.
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);
setSelectedIndex( idx )
tab의 index를 인자로 받아 그 index로 tab을 선택해줍니다.
Parameter
nametyperequireddescription
idxNumberY선택하려는 index
Sample
예: (id가 tab1, tab2, tab3) tab이 3개 있는 tabContainer의 경우, tabContainer1.setSelectedIndex(0); tabContainer의 첫번째 tab(tab1) contents가 보인다. tab2, tab3의 contents는 보이지 않는다.
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 )
컴포넌트를 화면에 보이도록 설정한다.
엔진 내부적으로는 CSS를 display속성과 visibility:show;으로 처리한다.
Parameter
nametyperequireddescription
displayTypeStringN[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
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"을 설정)