WebSquare.uiplugin.submit

submit 컴포넌트를 생성하고 옵션을 통해서 다양한 기능을 지원합니다.

Type

uiplugin

Property Summary

anchorWithGroupClass: type이 anchor인 경우, w2group 클래스의 적용 여부 결정.
centerOffImageClass: 트리거 마우스아웃시 중앙 이미지 클래스
centerOffImageClass: type속성의 값이 "image"일 경우만 적용되며 중앙 td에 적용될 class명을 정의한다.
centerOnImageClass: 트리거 마우스오버시 중앙 이미지 클래스
centerOnImageClass: type속성의 값이 "image"일 경우만 적용되며 마우스 over 시 중앙 td에 적용될 class명을 정의한다.
class: HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
class: HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
disabled: 컴포넌트 비활성 여부
disabled: [default:false, true] 컴포넌트 비활성 여부
id: 컴포넌트 ID.
id: 컴포넌트 ID.
leftOffImageClass: 트리거 마우스아웃시 왼쪽 이미지 클래스
leftOffImageClass: type속성의 값이 "image"일 경우만 적용되며 왼쪽 td에 적용될 class명을 정의한다.
leftOnImageClass: 트리거 마우스오버시 왼쪽 이미지 클래스
leftOnImageClass: type속성의 값이 "image"일 경우만 적용되며 마우스 over 시 왼쪽 td에 적용될 class명을 정의한다.
localeRef: 웹스퀘어의 client 다국어 기능을 적용 할 때 출력하고자 하는 text의 key를 정의한다.세부 적용은 Client 다국어 적용 가이드를 참조한다.
nextTabID: Tab 키로 이동할 경우, Tab 키를 누를 때 선택되는 컴포넌트의 ID
rightOffImageClass: 트리거 마우스아웃시 오른쪽 이미지 클래스
rightOffImageClass: type속성의 값이 "image"일 경우만 적용되며 오른쪽 td에 적용될 class명을 정의한다.
rightOnImageClass: 트리거 마우스오버시 오른쪽 이미지 클래스
rightOnImageClass: type속성의 값이 "image"일 경우만 적용되며 오른쪽 td에 적용될 class명을 정의한다.
submission: submission ID
submitType: 서브미션 전송 타입
syncMsg: 동기방식 전송시 메세지
tabIndex: Tab 키를 이용하여 포커스를 변경할 경우, 해당 컴포넌트에 포커스를 주는 순서.
tabIndex: Tab 키를 이용하여 포커스를 변경할 경우, 해당 컴포넌트에 포커스를 주는 순서.
title: HTML의 title 속성과 동일
toolTip: 사용자가 컴포넌트에 마우스-오버할 때 표시되는 텍스트
toolTip: 사용자가 컴포넌트에 마우스-오버할 때 표시되는 텍스트
type: submit 컴포넌트 타입
type: [default:button, image, anchor]Trigger 표현 방법을 정의하며 각 타입별 HTML 표현 방식은 아래와 같다.
userData1: 사용자 정의 데이터 속성
userData2: 사용자 정의 데이터 속성
userData3: 사용자 정의 데이터 속성

Event Summary

Method Summary

