Type

uiplugin

Property Summary

class

HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.

disabled

[default:false, true]HTML의 disabled속성과 동일한 기능을 제공하며 컴포넌트를 비활성화 시킨다

displaymessage

[default:false, true]validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 표시 할지의 여부.

focusRemember

[false, true] IE9이하 구형 브라우저에서 focus를 받을 경우 이전 focus를 받았을 때의 커서 위치로 커서를 이동시킬지의 여부.

id

컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다

invalidMessage

validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 본 속성의 값으로 표현되는 기능으로 displaymessage속성이 true로 되어있어야 한다.

invalidMessageFunc

validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 별도로 정의 한 Function에서 동적으로 표현 할 수 있는 기능으로 정의 된 function의 이름을 명시한다.

mandatory

[default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부

maxByteLength

입력 가능한 최대 Byte길이로 엔진에서 maxByteLength 이상의 글자를 입력하면 자동으로 잘라낸다.

maxlength

입력 가능한 최대길이로 엔진에서 maxLength 이상의 글자를 입력하면 자동으로 잘라낸다.

minByteLength

validate API를 호출 할 때 엔진에서 최소 Byte길이 체크 시에 참조한다.

minlength

validate API를 호출 할 때 엔진에서 최소길이 체크 시에 참조한다

name

html속성인 name 태그를 생성하는 속성. 예를 들어서 name = "nameTag"로 설정 시 랜더링 후 textarea컴포넌트에

placeholder

HTML5의 placeholder 기능으로 사용자에게 알려줘야 할 문구(hint)등을 명시한다.

readOnly

[default:false, true]readonly의 여부로 HTML의 readonly속성과 동일한 기능을 제공한다

ref

DataCollection의 value 경로로 컴포넌트와 DataCollection의 value를 binding을 시킬 때 사용하며 "data:"라는 prefix는 필수로 붙여주어야 한다.

tabIndex

Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다

title

HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다

toolTip

웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다

userData1

사용자 정의 데이터 속성

userData2

사용자 정의 데이터 속성

userData3

사용자 정의 데이터 속성

validator

컴포넌트의 blur 시점에 본 속성에 정의 한 Function을 실행 된다.

Event Summary

onblur

포커스를 잃었을 때 발생한다

onchange

컴포넌트의 value가 변경되었을 때 발생하는 이벤트로 focus out 시점에 발생한다.

onclick

마우스로 컴포넌트를 클릭했을 때 발생한다

ondblclick

마우스로 컴포넌트를 더블 클릭했을 때 발생한다

onfocus

포커스를 얻었을 때 발생한다

onkeydown

키보드에서 키를 눌렀을 때 발생한다

onkeypress

키보드에서 키를 눌렀을 때(누르고 있는 동안에도) 발생한다

onkeyup

키보드에서 키를 눌렀다 놓았을 때 발생한다

onmousedown

마우스를 클릭 했을 때(마우스를 누르는 순간) 발생한다

onmousemove

마우스 포인터가 이동될 때 발생한다

onmouseout

마우스가 지정된 영역이나 링크 위에서 벗어났을 때 발생한다

onmouseover

마우스가 지정된 영역이나 링크 위에 놓일 때 발생한다

onmouseup

마우스 버튼을 눌렀다 놓을 때 발생한다

onviewchange

키보드 조작을 통해 input의 값을 변경한 후, 포커스가 빠져나가자마자 발생(onblur 직전에 발생)한다.

Method Summary

addClass( className )

컴포넌트에 class를 추가한다

bind( eventType , function )

컴포넌트의 이벤트를 동적으로 할당한다

changeClass( oldClassName , newClassName )

컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.

focus( )

컴포넌트에 focus를 준다

getDisabled( )

현재 설정되어있는 disabled 속성값을 반환한다

getGenerator( )

generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다

getID( )

웹스퀘어 컴포넌트의 id를 반환한다

getOpacity( )

CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다

getPluginName( )

웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다

getPosition( positionName )

컴포넌트의 left 또는 top의 위치 값을 반환한다

getReadOnly( )

현재 설정되어있는 readOnly 속성값을 반환한다

getSize( sizeName )

컴포넌트의 크기 값을 반환합니다

getStyle( propertyName )

컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다

getStyleValue( style )

[deprecated]getStyle로 사용.

getTitle( )

title 속성값을 반환한다

getUserData( key )

setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다

getValue( )

컴포넌트의 value를 반환한다

hasClass( className )

컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다

hide( )

컴포넌트를 화면에서 보이지 않도록 숨긴다.

removeClass( className )

컴포넌트에 className의 class를 삭제한다.

setDisabled( disabled )

컴포넌트의 disabled 속성을 설정한다

setEventPause( evList , flag )

컴포넌트의 이벤트를 disable 또는 enable시킨다

setOpacity( value )

컴포넌트의 CSS Opacity(불투명도)값를 설정한다

setPlaceholder( placeholderStr )

placeholder 속성값을 변경한다

setPosition( left , top , mode )

컴포넌트의 위치(left,top)를 설정한다

setReadOnly( readOnly )

readOnly 속성값을 설정한다

setRef( ref )

ref 속성을 설정하는 기능으로 DataCollection과 연동시 "data:"라는 prefix를 꼭 붙여야한다.

setSize( width , heigth )

컴포넌트의 크기(width,height)를 설정한다

setStyle( propertyName , value )

컴포넌트의 property별 style을 설정한다

setTitle( title )

컴포넌트의 title속성을 설정한다

setUserData( key , value )

컴포넌트에 사용자 데이터를 설정한다

setValue( value )

컴포넌트의 value를 설정한다

show( displayType )

컴포넌트를 화면에 보이도록 설정한다.

toggleClass( className )

컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.

trigger( type , array )

컴포넌트에 등록 된 특정 이벤트를 발생시킨다

unbind( type , function )

컴포넌트에 등록 된 이벤트를 제거한다

unbindRef( )

ref 바인딩을 해제합니다

validate( )

textarea의 validate를 체크합니다

visible( flag )

[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.

class

HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
기본적으로 엔진 내부에서 컴포넌트별로 class를 적용하고 있으며 해당 class를 이용하여 컴포넌트의 css를 공통으로 적용할 수 있다.

disabled

[default:false, true]HTML의 disabled속성과 동일한 기능을 제공하며 컴포넌트를 비활성화 시킨다.

displaymessage

[default:false, true]validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 표시 할지의 여부.
기본적으로 엔진에서 정의 된 메세지가 표현되며 별도의 메세지를 정의하고자 할 때는 invalidMessageFunc속성을 이용한다.

focusRemember

[false, true] IE9이하 구형 브라우저에서 focus를 받을 경우 이전 focus를 받았을 때의 커서 위치로 커서를 이동시킬지의 여부.
(신형 브라우저는 브라우저가 자동으로 이전 focus의 커서 위치를 기억한다.)

id

컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다.

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, minLength, maxLength, minByteLength, maxByteLength
예시)function fn_msg(){ var tmpType = this.getType(); var tmpValue = this.getValue(); if(tmpType == "mandatory"){ return "필수 검증 항목입니다."; } }

mandatory

[default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부.

maxByteLength

입력 가능한 최대 Byte길이로 엔진에서 maxByteLength 이상의 글자를 입력하면 자동으로 잘라낸다.
maxLength속성의 값과 본 속성에 지정한 값 중 더 작은 수가 우선 순위로 적용된다.
config.xml 파일의 byteCheckEncoding 설정 값이 euc-kr이면 한글은 2byte로 utf-8이면 3byte로 계산한다.

maxlength

입력 가능한 최대길이로 엔진에서 maxLength 이상의 글자를 입력하면 자동으로 잘라낸다.
maxByteLength속성의 값과 본 속성에 지정한 값 중 더 작은 수가 우선 순위로 적용된다.

minByteLength

validate API를 호출 할 때 엔진에서 최소 Byte길이 체크 시에 참조한다.
config.xml 파일의 byteCheckEncoding 설정 값이 euc-kr이면 한글은 2byte로 utf-8이면 3byte로 계산한다.

minlength

validate API를 호출 할 때 엔진에서 최소길이 체크 시에 참조한다.

name

html속성인 name 태그를 생성하는 속성. 예를 들어서 name = "nameTag"로 설정 시 랜더링 후 textarea컴포넌트에
name = "nameTag" 속서이 추가되어서 나타난다.

placeholder

HTML5의 placeholder 기능으로 사용자에게 알려줘야 할 문구(hint)등을 명시한다.
브라우저마다의 동작 방식이 상이할 수 있다.(예를 들어 IE는 focus시 hint가 사라지지만 Chrome의 경우 text가 입력 되어야 사라진다.)

readOnly

[default:false, true]readonly의 여부로 HTML의 readonly속성과 동일한 기능을 제공한다.

ref

DataCollection의 value 경로로 컴포넌트와 DataCollection의 value를 binding을 시킬 때 사용하며 "data:"라는 prefix는 필수로 붙여주어야 한다.
작성 방법은 data:[DataCollection ID].[Key id 또는 Column id]와 같다. 예시)data:dataMap1.remark
DataList와 연동 된 경우는 GridView에서 선택 된 Row의 값이 binding 된다.
Instance Data와 연동 할 경우 연동 할 XML 데이터의 XPath를 명시한다. 예시)res/userInfo/remark

