PropertyEventMethod찾아보기
WebSquare.uiplugin.Switch - 5.0_4.4373A.20210331.093729

스위치. 각 상황 별 화면을 동적으로 표시. 동적인 화면 전환을 지원. 즉, 여러 상황에 대한 복수의 Group들이 겹쳐 존재하고, 각 상황에 대한 Group을 동적으로 표시. 기본적으로 case1만이 존재하고, case 추가가 가능. 여러 레이어가 존재하나 조건에 따라 하나만 보여줄 때 사용. 탭과 비슷하게 동작하지만, 화면에 표시할 case는 API를 통해 설정 가능.

Type

uiplugin

Property Summary

alwaysDraw
switch를 그릴때 case들을 html로 넣어줄지 말지를 결정한다
caseClass
case에 적용할 class
class
HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
detectionRange
slide 인식 드레그 범위
id
컴포넌트 ID.
motionDisplay
slide시 이전/이후 case display 유무
rotation
rotation이 "true"이면 마지막 페이지에서 첫페이지로, 첫페이지에서 마지막으로 회전
slide
slide 적용 유무
tabIndex
Tab 키를 이용하여 포커스를 변경할 경우, 해당 컴포넌트에 포커스를 주는 순서.
toolTip
사용자가 컴포넌트에 마우스-오버할 때 표시되는 텍스트
touchMove
터치 또는 마우스로 슬라이드를 처리할지 유무
useSelect
slide시 onselectstart(마우스로 선택할때 발생하는 이벤트) 활성화 유무

Event Summary

onSelectedIndexChange
선택된 case가 변경될 때 발생

Method Summary

addClass( className )
컴포넌트에 CSS class를 추가
bind( eventType , function )
컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당
changeClass( oldClassName , newClassName )
웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
focus( )
웹스퀘어 컴포넌트에 포커스를 줌
getDisabled( )
현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환
getGenerator( )
컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환
getID( )
웹스퀘어 컴포넌트의 ID를 반환
getInitStyle( CSS )
웹스퀘어 컴포넌트의 초기 스타일을 반환
getOpacity( )
웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
getOriginalID( )
웹스퀘어 컴포넌트의 originalID를 반환. (웹스퀘어 컴포넌트 공통.)
getPluginName( )
웹스퀘어 컴포넌트의 이름(pluginName)을 반환
getPosition( positionName )
웹스퀘어 컴포넌트의 위치(left, top)를 반환. (웹스퀘어 컴포넌트 공통.)
getReadOnly( )
현재 웹스퀘어 컴포넌트에 설정된 readOnly 속성 값을 반환
getScope( )
scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getScopeWindow( )
scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getSelectedID( )
현재 선택된 case의 id를 반환합니다
getSelectedIndex( )
현재 설정되어있는 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를 반환
hasClass( className )
웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인
hide( )
웹스퀘어 컴포넌트를 화면에서 숨김. (웹스퀘어 컴포넌트 공통.)
init( options )
지정한 컴포넌트를 제외한 모든 하위 컴포넌트를 초기화하는 함수
insert( caseElement , options )
case를 동적으로 추가다
invoke( funcName , param , options )
컴포넌트 하위의 모든 컴포넌트의 함수를 동일하게 호출하는 함수.
moveToIndex( idx )
인자로 받은 index의 case를 선택하여 화면을 이동합니다
moveToLeft( )
이전 index의 case를 선택합니다
moveToRight( )
다음 index의 case를 선택합니다
removeClass( className )
웹스퀘어 컴포넌트에서 class를 삭제. (웹스퀘어 컴포넌트 공통.)
setDisabled( disabled )
컴포넌트의 disabled 속성을 설정
setEventPause( evList , flag )
지정한 이벤트를 중단함
setInitStyle( property )
웹스퀘어 컴포넌트의 초기 스타일을 복구
setOpacity( value )
웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
setPosition( left , top , mode )
웹스퀘어 컴포넌트의 위치(left, top)를 설정
setReadOnly( readOnly )
웹스퀘어 컴포넌트의 readOnly 속성을 설정
setSelectedID( id )
case를 id로 선택합니다
setSelectedIndex( idx , draw )
switch 객체의 index 를 인자로 받아 이에 맞는 case 를 사용자에게 보여줍니다
setSize( width , height )
웹스퀘어 컴포넌트의 크기(width, height)를 설정
setStyle( propertyName , value )
웹스퀘어 컴포넌트의 CSS 속성을 설정
setUserData( key , value )
웹스퀘어 컴포넌트에 임의의 데이터를 설정. (웹스퀘어 컴포넌트 공통.)
show( displayType )
웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
toggleClass( className )
웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
trigger( type , array )
컴포넌트에서 특정 이벤트를 발생시킴
unbind( type , function )
컴포넌트에서 이벤트를 제거
visible( flag )
[deprecated]

