WebSquare.uiplugin.checkbox

HTML에서 input Tag의 type="checkbox"와 같은 기능을 제공하는 컴포넌트로 나열된 항목을 다중으로 선택 할 수 있다.
주의 사항으로는 본 컴포넌트가 브라우저에 표현 될 때는 input Tag가 아닌 최상위에 div Tag로 감싸고 하위에 복합 Tag를 이용하여 표현하고 있음으로 input Tag로 표현하고자 할 때는 별도의 설정을 통해 변경해야 한다.

Type

uiplugin

Property Summary

appearance: xforms select1의 appearance속성
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의 한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
cols: 항목을 나열 할 열의 수로 2로 정의 할 경우 2열씩 자동개행되어 표현된다
disabled: [default:false, true] HTML의 disabled속성과 동일한 기능을 제공하며 컴포넌트를 비활성화 시킨다
displaymessage: [default:false, true] validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 표시 할지의 여부.
escape: <>&"를 HTML Escape 문자로 변환하여 화면에 표시한다
falseValue: 어떤 항목도 선택되지 않았을 때의 value.
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다
ignoreTabIndex: tab이동시 포커스를 무시한다
invalidMessage: validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 본 속성의 값으로 표현되는 기능으로 displaymessage속성이 true로 되어있어야 한다.
invalidMessageFunc: validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 별도로 정의 한 Function에서 동적으로 표현 할 수 있는 기능으로 정의 된 function의 이름을 명시한다.
itemTagname: renderType이 "checkboxgroup"일 때, 아이템의 tagname
mandatory: [default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부
nextTabID: tab으로 이동시 이동할 컴포넌트 ID
ref: DataCollection의 value 경로로 컴포넌트와 DataCollection의 value를 binding을 시킬 때 사용하며 "data:"라는 prefix는 필수로 붙여주어야 한다.
renderType: [default:table, native, checkboxgroup] 본 컴포넌트가 브라우저에 표현 될 레이아웃 구조로 세부 내용은 아래와 같다.
rows: 항목을 나열 할 행의 수로 2로 정의 할 경우 전체 항목이 2행으로 나뉘어 표현된다
selectedindex: 초기 선택 될 항목의 index로 항목이 하드코딩되어있거나 DataList에 data가 미리 정의 되어있을 경우에만 동작 된다.
separator: 선택 된 항목들이 여러 개인 경우 구분자로 사용할 문자
tabIndex: Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다
tagname: renderType이 "checkboxgroup"일 때, 렌더링 될 객체의 tagname
title: HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다
toolTip: 웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다
tooltipClass: tooltipDisplay속성의 값이 true일 때, tooltip에 적용 할 class명
tooltipDisplay: [default:false, true] 선택된 값에 대한 tooltip 표현여부
tooltipItemLabel: tooltipDisplay = "true" tooltipItemLabel="tooltip"설정한 경우, checkbox item별로 마우스 오버시에
tooltipTime: tooltipDisplay속성의 값이 true일 때, tooltip이 보이는데 걸리는 초(second)
useCheckboxTitle: [default:true, false] 웹 접근성을 위해 checkbox의 항목(버튼)에 title의 표시 유무
useLocale: [default:false, true] Client 다국어를 이용하여 항목의 label에 표현되는 값을 다국어 key를 이용하여 표현 할 지에 대한 설정이다
userData1: 사용자 정의 데이터 속성
userData2: 사용자 정의 데이터 속성
userData3: 사용자 정의 데이터 속성
validator: 유효성 체크 함수명

Event Summary

onchange: 사용자가 항목을 선택/변경하거나 API를 이용하여 value를 설정할 경우 발생하며 사용자가 항목을 선택했을때만 제어하고자 할 경우 onviewchange 이벤트를 사용한다.
oncheckboxclick: checkbox가 click 된 경우 발생하는 이벤트로 label click시에는 발생하지 않는다.
onlabelclick: label이 클릭된 경우 발생하는 이벤트로 checkbox click시에는 발생하지 않는다.
onviewchange: 키보드나 마우스 조작을 통해 항목이 선택/변경 된 경우에만 발생하는 이벤트. API를 통해 값이 변경된 경우에는 이벤트가 발생하지 않는다.(native onchange 이벤트와 유사.)

Method Summary

addClass( className ): 컴포넌트에 CSS class를 추가
addItem( value , label , index ): 항목을 추가하는 기능으로 index를 주지 않으면 하위로 추가된다
bind( eventType , function ): 컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당
changeClass( oldClassName , newClassName ): 웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
checkAll( checkFlag ): 모든 항목을 선택하거나 해제 시킨다
click( index ): index에 해당하는 항목을 click 한 것과 같은 효과를 내어 해당 항목이 선택/해제된다.
deleteItem( index ): index에 해당하는 항목을 삭제한다
focus( ): 컴포넌트에 focus를 준다
getDataListInfo( ): checkbox에 바인딩되어 있는 dataList를 반환합니다
getDisabled( ): 현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환
getGenerator( ): 컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환
getID( ): 웹스퀘어 컴포넌트의 ID를 반환
getInitStyle( CSS ): 웹스퀘어 컴포넌트의 초기 스타일을 반환
getItemCount( ): 항목 수를 반환한다
getItemDisabled( index ): index에 해당하는 항목의 활성화(disabled) 여부를 반환한다
getNextTabID( ): nextTabID 옵션값을 반환한다
getOpacity( ): 웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
getOriginalID( ): 웹스퀘어 컴포넌트의 originalID를 반환. (웹스퀘어 컴포넌트 공통.)
getPluginName( ): 웹스퀘어 컴포넌트의 이름(pluginName)을 반환
getPosition( positionName ): 웹스퀘어 컴포넌트의 위치(left, top)를 반환
getScope( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getScopeWindow( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getSelectedIndex( separator ): 선택 된 항목들의 index를 반환하는 기능으로 항목이 여러 개인 경우 separator를 구분자로 하여 반환한다.
getSize( sizeName ): 웹스퀘어 컴포넌트의 크기(width, height)를 설정
getStyle( propertyName ): 웹스퀘어 컴포넌트의 CSS 속성 값을 반환
getStyleValue( style ): [deprecated]
getText( separator ): 선택 된 항목들의 label을 반환하는 기능으로 항목이 여러 개인 경우 separator를 구분자로 하여 반환한다.
getTitle( ): 컴포넌트의 title 속성 값을 반환
getUdcHome( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 파일명을 포함해서 반환. (웹스퀘어 컴포넌트 공통.)
getUdcRoot( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 반환. (웹스퀘어 컴포넌트 공통.)
getUserData( key ): setUserData로 웹스퀘어 컴포넌트에 설정한 key의 value 혹은 사용자가 직접 페이지 소스(XML)에 속성으로 정의한 value를 반환
getValue( separator ): 선택 된 항목들의 value를 반환하는 기능으로 항목이 여러 개인 경우 separator를 구분자로 하여 반환한다.
hasClass( className ): 웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인
hide( ): 웹스퀘어 컴포넌트를 화면에서 숨김. (웹스퀘어 컴포넌트 공통.)
removeAll( ): 모든 항목을 삭제한다
removeClass( className ): 웹스퀘어 컴포넌트에서 class를 삭제.(웹스퀘어 컴포넌트 공통.)
reset( ): 모든 항목의 체크를 해제한다
setDisabled( disabled ): 컴포넌트의 disabled 속성을 설정한다
setEventPause( evList , flag ): 지정한 이벤트를 중단함
setInitStyle( property ): 웹스퀘어 컴포넌트의 초기 스타일을 복구
setItemDisabled( index , flag ): index에 해당하는 항목을 비활성화시키거나 활성화 시킨다
setNextTabID( componentID , componentScope ): nextTabID 옵션값을 설정합니다
setNodeSet( nodeset , label , value ): 항목의 itemset 설정을 변경하는 기능으로 DataList와 연동 할 경우 nodeset 파라메터에 "data:" prefix를 꼭 붙여야한다
setOpacity( value ): 웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
setPosition( left , top , mode ): 웹스퀘어 컴포넌트의 위치(left, top)를 설정
setRef( ref ): ref 속성을 설정하는 기능으로 DataCollection과 연동시 "data:"라는 prefix를 꼭 붙여야한다.
setSelectedIndex( index ): index에 해당하는 항목을 check/uncheck(toggle)한다
setSize( width , height ): 웹스퀘어 컴포넌트의 크기(width, height)를 설정
setStyle( propertyName , value ): 웹스퀘어 컴포넌트의 CSS 속성을 설정
setUserData( key , value ): 웹스퀘어 컴포넌트에 임의의 데이터를 설정
setValue( value ): 파라메터로 넘어온 value가 항목에 있는 경우 해당 항목이 선택되며 해당값으로 value가 할당된다.
show( displayType ): 웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
toggleClass( className ): 웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
trigger( type , array ): 컴포넌트에서 특정 이벤트를 발생시킴
unbind( type , function ): 컴포넌트에서 이벤트를 제거
unbindRef( ): ref 바인딩을 해제합니다
validate( ): 컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
validateObject( ): 컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
visible( flag ): [deprecated]

Property Detail

appearance: xforms select1의 appearance속성
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의 한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
기본적으로 엔진 내부에서 각 컴포넌트 마다의 class를 적용하고 있으며 해당 class를 이용하여 컴포넌트의 css를 공통으로 적용 할 수 있다.
cols: 항목을 나열 할 열의 수로 2로 정의 할 경우 2열씩 자동개행되어 표현된다.
disabled: [default:false, true] HTML의 disabled속성과 동일한 기능을 제공하며 컴포넌트를 비활성화 시킨다.
displaymessage: [default:false, true] validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 표시 할지의 여부.
기본적으로 엔진에서 정의 된 메세지가 표현되며 별도의 메세지를 정의하고자 할 때는 invalidMessageFunc속성을 이용한다.
escape: <>&"를 HTML Escape 문자로 변환하여 화면에 표시한다.
falseValue: 어떤 항목도 선택되지 않았을 때의 value.
기본적으로 항목이 선택되지 않았을 경우의 value는 ""(empty string)이지만 본 속성에 값을 설정하면 해당 값으로 value를 반환한다.
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다.
ignoreTabIndex: tab이동시 포커스를 무시한다.
invalidMessage: validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 본 속성의 값으로 표현되는 기능으로 displaymessage속성이 true로 되어있어야 한다.
invalidMessageFunc과 동시 적용이 불가하다.
invalidMessageFunc: validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 별도로 정의 한 Function에서 동적으로 표현 할 수 있는 기능으로 정의 된 function의 이름을 명시한다.
displaymessage속성이 true로 되어있어야 하며 invalidMessage와 동시 적용이 불가하다.
사용자 Function(아래 예시 참조)에서는 this.getType()을 통해 검증 실패 type(아래 type 참조)과 this.getValue()를 value값을 가져와 메세지를 동적으로 생성하여 return 한다.
type)mandatory, allowChar, ignoreChar, minLength, maxLength, minByteLength, maxByteLength
예시)function fn_msg(){ var tmpType = this.getType(); var tmpValue = this.getValue(); if(tmpType == "mandatory"){ return "필수 검증 항목입니다."; } }
itemTagname: renderType이 "checkboxgroup"일 때, 아이템의 tagname
mandatory: [default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부.
nextTabID: tab으로 이동시 이동할 컴포넌트 ID
ref: DataCollection의 value 경로로 컴포넌트와 DataCollection의 value를 binding을 시킬 때 사용하며 "data:"라는 prefix는 필수로 붙여주어야 한다.
작성 방법은 data:[DataCollection ID].[Key id 또는 Column id]와 같다. 예시)data:dataMap1.dept
DataList와 연동 된 경우는 GridView에서 선택 된 Row의 값이 binding 된다.
Instance Data와 연동 할 경우 연동 할 XML 데이터의 XPath를 명시한다. 예시)res/userInfo/dept/@value
renderType: [default:table, native, checkboxgroup] 본 컴포넌트가 브라우저에 표현 될 레이아웃 구조로 세부 내용은 아래와 같다.
table : input Tag를 사용하지 않고 div Tag하위로 table Tag를 이용하여 항목을 표현한다.
native : <input type="checkbox">만 생성하는 형태이다. textbox 컴포넌트를 이용하여 label Tag를 직접 생성해야하며 title 속성을 사용하지 않는 경우에는 필수로 생성해야한다.( 웹접근성 지침 관련 )
checkboxgroup : 레이아웃을 위한 Tag를 개발자가 직접 결정하는 형태로 기본적으로 div Tag를 이용하여 구성되며 tagname과 itemTagname 속성을 이용하여 최상위 Tag와 항목별 Tag를 설정 할 수 있다. ( 세부 설정은 웹접근성 가이드 문서 참조 )
rows: 항목을 나열 할 행의 수로 2로 정의 할 경우 전체 항목이 2행으로 나뉘어 표현된다.
selectedindex: 초기 선택 될 항목의 index로 항목이 하드코딩되어있거나 DataList에 data가 미리 정의 되어있을 경우에만 동작 된다.
주의 사항으로는 본 속성은 초기 컴포넌트가 브라우저에 표현되는 시점에 할당 된 Data를 기준으로 selected를 해주는 기능으로 화면 로딩 이후 API를 이용하여 항목을 생성하거나 통신 후 DataList에 data가 할당 되는 경우는 본 속성이 적용되지 않는다.
separator: 선택 된 항목들이 여러 개인 경우 구분자로 사용할 문자. separator를 설정하지 않은 경우 공백(space)이 구분자로 사용된다.
tabIndex: Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다.
tagname: renderType이 "checkboxgroup"일 때, 렌더링 될 객체의 tagname
title: HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다.
toolTip: 웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다. 마우스 over시 표현된다.
tooltipClass: tooltipDisplay속성의 값이 true일 때, tooltip에 적용 할 class명.
tooltipDisplay: [default:false, true] 선택된 값에 대한 tooltip 표현여부.
tooltipItemLabel: tooltipDisplay = "true" tooltipItemLabel="tooltip"설정한 경우, checkbox item별로 마우스 오버시에
tooltipItemLabel에 설정한 "tooltip" 값이 tooltip에 나타난다. tooltipItemLabel = "" 인 경우, 마우스 오버시에
checkbox item의 label값이 tooltip에 나타난다.
tooltipTime: tooltipDisplay속성의 값이 true일 때, tooltip이 보이는데 걸리는 초(second)
useCheckboxTitle: [default:true, false] 웹 접근성을 위해 checkbox의 항목(버튼)에 title의 표시 유무.
useLocale: [default:false, true] Client 다국어를 이용하여 항목의 label에 표현되는 값을 다국어 key를 이용하여 표현 할 지에 대한 설정이다.( 세부 내용은 Client 다국어 가이드 참고 )
userData1: 사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2: 사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3: 사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.
validator: 유효성 체크 함수명

Event Detail

onchange

사용자가 항목을 선택/변경하거나 API를 이용하여 value를 설정할 경우 발생하며 사용자가 항목을 선택했을때만 제어하고자 할 경우 onviewchange 이벤트를 사용한다.
이벤트 핸들러(function)에서는 this를 이용하여 컴포넌트에 접근이 가능하다. ex)this.getValue();

oncheckboxclick

checkbox가 click 된 경우 발생하는 이벤트로 label click시에는 발생하지 않는다.
이벤트 핸들러(function)에서는 this를 이용하여 컴포넌트에 접근이 가능하다. ex)this.getValue();