tabIndex

Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다.

title

HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다. 일반적으로 웹접근성 작업 시 설정한다.

toolTip

웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다. 마우스 over시 표현된다.

userData1

사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.

userData2

사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.

userData3

사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.

validator

컴포넌트의 blur 시점에 본 속성에 정의 한 Function을 실행 된다.
blur시점에 유효성체크를 하고자 할 때 본 속성을 이용하며 return을 통해 value값을 변경 할 수도으며 onblur 이벤트보다 먼저 실행된다.

onblur

포커스를 잃었을 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onchange

컴포넌트의 value가 변경되었을 때 발생하는 이벤트로 focus out 시점에 발생한다.
스크립트를 통해 값이 변경 된 경우에도 발생하며, 이전값/이후값을 비교 할 때는 onviewchage 이벤트를 사용한다.

onclick

마우스로 컴포넌트를 클릭했을 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

ondblclick

마우스로 컴포넌트를 더블 클릭했을 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onfocus

포커스를 얻었을 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onkeydown

키보드에서 키를 눌렀을 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onkeypress

키보드에서 키를 눌렀을 때(누르고 있는 동안에도) 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onkeyup

키보드에서 키를 눌렀다 놓았을 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onmousedown

마우스를 클릭 했을 때(마우스를 누르는 순간) 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onmousemove