Property Detail

alwaysDraw
switch를 그릴때 case들을 html로 넣어줄지 말지를 결정한다.
caseClass
case에 적용할 class
class
HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
Engine 내부에서 각 컴포넌트 별로 지정된 class를 적용하나, class 속성을 이용하여 컴포넌트의 CSS를 제어 가능.
detectionRange
slide 인식 드레그 범위
id
컴포넌트 ID.
컴포넌트 ID는 전역 객체로 할당됨. 각 컴포넌트 ID를 통해 Script에서 해당 컴포넌트에 접근 가능.
motionDisplay
slide시 이전/이후 case display 유무
rotation
rotation이 "true"이면 마지막 페이지에서 첫페이지로, 첫페이지에서 마지막으로 회전
slide
slide 적용 유무
tabIndex
Tab 키를 이용하여 포커스를 변경할 경우, 해당 컴포넌트에 포커스를 주는 순서.
HTML의 tabindex 속성과 동일.
toolTip
사용자가 컴포넌트에 마우스-오버할 때 표시되는 텍스트. 웹스퀘어가 제공하는 툴팁으로, 컴포넌트의 추가 정보를 명시.
touchMove
터치 또는 마우스로 슬라이드를 처리할지 유무
useSelect
slide시 onselectstart(마우스로 선택할때 발생하는 이벤트) 활성화 유무

Event Detail

onSelectedIndexChange
선택된 case가 변경될 때 발생

Method Detail