Parameter
name	type	description
index	String	일어난 아이템(항목)의 index
checked	boolean	일어난 아이템(항목)의 checked 상태
value	String	일어난 아이템(항목)의 value

Sample

onlabelclick

label이 클릭된 경우 발생하는 이벤트로 checkbox click시에는 발생하지 않는다.
이벤트 핸들러(function)에서는 this를 이용하여 컴포넌트에 접근이 가능하다. ex)this.getValue();

Parameter
name	type	description
index	String	일어난 아이템(항목)의 index
checked	boolean	일어난 아이템(항목)의 checked 상태
value	String	일어난 아이템(항목)의 value

Sample

onviewchange

키보드나 마우스 조작을 통해 항목이 선택/변경 된 경우에만 발생하는 이벤트. API를 통해 값이 변경된 경우에는 이벤트가 발생하지 않는다.(native onchange 이벤트와 유사.)
이벤트 핸들러(function)에서는 this를 이용하여 컴포넌트에 접근이 가능하다. ex)this.getValue();

Parameter
name	type	description
info	JSON	index, checked, value를 포함한 오브젝트를 반환합니다.

Sample

Method Detail

addClass( className )

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

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

Sample

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

addItem( value , label , index )

항목을 추가하는 기능으로 index를 주지 않으면 하위로 추가된다.