마우스 포인터가 이동될 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onmouseout

마우스가 지정된 영역이나 링크 위에서 벗어났을 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onmouseover

마우스가 지정된 영역이나 링크 위에 놓일 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onmouseup

마우스 버튼을 눌렀다 놓을 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

onviewchange

키보드 조작을 통해 input의 값을 변경한 후, 포커스가 빠져나가자마자 발생(onblur 직전에 발생)한다.
스크립트를 통해 값이 변경된 경우에는 해당 이벤트가 발생하지 않는다. (native onchange 이벤트와 유사.)

Parameter

name	type	description
info	JSON	oldValue, newValue를 포함한 JSON을 반환한다. <String> info.oldValue : 이전 값 <String> info.newValue : 변경된 값

Sample

//컴포넌트 태그 안에 event가 있는 경우 <script ev:event="onviewchange( info )"><![CDATA[ var oldValue = info.oldValue; var newValue = info.newValue; ]]></script>

addClass( className )

컴포넌트에 class를 추가한다.

Parameter

name	type	required	description
className	String	Y	추가하고 싶은 class의 이름

Sample

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

bind( eventType , function )

컴포넌트의 이벤트를 동적으로 할당한다.

Parameter

name	type	required	description
eventType	String	Y	할당 할 이벤트명.
function	Function	Y	동적으로 할당 할 이벤트의 핸들러 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

name	type	required	description
oldClassName	String	Y	삭제 할 class의 이름
newClassName	String	Y	추가 할 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");

focus( )

컴포넌트에 focus를 준다.

getDisabled( )

현재 설정되어있는 disabled 속성값을 반환한다.

Return

type	description
Boolean	disabled 속성값

Sample

var returnValue = componentId.getDisabled(); return 예시 ) false

getGenerator( )

generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다.

Return

type	description
Object	부모 generator 객체

Sample

