Type

uiplugin

Property Summary

class

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

disabled

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

displaymessage

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

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를 호출 할 때 엔진에서 최소길이 체크 시에 참조한다

onFocusClass

onFocus시 적용할 class명

placeholder

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

readOnly

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

readOnlyClass

readOnly 상태 일때 적용할 class명

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

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

onclick

마우스로 component를 클릭했을 때 발생한다

ondblclick

마우스로 component를 더블 클릭했을 때 발생한다

onfocus

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

onkeydown

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

onkeypress

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

onkeyup

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

onmousedown

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

onmousemove

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

onmouseout

마우스가 지정된 영역을 벗어났을 때 발생한다

onmouseover

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

onmouseup

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

onviewchange

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

Method Summary

getDataType( )

[default:text]dataType 속성값을 반환한다

getValue( )

컴포넌트의 value를 반환한다

setDisabled( disabled )

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

setStyle( propertyName , value )

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

setValue( value )

컴포넌트의 value를 설정한다

show( displayType )

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

trigger( type , array )

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

validate( )

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

class

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

disabled

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

displaymessage

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

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를 호출 할 때 엔진에서 최소길이 체크 시에 참조한다.

onFocusClass

onFocus시 적용할 class명.

placeholder

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

readOnly

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

readOnlyClass

readOnly 상태 일때 적용할 class명.

ref

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

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 이벤트보다 먼저 실행된다.
Function 구현 예시)function fn_idValid(tmpVal){ //tmpVal에는 본 컴포넌트의 value값이 담겨있다. 로직 구현후 최종값을 return한다. return tmpVal;};

onblur

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

Parameter

name	type	description
e	Object	이벤트 객체

onchange

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

onclick

마우스로 component를 클릭했을 때 발생한다.

Parameter

name	type	description
e	Object	이벤트 객체

ondblclick

마우스로 component를 더블 클릭했을 때 발생한다.

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>

getDataType( )

[default:text]dataType 속성값을 반환한다.

Return

type	description
String	secret의 dataType

Sample

//아래와 같이 secret이 정의 된 경우 <xf:secret id="secret1" style="position: relative;width: 144px;height: 21px;"></xf:secret> var returnValue = secret1.getDataType(); //return 예시 ) "text"

getValue( )

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

Return

type	description
String	컴포넌트의 value

Sample

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

setDisabled( disabled )

컴포넌트의 disabled 속성을 설정한다. disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력한다.

Parameter

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

Sample

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

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

setValue( value )

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

Parameter

name	type	required	description
value	String	Y	secret의 value 값

Sample

secret1.setValue("WebSquare");

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

trigger( type , array )

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

Parameter

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

Sample

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

validate( )

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

Return

type	description
Boolean	유효성 검사 결과 값

Sample

//아래와 같이 secret 컴포넌트에 mandatory 속성을 정의했을 경우 <xf:secret id="secret1" style="position: relative;width: 144px;height: 21px;" mandatory="true"></xf:secret> var returnValue = secret1.validate(); //return 예시 - secret1의 값이 없을 경우 ) false //return 예시 - secret1의 값이 있을 경우) true secret 컴포넌트의 displaymessage="true" 설정을 함께 사용하면 유효성 검사에서 false가 된 경우 엔진에서 설정 된 메세지가 alert으로 뜬다. //alert 메세지 예시 ) 필수 입력 항목입니다