Parameter
name	type	required	description
value	String	Y	항목의 value
label	String	Y	항목의 label
index	Number	N	항목의 추가될 index

Return
type	description
Number	추가 된 항목의 index

Sample

//아래와 같이 항목을 하드코딩하여 정의 한 경우 <xf:select id="checkbox1" appearance="full" style="position: relative;" selectedindex="-1" > <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[체리]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:select> var returnValue = checkbox1.addItem( '3', 'ornage' ); //return 예시 ) 2

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 파일에 <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");

checkAll( checkFlag )

모든 항목을 선택하거나 해제 시킨다.

Parameter
name	type	required	description
checkFlag	Bollean	Y	true일 경우 전체 선택, false일 경우 전체 해제.

Sample

//전체 선택 checkbox1.checkAll(true); //전체 해제 checkbox1.checkAll(false);

click( index )

index에 해당하는 항목을 click 한 것과 같은 효과를 내어 해당 항목이 선택/해제된다.
또한 onviewchange등의 이벤트도 발생된다.

Parameter
name	type	required	description
index	Number	Y	click 이벤트를 발생시킬 항목의 index

Sample

//첫번째 항목에 click 이벤트를 발생시킨다. checkbox1.click(0); //항목이 선택/해제 된다.

deleteItem( index )