addClass( className )
컴포넌트에 CSS class를 추가. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
classNameStringY추가할 class의 이름
Sample
// (예제) // input1 컴포넌트에 oddClass라는 class를 추가 input1.addClass("oddClass");
bind( eventType , function )
컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
eventTypeStringY할당할 이벤트
functionFunctionY이벤트에 대한 핸들러 함수.
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
nametyperequireddescription
oldClassNameStringY변경할 class
newClassNameStringY새로 사용할 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");
focus( )
웹스퀘어 컴포넌트에 포커스를 줌. (웹스퀘어 컴포넌트 공통.)
getDisabled( )
현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)
Return
typedescription
Booleandisabled 속성 값
Sample
// 컴포넌트의 disabled 속성 값 확인 예제 var returnValue = componentId.getDisabled(); // (반환 값 예시) false
getGenerator( )
컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환. (웹스퀘어 컴포넌트 공통.)
Return
typedescription
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
typedescription
String웹스퀘어 컴포넌트 ID
Sample
// 동적으로 웹스퀘어 컴포넌트를 받을 경우, 아래와 같이 ID 확인 가능. function fn_validCheck(tmpObj){ var compID = tmpObj.getID(); } // 위의 예제 에서 tmpObj가 "input1" ID를 가지고 있는 경우, // (반환 값) "input1"
getInitStyle( CSS )
웹스퀘어 컴포넌트의 초기 스타일을 반환. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
CSSStringN속성 (지정하지 않으면 모든 정보 출력)
getOpacity( )
웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
엔진 내부적으로 CSS의 opacity 속성 값을 반환.
Return
typedescription
IntegerOpacity 값
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
typedescription
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
typedescription
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
nametyperequireddescription
positionNameStringY[left, top] 위치 종류
Return
typedescription
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
typedescription
Boolean현재 설정되어있는 readOnly 속성
Sample
// 컴포넌트의 readOnly 속성 값 확인 예제 var returnValue = componentId.getReadOnly(); // (반환 값 예시) false
getScope( )
scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
scope="true"인 WFrame의 자식 컴포넌트가 아닌 경우, null을 반환.
Return
typedescription
ObjectWFrame 객체 또는 null
Sample
// (예제) // 메인페이지에 wframe1이 있고, wframe1 내부에 wframe11이 존재. // 그리고, wframe11 내부에 textbox1이 존재. textbox1.getScope(); // (반환 값) wframe11 객체
getScopeWindow( )
scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
scope="true"인 WFrame의 자식 컴포넌트가 아닌 경우, 전역 window 객체를 반환.
Return
typedescription
ObjectWFrame 객체의 scope 객체 또는 전역 window 객체
Sample
// (예제) // 메인페이지에 wframe1이 있고, wframe1 내부에 wframe11이 존재. // 그리고, wframe11 내부에 textbox1이 존재. var scope = textbox1.getScopeWindow(); scope.wframe11 === textbox1.getScope(); // true
getSelectedID( )
현재 선택된 case의 id를 반환합니다.
Return
typedescription
String선택된 case의 id
Sample
예: (id가 case1, case2, case3) case가 3개 있는 switch의 경우, switch의 두번째 case(case2)가 선택되어 있을 때. var returnValue = switch1.getSelectedID(); returnValue는 case1이다.
getSelectedIndex( )
현재 설정되어있는 index를 반환합니다.
Return
typedescription
Number현재 설정되어있는 index
Sample
예: (id가 case1, case2, case3) case가 3개 있는 switch의 경우, switch의 두번째 case(case2)가 선택되어 있을 때. var returnValue = switch1.getSelectedIndex(); returnValue는 1이다.
getSize( sizeName )
웹스퀘어 컴포넌트의 크기(width, height)를 반환. (웹스퀘어 컴포넌트 공통.)
%로 설정된 경우, 픽셀로 변환된 값을 반환.
Parameter
nametyperequireddescription
sizeNameStringY크기 값의 종류. sizeName 별 계산 방법은 아래 표를 참고.
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"); // (반환 예) 100 // 픽셀 단위의 크기 값이 반환됨. // %로 설정된 경우, 픽셀로 변환된 값이 반환됨.
getStyle( propertyName )
웹스퀘어 컴포넌트의 CSS 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
propertyNameStringY반환할 CSS 속성
Return
typedescription
StringCSS 속성 값
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
nametyperequireddescription
styleStringY반환하려는 CSS 속성.
Return
typedescription
Stringstyle 해당 CSS 속성 값 (색을 반환하는 경우, 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(); // (반환 값 예시) "이름 입력"
getUdcHome( )
UDC 객체가 자신을 정의한 UDC 파일 경로를 파일명을 포함해서 반환. (웹스퀘어 컴포넌트 공통.)
파일명은 마지막 .xml까지 포함. .xml을 제외한 경로는 getUdcRoot를 사용해서 반환.
UDC 객체가 아닌 컴포넌트에서 호출된 경우에는 undefined가 반환됨.
Return
typedescription
StringUDC 파일 경로. (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
typedescription
StringUDC 파일 경로. (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
nametyperequireddescription
keyStringY데이터의 key
Return
typedescription
Stringkey에 해당하는 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"
hasClass( className )
웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
classNameStringY검색할 class 이름
Return
typedescription
Booleanclass의 포함 여부
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
nametyperequireddescription
optionsObjectN초기화 동작에서 제외되는 컴포넌트를 지정하는 객체(excludePlugin, excludeId을 속성으로 지정)
<String:N> options.excludePlugin 초기화 기능에서 제외되는 컴포넌트의 명칭. 복수를 정의할 경우, 공백을 구분자로 사용. <String:N> options.excludeId 초기화 기능에서 제외되는 컴포넌트 ID. 복수를 정의할 경우, 공백을 구분자로 사용. <Boolean:N> options.fireEvent 초기화로 인한 값 변동에 따라 이벤트 발생 여부. true: 이벤트 발생 허용. false (기본 값): 이벤트 발생 방지.
Sample
// switch 컴포넌트 하위에 있는 초기화가 가능한 컴포넌트에 대하여 초기화. switch1.init(); //switch 컴포넌트 하위의 grid, radio, id가 input1인 input, id가 calendar1인 calendar 컴포넌트를 제외한 컴포넌트 가운데 초기화가 가능한 컴포넌트에 대해 초기화하고 값 변경에 따른 이벤트를 발생시킨다. var options = { excludePlugin : "grid radio", excludeId : "input1 calendar1", fireEvent : true }; switch1.init(options);
insert( caseElement , options )
case를 동적으로 추가다.
Parameter
nametyperequireddescription
caseElementXMLY동적으로 추가할 case의 dom element 객체 또는 dom element로 parsing이 가능한 string. (string으로 인자 전달 시 root노드에 xmlns:w2="http://www.inswave.com/websquare" xmlns:xf="http://www.w3.org/2002/xforms"를 추가해야 한다.)
optionsJSONN세부 설정
<Boolean:N> options.selected 동적으로 추가한 case가 화면에 바로 보이도록 함.
invoke( funcName , param , options )
컴포넌트 하위의 모든 컴포넌트의 함수를 동일하게 호출하는 함수.
예) switch 이하의 모든 컴포넌트에 setValue를 실행할 수 있음.
Parameter
nametyperequireddescription
funcNameStringY호출하려는 함수의 이름
paramObjectN호출하려는 함수에 넘겨질 인자 혹은 그 인자를 반환하는 함수 객체
optionsObjectN함수 호출에서 제외되는 컴포넌트를 설정하는 값의 객체.
<String:N> options.excludePlugin 함수 호출에서 제외되는 컴포넌트의 명칭. 복수 개를 정의할 경우, 공백을 구분자로 사용. <String:N> options.excludeId 함수 호출에서 제외되는 컴포넌트 ID. 복수 개를 정의할 경우, 공백을 구분자로 사용.
Sample
switch1.invoke("setValue", "WebSquare"); switch 하위의 모든 컴포넌트에 componentId.setValue("WebSquare"); 한것과 같다. 만약 하위의 컴포넌트에 setValue 함수를 가지지 않는 컴포넌트(예:grid)가 있다면 에러. function createValue(obj){ var pluginName = obj.getPluginName(); // 컴포넌트의 종류. var id = obj.getID(); // 컴포넌트의 id. ... } var options = { excludePlugin : "grid calendar", excludeId : "radio1" }; switch1.invoke("setValue", createValue, options); switch 하위의 grid와 calendar, id가 radio1인 컴포넌트를 제외하고 componentId.setValue(사용자 정의 함수(createValue)를 호출하여 반환된 리턴 값); 한것과 같다.
moveToIndex( idx )
인자로 받은 index의 case를 선택하여 화면을 이동합니다.
Parameter
nametyperequireddescription
idxNumberY선택하고자 하는 index
Sample
예: (id가 case1, case2, case3) case가 3개 있는 switch의 경우, switch의 두번째 case(case2)가 선택되어 있을 때. switch1.moveToIndex(2); 세번째 case(case3)이 선택된다. 오른쪽으로 이동.
moveToLeft( )
이전 index의 case를 선택합니다. setselectedIndex(현재값-1)과 같습니다.
Sample
예: (id가 case1, case2, case3) case가 3개 있는 switch의 경우, switch의 두번째 case(case2)가 선택되어 있을 때. switch1.moveToLeft(); 첫번째 case(case1)이 선택된다. 왼쪽으로 이동.
moveToRight( )
다음 index의 case를 선택합니다. setselectedIndex(현재값+1)과 같습니다.
Sample
예: (id가 case1, case2, case3) case가 3개 있는 switch의 경우, switch의 두번째 case(case2)가 선택되어 있을 때. switch1.moveToRight(); 세번째 case(case3)이 선택된다. 오른쪽으로 이동.
removeClass( className )
웹스퀘어 컴포넌트에서 class를 삭제. (웹스퀘어 컴포넌트 공통.)
기본적으로 addClass를 통해 추가된 class만 삭제 가능.
컴포넌트의 속성으로 직접 정의된 class를 삭제하기 위해서는 config.xml 파일에 아래 설정을 추가해야 함. // config.xml 파일에 아래 설정 추가 <style><removeDefaultClass value="true" /></style>
Parameter
nametyperequireddescription
classNameStringY삭제 할 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
nametyperequireddescription
disabledBooleanYdisabled 상태
true: disabled 속성 활성화 false: disabled 속성 비활성화
Sample
//컴포넌트에 disabled 설정 componentId.setDisabled(true);
setEventPause( evList , flag )
지정한 이벤트를 중단함. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
evListStringN중단할 이벤트 목록. (null을 지정할 경우 해당 컴포넌트의 모든 사용자 이벤트가 중단되거나 중단 해제됨.)
flagBooleanY이벤트 중단 여부.
true: 중단 false: 중단 해제.
Sample
// (예제 1) // onclick 이벤트를 중단. input1.setEventPause("onclick", true); // (예제 2) // onfocus 및 onblur 이벤트의 중단을 해제. input1.setEventPause("onfocus,onblur", false); // (예제 3) // input1에 등록된 모든 사용자 이벤트를 중단. input1.setEventPause(null, true);
setInitStyle( property )
웹스퀘어 컴포넌트의 초기 스타일을 복구. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
propertyStringNCSS 속성 (지정하지 않으면 모든 속성의 초기 값으로 복구.)
Sample
// (예제) group1.setInitStyle();
setOpacity( value )
웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
엔진 내부적으로 CSS 속성인 opacity(불투명도)를 설정.
Parameter
nametyperequireddescription
valueNumberYOpacity 값 (0과 1 사이의 실수)
Sample
// (예제) 불투명도를 0.45로 설정 componentId.setOpacity(0.45);
setPosition( left , top , mode )
웹스퀘어 컴포넌트의 위치(left, top)를 설정. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
leftNumberY설정할 left 위치 값 또는 null.
topNumberY설정할 top 위치 값 또는 null.
modeStringN위치 설정 방법. [default: absolute, delta]
absolute: 입력된 값을 위치로 설정. delta: 현재 위치에 입력된 left 및 top 값을 추가.
Sample
// (예제) 컴포넌트의 top만 100px로 설정. componentId.setPosition(null, 100);
setReadOnly( readOnly )
웹스퀘어 컴포넌트의 readOnly 속성을 설정. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
readOnlyBooleanYreadOnly 속성 활성화 여부. ( "true" : 활성화, "false" : 비활성화)
Sample
// 컴포넌트의 readOnly 속성을 true로 설정하는 예. componentId.setReadOnly(true);
setSelectedID( id )
case를 id로 선택합니다
Parameter
nametyperequireddescription
idStringYcase의 id
Sample
예: (id가 case1, case2, case3) case가 3개 있는 switch의 경우, switch1.setSelectedID("case1"); 첫번째 case(case1)이 선택된다.
setSelectedIndex( idx , draw )
switch 객체의 index 를 인자로 받아 이에 맞는 case 를 사용자에게 보여줍니다.
Parameter
nametyperequireddescription
idxNumberY선택하고자 하는 index
drawbooleanN선택된 영역의 style 처리 여부(default:true)
Sample
예: (id가 case1, case2, case3) case가 3개 있는 switch의 경우, switch1.setSelectedIndex(0); switch의 첫번째 case(case1)이 보여진다. case2, case3은 보이지 않는다.
setSize( width , height )
웹스퀘어 컴포넌트의 크기(width, height)를 설정. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
widthNumberY새로 설정할 컴포넌트의 width 값 또는 null
heightNumberY새로 설정할 컴포넌트의 height 값 또는 null
Sample
// (예제) 컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);
setStyle( propertyName , value )
웹스퀘어 컴포넌트의 CSS 속성을 설정. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
propertyNameStringY설정할 CSS 속성
valueStringY해당 CSS 속성에 적용할 값
Sample
// (예제 1) 컴포넌트의 width를 200px로 설정 componentId.setStyle("width", "200px"); // (예제 2) 배경색을 olive로 변경 componentId.setStyle("background-color","olive");
setUserData( key , value )
웹스퀘어 컴포넌트에 임의의 데이터를 설정. (웹스퀘어 컴포넌트 공통.)
컴포넌트에 설정 가능한 key를 입력해야 함. 설정 가능한 key가 아닌 경우, 해당 내용이 로그에 출력됨.
Parameter
nametyperequireddescription
keyStringY설정할 데이터의 key
valueStringY설정한 데이터의 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
nametyperequireddescription
displayTypeStringN적용할 CSS display 속성의 값.
block : display: block;을 적용. (기본 값) inline : display: inline;을 적용. none : display: none;을 적용. "" : show 수행 이전의 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
nametyperequireddescription
classNameStringY추가/삭제할 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
nametyperequireddescription
typeStringY발생시킬 이벤트
arrayArrayN이벤트 핸들러에 전달할 파라미터 배열
Sample
// (예제 1) // input1 컴포넌트에 onclick 이벤트를 발생시킴. input1.trigger("onclick"); // (예제 2) // input1에 onviewchange 이벤트를 발생시키고 핸들러 함수에 (1,2) 인자를 전달하여 호출. input1.trigger("onviewchange", [1,2]);
unbind( type , function )
컴포넌트에서 이벤트를 제거. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
typeStringN제거할 이벤트. (생략할 경우 해당 컴포넌트의 모든 이벤트를 제거.)
functionFunctionN제거할 이벤트의 핸들러 함수. (생략할 경우 해당 위에 지정한 이벤트에 등록된 모든 핸들러 함수를 제거.)
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
nametyperequireddescription
flagBooleanY설정할 CSS visibility 속성 값
true : visibility: visible; false : visibility: hidden;