addClass( className ): 컴포넌트에 CSS class를 추가
bind( eventType , function ): 컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당
changeClass( oldClassName , newClassName ): 웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
focus( ): 웹스퀘어 컴포넌트에 포커스를 줌
getBackgroundImage( ): type속성의 값이 button 인 경우 CSS로 정의 된 background-image 속성값을 반환한다
getDisabled( ): 현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환
getGenerator( ): 컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환
getID( ): 웹스퀘어 컴포넌트의 ID를 반환
getInitStyle( CSS ): 웹스퀘어 컴포넌트의 초기 스타일을 반환
getLabel( ): label을 반환한다
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]
getSubmission( ): submit 컴포넌트의 submission 속성으로 지정된 submission의 실제 객체를 반환한다.
getTitle( ): 컴포넌트의 title 속성 값을 반환
getType( ): 컴포넌트의 현재 설정된 Type을 반환합니다
getUdcHome( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 파일명을 포함해서 반환. (웹스퀘어 컴포넌트 공통.)
getUdcRoot( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 반환. (웹스퀘어 컴포넌트 공통.)
getUserData( key ): setUserData로 웹스퀘어 컴포넌트에 설정한 key의 value 혹은 사용자가 직접 페이지 소스(XML)에 속성으로 정의한 value를 반환
getValue( ): 표시되어 있는 label을 반환한다
hasClass( className ): 웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인
hide( ): 웹스퀘어 컴포넌트를 화면에서 숨김. (웹스퀘어 컴포넌트 공통.)
removeClass( className ): 웹스퀘어 컴포넌트에서 class를 삭제.(웹스퀘어 컴포넌트 공통.)
setBackgroundImage( imgUrl ): type속성의 값이 button 인 경우 배경이미지를 설정한다.
setDisabled( disabled ): 웹스퀘어 컴포넌트의 disabled 속성을 설정
setEventPause( evList , flag ): 지정한 이벤트를 중단함
setInitStyle( property ): 웹스퀘어 컴포넌트의 초기 스타일을 복구
setLabel( lable ): label(value)의 값을 변경한다
setOpacity( value ): 웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
setPosition( left , top , mode ): 웹스퀘어 컴포넌트의 위치(left, top)를 설정
setReadOnly( readOnly ): 웹스퀘어 컴포넌트의 readOnly 속성을 설정
setSize( width , height ): 웹스퀘어 컴포넌트의 크기(width, height)를 설정
setStyle( propertyName , value ): 웹스퀘어 컴포넌트의 CSS 속성을 설정
setSubmission( submission ): submit 컴포넌트의 submission을 설정한다.
setTitle( title ): 컴포넌트의 title 속성을 설정
setUserData( key , value ): 웹스퀘어 컴포넌트에 임의의 데이터를 설정
setValue( lable ): label(value)의 값을 변경한다
show( displayType ): 웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
toggleClass( className ): 웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
trigger( type , array ): 컴포넌트에서 특정 이벤트를 발생시킴
unbind( type , function ): 컴포넌트에서 이벤트를 제거
visible( flag ): [deprecated]

Property Detail

anchorWithGroupClass: type이 anchor인 경우, w2group 클래스의 적용 여부 결정.
true: 적용.
false (기본 값): 적용하지 않음.
centerOffImageClass: 트리거 마우스아웃시 중앙 이미지 클래스
centerOffImageClass: type속성의 값이 "image"일 경우만 적용되며 중앙 td에 적용될 class명을 정의한다.
class에는 image의 url을 명시하며 일반적으로 width값은 제외한다.(left class와 right class에 명시)
class 정의 예시 ) .tmpBtnCenter{ background-image: url(/img/btn_c.png); }
centerOnImageClass: 트리거 마우스오버시 중앙 이미지 클래스
centerOnImageClass: type속성의 값이 "image"일 경우만 적용되며 마우스 over 시 중앙 td에 적용될 class명을 정의한다.
class에는 image의 url을 명시하며 일반적으로 width값은 제외한다.(left class와 right class에 명시)
class 정의 예시 ) .tmpBtnCenterOn{ background-image: url(/img/btn_c_on.png); }
class: HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
Engine 내부에서 각 컴포넌트 별로 지정된 class를 적용하나, class 속성을 이용하여 컴포넌트의 CSS를 제어 가능.
class: HTML의 class 속성과 동일한 기능을 제공. CSS 파일이나 style 블럭에 정의한 여러 개의 class를 공백으로 구분하여 적용 가능.
Engine 내부에서 각 컴포넌트 별로 지정된 class를 적용하나, class 속성을 이용하여 컴포넌트의 CSS를 제어 가능.
disabled: 컴포넌트 비활성 여부.
disabled: [default:false, true] 컴포넌트 비활성 여부.
id: 컴포넌트 ID.
컴포넌트 ID는 전역 객체로 할당됨. 각 컴포넌트 ID를 통해 Script에서 해당 컴포넌트에 접근 가능.
id: 컴포넌트 ID.
컴포넌트 ID는 전역 객체로 할당됨. 각 컴포넌트 ID를 통해 Script에서 해당 컴포넌트에 접근 가능.
leftOffImageClass: 트리거 마우스아웃시 왼쪽 이미지 클래스
leftOffImageClass: type속성의 값이 "image"일 경우만 적용되며 왼쪽 td에 적용될 class명을 정의한다.
class에는 image의 url과 width 속성은 필수로 정의한다.(center td영역의 width를 주지 않을 경우)
class 정의 예시 ) .tmpBtnLeft{ background-image: url(/img/btn_l.png); width:10px; }
leftOnImageClass: 트리거 마우스오버시 왼쪽 이미지 클래스
leftOnImageClass: type속성의 값이 "image"일 경우만 적용되며 마우스 over 시 왼쪽 td에 적용될 class명을 정의한다.
class에는 image의 url과 width 속성은 필수로 정의한다.(center td영역의 width를 주지 않을 경우)
class 정의 예시 ) .tmpBtnLeftOn{ background-image: url(/img/btn_l_on.png); }
localeRef: 웹스퀘어의 client 다국어 기능을 적용 할 때 출력하고자 하는 text의 key를 정의한다.세부 적용은 Client 다국어 적용 가이드를 참조한다.
만약 다국어 설정이 정상적으로 되어있지 않거나 본 속성에 정의한 값이 key로 정의 되지 않은 경우 "global_undefined"와 같은 text가 표현된다.
nextTabID: Tab 키로 이동할 경우, Tab 키를 누를 때 선택되는 컴포넌트의 ID.
rightOffImageClass: 트리거 마우스아웃시 오른쪽 이미지 클래스
rightOffImageClass: type속성의 값이 "image"일 경우만 적용되며 오른쪽 td에 적용될 class명을 정의한다.
class에는 image의 url과 width 속성은 필수로 정의한다.(center td영역의 width를 주지 않을 경우)
class 정의 예시 ) .tmpBtnRight{ background-image: url(/img/btn_r.png); width:10px; }
rightOnImageClass: 트리거 마우스오버시 오른쪽 이미지 클래스
rightOnImageClass: type속성의 값이 "image"일 경우만 적용되며 오른쪽 td에 적용될 class명을 정의한다.
class에는 image의 url과 width 속성은 필수로 정의한다.(center td영역의 width를 주지 않을 경우)
class 정의 예시 ) .tmpBtnRightOn{ background-image: url(/img/btn_r.png); width:10px; }
submission: submission ID
submitType: 서브미션 전송 타입
syncMsg: 동기방식 전송시 메세지
tabIndex: Tab 키를 이용하여 포커스를 변경할 경우, 해당 컴포넌트에 포커스를 주는 순서.
HTML의 tabindex 속성과 동일.
tabIndex: Tab 키를 이용하여 포커스를 변경할 경우, 해당 컴포넌트에 포커스를 주는 순서.
HTML의 tabindex 속성과 동일.
title: HTML의 title 속성과 동일. 마우스 오버 시, title로 저장한 값이 툴팁으로 표시됨. 일반적으로 웹접근성 지원용으로 설정.
toolTip: 사용자가 컴포넌트에 마우스-오버할 때 표시되는 텍스트. 웹스퀘어가 제공하는 툴팁으로, 컴포넌트의 추가 정보를 명시.
toolTip: 사용자가 컴포넌트에 마우스-오버할 때 표시되는 텍스트. 웹스퀘어가 제공하는 툴팁으로, 컴포넌트의 추가 정보를 명시.
type: submit 컴포넌트 타입
type: [default:button, image, anchor]Trigger 표현 방법을 정의하며 각 타입별 HTML 표현 방식은 아래와 같다.
button : HTML input Tag로 표현되며 type="button"으로 구성 된다.
image : 최상위 table Tag로 이루어져있고 left, center, right에 각각에 class적용이 가능하다.(본 컴포넌트의 center,left,right로 시작하는 속성들을 참조)
anchor : 최상위 anchor Tag로 이루어져있고 button의 text는 span Tag로 구성된다.
userData1: 사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있음.
userData2: 사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있음.
userData3: 사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있음.