index에 해당하는 항목을 삭제한다.

Parameter
name	type	required	description
index	Number	N	삭제할 항목의 index

Return
type	description
JSON	삭제된 항목의 정보가 담긴 JSON

Sample

focus( )

컴포넌트에 focus를 준다.

getDataListInfo( )

checkbox에 바인딩되어 있는 dataList를 반환합니다.

Return
type	description
Object:Y	nodeset, label, value id를 객체로 반환

Sample

checkbox1.getDataListInfo();

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	속성 (지정하지 않으면 모든 정보 출력)

getItemCount( )

항목 수를 반환한다.

Return
type	description
Number	항목 수

Sample

//총 2개의 항목이 있는 경우 var returnValue = checkbox1.getItemCount(); //return 예시 ) 2

getItemDisabled( index )

index에 해당하는 항목의 활성화(disabled) 여부를 반환한다.

Parameter
name	type	required	description
index	Number	Y	항목의 index

Return
type	description
Boolean	해당 항목의 비활성화 여부

Sample

//첫번째 항목이 활성화 되어있고 첫번째 항목의 활성여부를 반환 받고자 할 때. var returnValue = checkbox1.getItemDisabled(0); //return 예시 ) false

getNextTabID( )

nextTabID 옵션값을 반환한다.

Sample