<w2:generator id="generator1"> <w2:trigger id="trigger1" ev:onclick="scwin.trigger1_onclick"></w2:trigger></w2:generator> scwin.trigger1.onclick = function(){ console.log(this.getGenerator());} // trigger1 클릭 시 generator1 객체가 console에 찍힌다. // https://inswave.com/jira/browse/WPF-1425 참조

getID( )

웹스퀘어 컴포넌트의 id를 반환한다.

Return

type	description
String	웹스퀘어 컴포넌트의 id

Sample

//동적으로 웹스퀘어 컴포넌트를 파라메터로 받았을 경우 아래와 같이 사용 할 수 있다. function fn_validCheck(tmpObj){ //tmpObj가 input1 이라는 ID를 가지고 있는 경우 var compID = tmpObj.getID(); //return 예시 ) "input1" }

getOpacity( )

CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다.

Return

type	description
Integer	Opacity 값

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

type	description
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

name	type	required	description
positionName	String	Y	[left,top]위치 종류

Return

type	description
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

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

Sample

var returnValue = componentId.getReadOnly(); //return 예시 ) false

getSize( sizeName )

컴포넌트의 크기 값을 반환합니다.%로 설정된 경우, 픽셀로 변환하여 반환한다.

Parameter

name	type	required	description
sizeName	String	Y	[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

type	description
Number	컴포넌트의 크기 값

Sample

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

getStyle( propertyName )

컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다.

Parameter

name	type	required	description
propertyName	String	Y	반환 할 style의 property 이름

Return

type	description
String	style의 속성값

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

name	type	required	description
style	String	Y	정의 된 style에서 사용자가 반환 받고자하는 속성명.

Return

type	description
String	style 속성에 정의 된 값(색을 반환하는 경우에는 색HexCode로 반환)

getTitle( )

title 속성값을 반환한다.

Return

type	description
String	title 속성값.

Sample

//아래와 같이 input 컴포넌트에 title이 정의 된 경우 <xf:input id="input1" style="position: relative;width: 144px;height: 21px;" title="이름 입력"></xf:input> var tmpTitle = input1.getTitle(); //return 예시 ) "이름 입력"

getUserData( key )

setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다.

Parameter

name	type	required	description
key	String	Y	임의 데이터의 키

Return

type	description
String	key에 해당하는 데이터

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"

getValue( )

컴포넌트의 value를 반환한다.

Return

type	description
String	컴포넌트의 value

Sample

//사용자가 textarea1 컴포넌트에 "WebSquare"를 입력 한 경우 var tmpRs = textarea1.getValue(); //return 예시 ) "WebSquare"

hasClass( className )

컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다.

Parameter

name	type	required	description
className	String	Y	검색 할 className

Return

type	description
Boolean	class를 가지고 있는지의 여부

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

removeClass( className )

컴포넌트에 className의 class를 삭제한다.
기본 설정은 addClass API를 통해 추가 된 class만 적용되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>

Parameter

name	type	required	description
className	String	Y	삭제 할 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

name	type	required	description
disabled	Boolean	Y	disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false

Sample

//컴포넌트의 disabled 적용 componentId.setDisabled(true);

setEventPause( evList , flag )

컴포넌트의 이벤트를 disable 또는 enable시킨다.

Parameter

name	type	required	description
evList	String	N	대상 이벤트 목록. 해당 인자가 주어지지 않을 경우 해당 컴포넌트의 모든 사용자 이벤트가 대상이 된다. (null을 지정하면 된다.)
flag	Boolean	Y	true인 경우 pause시키며, false인 경우 pause를 해제한다.

Sample

input1.setEventPause("onclick", true); //onclick이벤트를 동적으로 pause 한다. input1.setEventPause("onfocus,onblur", false); //onfocus이벤트와 onblur이벤트의 pause를 해제한다. input1.setEventPause(null, true); //input에 등록된 모든 사용자 이벤트를 pause 한다.

setOpacity( value )

컴포넌트의 CSS Opacity(불투명도)값를 설정한다.

Parameter

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

Sample

componentId.setOpacity(0.45);

setPlaceholder( placeholderStr )

placeholder 속성값을 변경한다.

Parameter

name	type	required	description
placeholderStr	String	Y	변경할 placeholder의 값

Sample

textarea1.setPlaceholder("내용을 입력하세요");

setPosition( left , top , mode )

컴포넌트의 위치(left,top)를 설정한다.

Parameter

name	type	required	description
left	Number	Y	left의 값 또는 null.
top	Number	Y	top의 값 또는 null.
mode	String	N	[defulat:absolute, delta]absolute이면 x,y로 현재 값을 설정하고 delta이면 현재 값에 x,y값만큼을 더해서 설정.

Sample

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

setReadOnly( readOnly )

readOnly 속성값을 설정한다. readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력합니다.

Parameter

name	type	required	description
readOnly	Boolean	Y	readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false

Sample

//컴포넌트의 readonly 적용. componentId.setReadOnly(true);

setRef( ref )

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

Parameter

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

Sample

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

setSize( width , heigth )

컴포넌트의 크기(width,height)를 설정한다.

Parameter

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

Sample

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

setStyle( propertyName , value )

컴포넌트의 property별 style을 설정한다.

Parameter

name	type	required	description
propertyName	String	Y	style 속성 이름
value	String	Y	적용 할 style의 값

Sample

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

setTitle( title )

컴포넌트의 title속성을 설정한다.

Parameter

name	type	required	description
title	String	Y	속성에 적용할 값

Sample

textarea1.setTitle("test"); // textare1의 title속성 값은 "test"로 나타난다.

setUserData( key , value )

컴포넌트에 사용자 데이터를 설정한다. 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하며 log에 관련 내용이 출력 된다.

Parameter

name	type	required	description
key	String	Y	임의 데이터의 키
value	String	Y	임의 데이터의 값

Sample

//컴포넌트에 'data'라는 key로 'WebSquare'라는 값을 설정 할 경우 componentId.setUserData("data", "WebSquare"); //아래와 같이 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하다. componentId.setUserData("title", "WebSquare"); //log 표현 예시 ) !!!WARNING - [title] can't define as UserData

setValue( value )

컴포넌트의 value를 설정한다.

Parameter

name	type	required	description
value	String	Y	textarea의 value값

Sample

//script영역에서 개행이 있는 Text를 value로 설정할 경우 var text = "Inswave \n" +"WebSquare \n" +"ProWorks \n"; textarea1.setValue(text); //display 예시 ) Inswave WebSquare ProWorks

show( displayType )

컴포넌트를 화면에 보이도록 설정한다.
엔진 내부적으로는 CSS를 display속성과 visibility:show;으로 처리한다.

Parameter

name	type	required	description
displayType	String	N	[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

name	type	required	description
className	String	Y	설정 할 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

name	type	required	description
type	String	Y	발생시킬 이벤트 이름
array	Array	N	이벤트 핸들러에 전달할 파라미터 배열

Sample

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

unbind( type , function )

컴포넌트에 등록 된 이벤트를 제거한다.

Parameter

name	type	required	description
type	String	N	제거할 이벤트 이름. 생략할 경우 해당 컴포넌트의 모든 이벤트를 제거한다.
function	Function	N	제거할 이벤트의 핸들러 함수. 생략할 경우 해당 이벤트 type으로 등록된 모든 핸들러 함수를 제거한다.

Sample

//input1에 등록된 모든 이벤트를 제거 input1.unbind(); //input1에 등록된 onviewchange이벤트 핸들러 함수를 모두 제거 input1.unbind("onviewchange"); //input1에 등록된 onviewchange이벤트에서 func1 이벤트 핸들러를 제거 input1.unbind("onviewchange", func1);

unbindRef( )

ref 바인딩을 해제합니다

validate( )

textarea의 validate를 체크합니다. textarea는 필수입력 여부만 체크합니다.

Sample

예: mandatory가 true로 설정된 경우, 미입력 상태에서 유효성 검사 var returnValue = textarea1.validate(); returnValue는 false이다. 유효성 검사 조건(mandatory, min, maxLength 등)을 만족할 경우, true를 반환한다.

visible( flag )

[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.
컴포넌트의 style 중 visibility 값을 설정한다. true이면 "visible", false이면 "hidden"을 설정.

Parameter

name	type	required	description
flag	Boolean	Y	visibility 값을 설정할 값(true이면 "visible", false이면 "hidden"을 설정)