Event Detail

Method Detail

addClass( className )

컴포넌트에 CSS 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	이벤트에 대한 핸들러 함수.

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

focus( )

웹스퀘어 컴포넌트에 포커스를 줌. (웹스퀘어 컴포넌트 공통.)

getBackgroundImage( )

type속성의 값이 button 인 경우 CSS로 정의 된 background-image 속성값을 반환한다.

Return
type	description
String	현재 CSS에 설정된 background-image 속성값

Sample

//아래와 같이 trigger1의 style에 background-image를 정의한 경우 <xf:trigger type="button" id="trigger1" style="position:relative;width:80px;height:23px;background-image: url(/img/book1.jpg);"> <xf:label><![CDATA[click]]></xf:label> </xf:trigger> var returnValue = trigger1.getBackgroundImage(); //return 예시 ) "url(http://localhost:9999/img/book1.jpg)"

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

getLabel( )

label을 반환한다. getValue와 동일한 기능을 제공한다.

Return
type	description
String	label값

Sample

//아래와 같이 trigger1의 label의 값을 click으로 정의한 경우 <xf:trigger type="button" id="trigger1" style="position:relative;width:80px;height:23px;"> <xf:label><![CDATA[click]]></xf:label> </xf:trigger> var returnValue = trigger1.getLabel(); //return 예시 ) "click"

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