var nextTabID = checkbox1.getNextTabID();

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

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

getSelectedIndex( separator )

선택 된 항목들의 index를 반환하는 기능으로 항목이 여러 개인 경우 separator를 구분자로 하여 반환한다.
separator를 설정하지 않은 경우 공백(space)이 구분자로 사용된다.

Parameter
name	type	required	description
separator	String	N	항목간 구분자

Return
type	description
String	선택 된 항목의 index가 담긴 문자열.

Sample

//아래와 같이 컴포넌트가 정의 되고 사과와 오렌지가 선택 된 경우 <xf:select id="checkbox1" appearance="full" style="position: relative;" selectedindex="-1" > <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[체리]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[3]]></xf:value> </xf:item> </xf:choices> </xf:select> var returnValue1 = checkbox1.getSelectedIndex(); //return 예시 ) "0 2" //,로 구분자 적용 var returnValue2 = checkbox1.getSelectedIndex(","); //return 예시 ) "0,2"

getSize( sizeName )

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

Parameter
name	type	required	description
sizeName	String	Y	[height, innerHeight, outerHeight, outerMarginHeight, width, innerWidth, outerWidth, outerMarginWidth]크기 값의 종류. 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로 반환됨.)

getText( separator )

선택 된 항목들의 label을 반환하는 기능으로 항목이 여러 개인 경우 separator를 구분자로 하여 반환한다.
separator를 설정하지 않은 경우 공백(space)이 구분자로 사용된다.

Parameter
name	type	required	description
separator	String	N	항목 구분자

Return
type	description
String	선택 된 항목들의 label이 담긴 문자열

Sample

