PropertyEventMethod찾아보기
WebSquare.uiplugin.generator - 5.0_2.3801B.20190910.134002

특정 영역이 반복되어 표현되거나 동일한 영역을 동적으로 추가/삭제해야 할 때 사용하는 컴포넌트이다.
본 컴포넌트의 안쪽(하위)에 정의된 영역이 반복이 되며 script를 통해 제어한다.
주사용 용도로는 일정 관리용 캘린더, 메뉴, 설문지 등이 있다.
컴포넌트의 하위에 사용할 수 없는 컴포넌트 목록 : Chart, GridView, Menu, Switch, TabControl, Treeview, WindowContainer, Grid, TabContainer
대표적인 주의 사항은 아래와 같다.
기본적으로 웹스퀘어 컴포넌트는 초기에 설정한 ID로 접근이 가능하지만 본 컴포넌트의 하위에 정의된 자식 컴포넌트들은 초기에 설정한 ID로 접근이 불가능하다.
동적으로 자식 컴포넌트가 추가됨에 엔진에서 ID가 중복되지 않도록 초기에 설정한 ID를 기반으로 재설정하기 때문이다.
따라서 개발자는 자식 컴포넌트에 접근할 때 본 컴포넌트에서 제공하는 API를 통해 접근해야한다.
반복부에 속해 있는 컴포넌트들은 모두 나의 반복부 index와 같은 반복부에 속해있는 다른 컴포넌트를 반환하는 API를 제공한다.
주의 사항은 위에 설명한 대로 this로 접근하여 API를 호출한다.
- 반복부의 index를 반환하는 API 예시 ) var tmpIdx = this.getGeneratedIndex();
- 동일 반복부에 있는 다른 컴포넌트에 접근 하는 API 예시 ) var tmpObj = this.getGeneratedComponent("input1"); //동일 반복부의 input1객체 반환
본 컴포넌트의 최상위는 HTML div Tag로 표현되며 tagname속성을 통해 다른 HTML Tag로 변경할 수 있다.

Type

uiplugin

Property Summary

class
HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
id
컴포넌트 ID.
tagname
기본적으로 div Tag로 표현되며 div가 아닌 다른 Tag로 표현하고자 할 때 사용한다.
userData1
사용자 정의 데이터 속성
userData2
사용자 정의 데이터 속성
userData3
사용자 정의 데이터 속성

Event Summary

Method Summary

addClass( className )
컴포넌트에 CSS class를 추가
bind( eventType , function )
컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당
changeClass( oldClassName , newClassName )
웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
focus( )
웹스퀘어 컴포넌트에 포커스를 줌
getChild( index , id )
컴포넌트의 ID와 해당 컴포넌트가 속해 있는 반복부의 index를 기반으로 컴포넌트 객체를 반환한다
getDisabled( )
현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환
getGenerator( )
컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환
getID( )
웹스퀘어 컴포넌트의 ID를 반환
getInitStyle( CSS )
웹스퀘어 컴포넌트의 초기 스타일을 반환
getLength( )
반복부의 개수를 반환한다
getOpacity( )
웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
getOriginalID( )
웹스퀘어 컴포넌트의 originalID를 반환. (웹스퀘어 컴포넌트 공통.)
getPluginName( )
웹스퀘어 컴포넌트의 이름(pluginName)을 반환
getPosition( positionName )
웹스퀘어 컴포넌트의 위치(left, top)를 반환
getReadOnly( )
현재 웹스퀘어 컴포넌트에 설정된 readOnly 속성 값을 반환
getScope( )
scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getScopeWindow( )
scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getSize( sizeName )
웹스퀘어 컴포넌트의 크기(width, height)를 설정
getStyle( propertyName )
웹스퀘어 컴포넌트의 CSS 속성 값을 반환
getStyleValue( style )
[deprecated]
getTitle( )
컴포넌트의 title 속성 값을 반환
getUdcHome( )
UDC 객체가 자신을 정의한 UDC 파일 경로를 파일명을 포함해서 반환. (웹스퀘어 컴포넌트 공통.)
getUdcRoot( )
UDC 객체가 자신을 정의한 UDC 파일 경로를 반환. (웹스퀘어 컴포넌트 공통.)
getUserData( key )
setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
hasClass( className )
웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인
hide( )
웹스퀘어 컴포넌트를 화면에서 숨김. (웹스퀘어 컴포넌트 공통.)
insertChild( index )
index에 해당하는 위치에 반복부를 삽입한다
removeAll( )
모든 반복부를 삭제한다
removeChild( index )
index에 해당하는 반복부를 삭제하며 index가 없을 경우 마지막 반복부를 삭제힌다
removeClass( className )
웹스퀘어 컴포넌트에서 class를 삭제.(웹스퀘어 컴포넌트 공통.)
setDisabled( disabled )
웹스퀘어 컴포넌트의 disabled 속성을 설정
setEventPause( evList , flag )
지정한 이벤트를 중단함
setInitStyle( property )
웹스퀘어 컴포넌트의 초기 스타일을 복구
setOpacity( value )
웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
setPosition( left , top , mode )
웹스퀘어 컴포넌트의 위치(left, top)를 설정
setReadOnly( readOnly )
웹스퀘어 컴포넌트의 readOnly 속성을 설정
setSize( width , height )
웹스퀘어 컴포넌트의 크기(width, height)를 설정
setStyle( propertyName , value )
컴포넌트의 propertyName에 해당하는 style의 값을 설정합니다
setUserData( key , value )
컴포넌트에 사용자 데이터를 설정한다
show( displayType )
웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
toggleClass( className )
웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
trigger( type , array )
컴포넌트에서 특정 이벤트를 발생시킴
unbind( type , function )
컴포넌트에서 이벤트를 제거
visible( flag )
[deprecated]