getReadOnly( )

현재 웹스퀘어 컴포넌트에 설정된 readOnly 속성 값을 반환. (웹스퀘어 컴포넌트 공통.)

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

Sample

// 컴포넌트의 readOnly 속성 값 확인 예제 var returnValue = componentId.getReadOnly(); // 반환 값 예시) false

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

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로 반환됨.)

getSubmission( )

submit 컴포넌트의 submission 속성으로 지정된 submission의 실제 객체를 반환한다.
예를 들어 xml파일 model부분에 submission1이라는 ID의 submission객체가 존재하고,
submit 객체의 submission 속성값으로 submission1이라는 값이 set되어 있으면, getSubmission()
method의 반환값은 아이디가 submission1인 submission 태그를 파싱하여 만든 내부 객체가 된다.

Return
type	description
Object	submit 컴포넌트의 submission객체

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 예시 ) "이름 입력"

getType( )

컴포넌트의 현재 설정된 Type을 반환합니다.

Return
type	description
String	현재 설정되어 있는 type 속성값

Sample

trigger의 속성 type이 button인 경우, trigger1.getType()은 button이다. image인 경우, trigger1.getType()은 image이다.

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

표시되어 있는 label을 반환한다. getLabel과 동일한 기능을 제공한다.

Return
type	description
String	label값

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

removeClass( className )

웹스퀘어 컴포넌트에서 class를 삭제.(웹스퀘어 컴포넌트 공통.)
기본적으로 addClass를 통해 추가된 class만 삭제 가능.
컴포넌트의 속성으로 직접 정의된 class를 삭제하기 위해서는 config.xml 파일에 아래 설정을 추가해야 함. // 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");

setBackgroundImage( imgUrl )

type속성의 값이 button 인 경우 배경이미지를 설정한다.
해당값은 CSS의 background-image 속성값으로 설정된다.

Parameter
name	type	required	description
imgUrl	String	Y	이미지 URL

Sample

trigger1.setBackgroundImage('/img/btn_book1.jpg');

setDisabled( disabled )

웹스퀘어 컴포넌트의 disabled 속성을 설정. (웹스퀘어 컴포넌트 공통.)

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

setLabel( lable )

label(value)의 값을 변경한다.setValue와 동일한 기능을 제공한다.

Parameter
name	type	required	description
lable	String	Y	출력 할 text

Sample

trigger1.setLabel('search'); //display 예시 ) trigger의 표시되는 텍스트는 search이다.

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

setReadOnly( readOnly )

웹스퀘어 컴포넌트의 readOnly 속성을 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
readOnly	Boolean	Y	readOnly 속성 활성화 여부. (true: 활성화, false: 비활성화)

Sample

//컴포넌트의 readOnly 속성을 true로 설정하는 예. componentId.setReadOnly(true);

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

setSubmission( submission )

submit 컴포넌트의 submission을 설정한다.
submission의 id를 인자로 넘겨주면, 파싱한 모델 내에서 ID에 맞는 submission 객체를 찾아서 submit 내부에 set하여 준다

Parameter
name	type	required	description
submission	String	Y	submit 객체의 submission의 id

setTitle( title )

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

Parameter
name	type	required	description
title	String	Y	속성으로 설정할 값.

Sample

// title 속성을 "test"로 설정하는 예제 trigger1.setTitle("test");

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

label(value)의 값을 변경한다.setLabel와 동일한 기능을 제공한다.

Parameter
name	type	required	description
lable	String	Y	출력 할 text

Sample

trigger1.setValue('search'); //display 예시 ) trigger의 표시되는 텍스트는 search이다.

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 파일에 아래 설정을 추가. // 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);

visible( flag )

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

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