//아래와 같이 컴포넌트가 정의 되고 사과와 오렌지가 선택 된 경우 <xf:select id="checkbox1" appearance="full" style="position: relative;" selectedindex="-1" > <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[체리]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[3]]></xf:value> </xf:item> </xf:choices> </xf:select> var returnValue = checkbox1.getText(); //return 예시 ) "사과 오렌지" //구분자 , 적용 var returnValue = checkbox1.getText(","); //return 예시 ) "사과,오렌지"

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를 사용해서 반환.
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"

getValue( separator )

선택 된 항목들의 value를 반환하는 기능으로 항목이 여러 개인 경우 separator를 구분자로 하여 반환한다.
separator를 설정하지 않은 경우 공백(space)이 구분자로 사용된다.

Parameter
name	type	required	description
separator	String	N	항목 구분자

Return
type	description
String	컴포넌트의 선택된 항목들들의 value가 담긴 문자열

Sample

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

removeAll( )

모든 항목을 삭제한다.

Sample

checkbox1.removeAll();

removeClass( className )

웹스퀘어 컴포넌트에서 class를 삭제.(웹스퀘어 컴포넌트 공통.)
기본적으로 addClass를 통해 추가된 class만 삭제 가능.
컴포넌트의 속성으로 직접 정의된 class를 삭제하기 위해서는 아래의 작업이 필요.
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");

reset( )

모든 항목의 체크를 해제한다.

Sample

//전체 체크 해제. checkbox1.reset();

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 )

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

Parameter
name	type	required	description
evList	String	N	중단할 이벤트 목록. (null을 지정할 경우 해당 컴포넌트의 모든 사용자 이벤트가 중단되거나 중단 해제됨.)
flag	Boolean	Y	이벤트 중단 여부. (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
name	type	required	description
property	String	N	CSS 속성 (지정하지 않으면 모든 속성의 초기 값으로 복구.)

Sample

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

setItemDisabled( index , flag )

index에 해당하는 항목을 비활성화시키거나 활성화 시킨다.

Parameter
name	type	required	description
index	Number	Y	항목의 index
flag	Boolean	Y	비활성화 여부

Sample

//첫번째 항목을 비활성화한다. checkbox1.setItemDisabled(0, true); //해당 항목을 선택하거나 선택을 해제할 수 없다.

setNextTabID( componentID , componentScope )

nextTabID 옵션값을 설정합니다. 두번째 인자로 nextTabID에 해당하는 컴포넌트가 위치한 frame의 ID를 넘겨주면 scope를 설정할 수 있습니다.

Parameter
name	type	required	description
componentID	String	Y	nextTabID로 설정할 컴포넌트의 id
componentScope	String	N	nextTabID로 설정할 컴포넌트의 scope

Sample

checkbox1.setNextTabID("input2", "wframe1");

setNodeSet( nodeset , label , value )

항목의 itemset 설정을 변경하는 기능으로 DataList와 연동 할 경우 nodeset 파라메터에 "data:" prefix를 꼭 붙여야한다.

Parameter
name	type	required	description
nodeset	String	Y	DataList의 ID로 "data:"이라는 prefix를 붙여야한다. ( 또는 InstanceData의 XPath )
label	String	N	label에 설정 될 column의 id로 값을 할당하지 않으면 기존에 설정된 값이 그대로 적용된다. ( 또는 label에 설정 할 nodeset 하위의 XPath )
value	String	N	value에 설정 될 column의 id로 값을 할당하지 않으면 기존에 설정된 값이 그대로 적용된다. ( 또는 value에 설정 할 nodeset 하위의 XPath )

Sample

//아래와 같은 DataList가 정의 된 경우. <w2:dataList id="dataList1"> <w2:columnInfo> <w2:column id="lbl" dataType="text"></w2:column> <w2:column id="code" dataType="text"></w2:column> </w2:columnInfo> <w2:data use="true"> <w2:row> <lbl><![CDATA[zero]]></lbl> <code><![CDATA[0]]></code> </w2:row> <w2:row> <lbl><![CDATA[one]]></lbl> <code><![CDATA[1]]></code> </w2:row> </w2:data> </w2:dataList> //checkbox1의 itemset설정을 DataCollection의 dataList1로 변경하고 label은 lbl column으로 value는 code column으로 설정 할 경우 checkbox1.setNodeSet('data:dataList1','lbl','code'); //dataList1과 컬럼이 동일하고 실 data만 다른 dataList2로 변경 할 경우 checkbox1.setNodeSet('data:dataList2'); //기존에 할당 된 label의 lbl과 value의 code는 그대로 유지되고 dataList만 변경된다.

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

setRef( ref )

ref 속성을 설정하는 기능으로 DataCollection과 연동시 "data:"라는 prefix를 꼭 붙여야한다.
명시하지 않는 경우 InstanceData의 XPath로 인식한다.

Parameter
name	type	required	description
ref	String	Y	적용 할 ref의 경로

Sample

//dataMap1의 hobby key와 checkbox1 컴포넌트의 value를 binding 하는 경우 checkbox1.setRef("data:dataMap1.hobby"); //InstanceData의 res/userData/hobby 과 연동 할 경우. checkbox1.setRef("res/userData/hobby");

setSelectedIndex( index )

index에 해당하는 항목을 check/uncheck(toggle)한다.

Parameter
name	type	required	description
index	Number	Y	항목의 index

Sample

//첫번째 항목이 체크되지 않았을 경우 체크된다.( 체크 된 경우 체크해제 ) checkbox1.setSelectedIndex(0);

setSize( width , height )

웹스퀘어 컴포넌트의 크기(width, height)를 설정. (웹스퀘어 컴포넌트 공통.)

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

Sample

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

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.

setValue( value )

파라메터로 넘어온 value가 항목에 있는 경우 해당 항목이 선택되며 해당값으로 value가 할당된다.
다건을 한번에 설정 할 경우 공백(space)를 이용하여 설정하며 value에 해당하는 항목이 없는 경우 아무 동작이 일어나지 않는다.

Parameter
name	type	required	description
value	String	Y	선택하려는 항목의 value 문자열

Sample

//아래와 같이 컴포넌트가 정의 되고 사과와 오렌지가 선택 된 경우 <xf:select id="checkbox1" appearance="full" style="position: relative;" selectedindex="-1" > <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[체리]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[3]]></xf:value> </xf:item> </xf:choices> </xf:select> checkbox1.setValue("2"); //체리 항목이 check된다. checkbox1.setValue("0 2"); //사과와 오렌지 항목이 check된다.

show( displayType )

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

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

Sample

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

toggleClass( className )

웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
웹스퀘어 컴포넌트가 파라미터로 주어진 class를 포함한 경우, 해당 class를 제거.
웹스퀘어 컴포넌트에 파라미터로 주어진 class가 없는 경우, 해당 class를 추가.
기본적으로 addClass를 통해 추가된 class만 삭제 가능.
웹스퀘어 컴포넌트의 속성으로 직접 정의된 class를 삭제하기 위해서는 아래의 작업이 필요함.
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);