Property Detail

class
HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
Engine 내부에서 각 컴포넌트 별로 지정된 class를 적용하나, class 속성을 이용하여 컴포넌트의 CSS를 제어 가능.
id
컴포넌트 ID.
컴포넌트 ID는 전역 객체로 할당됨. 각 컴포넌트 ID를 통해 Script에서 해당 컴포넌트에 접근 가능.
tagname
기본적으로 div Tag로 표현되며 div가 아닌 다른 Tag로 표현하고자 할 때 사용한다.
일반적으로 자식 Tag(Element)를 가질 수 있는 Tag를 정의한다.
userData1
사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있음. // 속성 값 얻어오기 예시 getUserData("userData1");
userData2
사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있음. // 속성 값 얻어오기 예시 getUserData("userData2");
userData3
사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있음. // 속성 값 얻어오기 예시 getUserData("userData3");

Event Detail

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( )
웹스퀘어 컴포넌트에 포커스를 줌. (웹스퀘어 컴포넌트 공통.)
getChild( index , id )
컴포넌트의 ID와 해당 컴포넌트가 속해 있는 반복부의 index를 기반으로 컴포넌트 객체를 반환한다.
Parameter
nametyperequireddescription
indexNumberY반환 받을 컴포넌트가 속해 있는 반복부의 index.(보이는 순서대로)
idStringY반환 받을 컴포넌트의 초기 설정 ID.
Return
typedescription
Object반복부에서 찾아진 웹스퀘어 컴포넌트
Sample
//아래와 같이 generator를 정의. (input과 trigger가 있는 group이 반복부에 속한다) <w2:generator id="generator1" style="position: relative;"> <xf:group id="group1" style="position: relative;padding:10px;" class=""> <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin-right:10px;"> </xf:input> <xf:trigger type="button" id="trigger1" style="position: relative;width: 80px;height: 23px;"> <xf:label><![CDATA[getValue]]></xf:label> </xf:trigger> </xf:group> </w2:generator> //4개의 배열 데이터를 기반으로 반복부를 생성하고 input컴포넌트의 value를 변경하고자 할 때의 script 작성 예시 var tmpArr = ["손예진","이광수","이선희","류승룡"]; //배열 데이터 //상단에 정의 된 배열의 개수만큼 반복부 추가 for(var i=0;i<tmpArr.length;i++){ //반복부 추가 generator1.insertChild(i); //추가 된 반복부에서 input1 컴포넌트 객체 꺼내오기 var tmpChild = generator1.getChild( i , "input1" ); //input의 value를 배열데이터의 i번째 값으로 설정 tmpChild.setValue(tmpArr[i]); }
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속성 (지정하지 않으면 모든 정보 출력)
getLength( )
반복부의 개수를 반환한다.
Return
typedescription
Number반복부의 개수
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
getSize( sizeName )
웹스퀘어 컴포넌트의 크기(width, height)를 설정. (웹스퀘어 컴포넌트 공통.) %로 설정된 경우, 픽셀로 변환된 값을 반환.
Parameter
nametyperequireddescription
sizeNameStringY[height, innerHeight, outerHeight, outerMarginHeight, width, innerWidth, outerWidth, outerMarginWidth]크기 값의 종류. 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(); //return 예시 ) "이름 입력"
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 API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다.
Parameter
nametyperequireddescription
keyStringY임의 데이터의 키
Return
typedescription
Stringkey에 해당하는 데이터
Sample
//아래와 같이 generator 컴포넌트의 사용자 속성(eduTest)이 적용 된 경우. <w2:generator id="generator1" style="position: absolute ;left: 567px;top: 62px;width: 203px;height: 62px;"></w2:generator> generator1.getUserData("eduTest"); //return 예시 ) "Hello" //setUserData를 통해 set한 경우 generator1.setUserData("eduTest","WebSquare"); generator1.getUserData("WebSquare"); //return 예시 ) "Hello"
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();
insertChild( index )
index에 해당하는 위치에 반복부를 삽입한다. index가 생략 된 경우 마지막에 삽입된다.
Parameter
nametyperequireddescription
indexNumberN반복부를 삽입할 위치
Return
typedescription
Number반복부가 생성된 순서의 번호로 index와 다르다.
Sample
//아래와 같이 generator를 정의. (input과 trigger가 있는 group이 반복부에 속한다) <w2:generator id="generator1" style="position: relative;"> <xf:group id="group1" style="position: relative;padding:10px;" class=""> <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin-right:10px;"> </xf:input> <xf:trigger type="button" id="trigger1" style="position: relative;width: 80px;height: 23px;"> <xf:label><![CDATA[getValue]]></xf:label> </xf:trigger> </xf:group> </w2:generator> //0번째 index에 반복부를 삽입한다. - 1번째 위치에 삽입 generator1.insertChild(0); //마지막에 반복부를 삽입한다. - 2번째 위치에 삽입 generator1.insertChild();
removeAll( )
모든 반복부를 삭제한다.
removeChild( index )
index에 해당하는 반복부를 삭제하며 index가 없을 경우 마지막 반복부를 삭제힌다.
Parameter
nametyperequireddescription
indexNumberN삭제할 반복부의 index
Return
typedescription
Number삭제된 반복부의 생성 번호(index가 아님)가 담긴 배열.
Sample
//아래와 같이 generator를 정의. //반복부의 trigger1 컴포넌트를 click할 때 click된 반복부를 삭제하는 로직을 구현. <w2:generator id="generator1" style="position: relative;"> <xf:group id="group1" style="position: relative;padding:10px;" class=""> <xf:input id="input1" style="position: relative;width: 144px;height: 21px;margin-right:10px;"> </xf:input> <xf:trigger type="button" id="trigger1" style="position: relative;width: 80px;height: 23px;"> <xf:label><![CDATA[delete]]></xf:label> <script ev:event="onclick(e)" type="javascript"><![CDATA[ var tmpIdx = this.getGeneratedIndex(); //현재 반복된 index 꺼내오기.(동적으로 trigger가 생성 됨으로 this로 접근해야한다.) generator1.removeChild( tmpIdx ); //tmpIdx를 기반으로 반복구 삭제 ]]></script> </xf:trigger> </xf:group> </w2:generator>
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: 활성화, false: 비활성화)
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);
setSize( width , height )
웹스퀘어 컴포넌트의 크기(width, height)를 설정. (웹스퀘어 컴포넌트 공통.)
Parameter
nametyperequireddescription
widthNumberY새로 설정할 컴포넌트의 width 값 또는 null
heightNumberY새로 설정할 컴포넌트의 height 값 또는 null
Sample
// (예제) 컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);
setStyle( propertyName , value )
컴포넌트의 propertyName에 해당하는 style의 값을 설정합니다.
Parameter
nametyperequireddescription
propertyNameStringY바꾸고 싶은 style 값의 이름
valueStringY설정할 style의 값
Sample
예: 컴포넌트 스타일 width를 변경하고자 하는 경우. componentId.setStyle("width", 100); 픽셀 단위를 기본으로 하며, componentId.setStyle("width", "100px"); 과 동일하다. %단위의 표현을 하고자 하면 componentId.setStyle("width", "100%"); 로 명시하여 준다.
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, ""] 적용할 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;