unbindRef( )

ref 바인딩을 해제합니다

validate( )

컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
유효성 관련 속성 : mandatory

Return
type	description
Boolean	유효성 검사 결과 값

Sample

//모든 항목이 선택 해제되어 있는 경우 var returnValue = checkbox1.validate(); //return 예시 ) false //만약 displaymessage속성을 true로 설정하면 엔진에서 alert으로 "필수 입력 항목입니다"를 표현한다.

validateObject( )

컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
유효성 관련 속성 : mandatory, minLength, maxLength, minByteLength, maxByteLength

Return
type	description
Object	object 유효성 검사 결과 객체

Sample

//아래와 같이 checkbox 컴포넌트에 mandatory 속성을 정의했을 경우 <xf:select appearance="full" id="checkbox1" style="position: absolute;width:256px;height:79px;left:68px;top:254px;" mandatory="true"> <xf:choices> <xf:itemset nodeset="data:dataList1"> <xf:label ref="label"></xf:label> <xf:value ref="value"></xf:value> </xf:itemset> </xf:choices> </xf:select> var returnObj = checkbox1.validateObject(); //return 예시 - checkbox에 값이 없을 경우 ) returnObj 객체 반환 returnObj.callerId = "checkbox1" returnObj.type = "mandatory" returnObj.value = "" //return 예시 - checkbox에 값이 있을 경우) 비어있는 객체가 반환 input 컴포넌트의 displaymessage="true" 설정을 함께 사용하면 유효성 검사에서 false가 된 경우 엔진에서 설정 된 메세지가 alert으로 뜬다. //alert 메세지 예시 ) 필수 입력 항목입니다

visible( flag )

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

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