WebSquare.uiplugin.group

레이아웃용 컴포넌트로 하위에 컴포넌트들을 배치 시킬 수 있으며 입력용 컴포넌트의 value 초기화기능(init) 또는 하위 컴포넌트들에 특정 API,Function 실행기능(invoke)등을 사용할 수 있다.
기본적으로 HTML div Tag로 표현되며 div Tag 이외의 child를 가질 수 있는 HTML Tag(ul,dl,ol,table 등)들을 tagname 속성을 이용하여 표현 할 수 있다.
추가로 Group컴포넌트는 value를 가질 수 없는 컴포넌트임으로 value를 설정해야 하는 경우 Textbox컴포넌트와 함께 사용한다.
전체적인 레이아웃 조절의 편의성, UI 유지보수 등을 위해 컴포넌트들을 Group 하위로 block화 시켜 구성하는 것을 권장한다.

Type

uiplugin

Property Summary

adaptive: tagname이 table일 경우 적응형 웹(다양한 화면크기와 디바이스에 맞게 레이아웃을 변경) 모드. 속성값이 crosstab인 경우, thead와 tbody가 각각 하나씩 있어야 함.
adaptiveThreshold: tagname이 table일 경우 adaptive가 설정되어 있을 경우 레이아웃 변경을 하기 위한 breakpoint(기본값 : 480)
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의 한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다
label: 컴포넌트의 value로 group컴포넌트에 설정하고자 하는 text를 정의한다
tabIndex: Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다
tagname: 기본적으로 Group컴포넌트는 div Tag로 표현되며 div가 아닌 다른 Tag로 표현하고자 할 때 사용한다.
toolTip: 웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다
tooltipDisplay: [default:false, true] cell의 데이터가 width보다 긴 경우 해당 데이터를 마우스 over시 툴팁으로 표현할지의 여부
tooltipFormatter: tooltipDisplay속성이 true일 때 데이터를 표현 할 tooltip의 내용을 변경 할 사용자 함수명.
tooltipPositionX: [defulat:20] tooltipDisplay가 true일 경우 표현 될 tooltip의 x좌표로 마우스 오버된 엘리먼트의 왼쪽 끝이 원점이며 px단위로 계산된다.
tooltipPositionY: [defulat:cellHeight+3] tooltipDisplay가 true일 경우 표현 될 tooltip의 y좌표로 마우스 오버된 엘리먼트의 왼쪽 상단이 원점이며 px단위로 계산된다.
tooltipTime: tooltipDisplay속성의 값이 true일 때, tooltip이 보이는데 걸리는 초(second)
userData1: 사용자 정의 데이터 속성
userData2: 사용자 정의 데이터 속성
userData3: 사용자 정의 데이터 속성

Event Summary

onblur: 포커스를 잃었을 때 발생
onclick: 마우스로 group을 클릭했을 때 발생
ondblclick: 마우스로 group을 더블 클릭했을 때 발생
onfocus: 포커스를 얻었을 때 발생
onmousedown: 마우스를 클릭 했을 때(마우스를 누르는 순간) 발생
onmousemove: 마우스 포인터가 이동될 때 발생
onmouseout: 마우스가 지정된 영역이나 링크 위에서 벗어났을 때 발생
onmouseover: 마우스가 지정된 영역이나 링크 위에 놓일 때 발생
onmouseup: 마우스 버튼을 눌렀다 놓을 때 발생
ontooltiphide: 툴팁이 사라질 때 발생
ontooltipshow: 툴팁이 나타날 때 발생

Method Summary

addClass( className ): 컴포넌트에 CSS class를 추가
bind( eventType , function ): 컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당
changeClass( oldClassName , newClassName ): 웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
focus( ): 웹스퀘어 컴포넌트에 포커스를 줌
getAttributeNode( attributeName ): 기본적으로 tagname속성의 확장을 위해 만든 html attributes(스튜디오에서의 명칭)를 이용하여 정의 된 속성값을 반환한다.
getGenerator( ): 컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환
getID( ): 웹스퀘어 컴포넌트의 ID를 반환
getInitStyle( CSS ): 웹스퀘어 컴포넌트의 초기 스타일을 반환
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로 웹스퀘어 컴포넌트에 설정한 key의 value 혹은 사용자가 직접 페이지 소스(XML)에 속성으로 정의한 value를 반환
hasClass( className ): 웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인
hide( ): 웹스퀘어 컴포넌트를 화면에서 숨김. (웹스퀘어 컴포넌트 공통.)
init( options ): Group 하위의 입력 가능한 컴포넌트의 value를 초기화(기본 '') 시킨다. 파라메터를 통해 제외시킬 컴포넌트의 옵션을 적용 할 수 있다.
invoke( funcName , param , options ): Group 하위의 모든 컴포넌트에 API 또는 사용자 정의함수를 호출시켜주는 함수이다
removeAttributeNode( nodeName ): attributes 노드에서 nodeName에 해당하는 하위 노드를 삭제합니다.
removeClass( className ): 웹스퀘어 컴포넌트에서 class를 삭제.(웹스퀘어 컴포넌트 공통.)
setAttributeNode( nodeName , nodeValue ): attributes 노드에서 nodeName에 해당하는 하위 노드에 값을 설정합니다.
setDisabled( disabled ): 그룹 하위 component에 disabled속성을 적용한다
setEventPause( evList , flag ): 지정한 이벤트를 중단함
setInitStyle( property ): 웹스퀘어 컴포넌트의 초기 스타일을 복구
setOpacity( value ): 웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
setPosition( left , top , mode ): 웹스퀘어 컴포넌트의 위치(left, top)를 설정
setReadOnly( readOnly ): 그룹 하위의 component에 readOnly속성을 적용합니다
setSize( width , height ): 웹스퀘어 컴포넌트의 크기(width, height)를 설정
setStyle( propertyName , value ): 웹스퀘어 컴포넌트의 CSS 속성을 설정
setTitle( title ): title속성에 값을 설정한다
setUserData( key , value ): 웹스퀘어 컴포넌트에 임의의 데이터를 설정
show( displayType ): 웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
toggleClass( className ): 웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
trigger( type , array ): 컴포넌트에서 특정 이벤트를 발생시킴
unbind( type , function ): 컴포넌트에서 이벤트를 제거
visible( flag ): [deprecated]

Property Detail

adaptive: tagname이 table일 경우 적응형 웹(다양한 화면크기와 디바이스에 맞게 레이아웃을 변경) 모드. 속성값이 crosstab인 경우, thead와 tbody가 각각 하나씩 있어야 함.
Chrome, Safari, Firefox, Opera, IE10+에서 지원되는 기능입니다.
adaptiveThreshold: tagname이 table일 경우 adaptive가 설정되어 있을 경우 레이아웃 변경을 하기 위한 breakpoint(기본값 : 480)
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의 한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
기본적으로 엔진 내부에서 각 컴포넌트 마다의 class를 적용하고 있으며 해당 class를 이용하여 컴포넌트의 css를 공통으로 적용 할 수 있다.
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다.
label: 컴포넌트의 value로 group컴포넌트에 설정하고자 하는 text를 정의한다. 단, 다른 설정 값(Edit value)이 있으면 적용되지 않는다.
tabIndex: Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다.
tagname: 기본적으로 Group컴포넌트는 div Tag로 표현되며 div가 아닌 다른 Tag로 표현하고자 할 때 사용한다.
일반적으로 Group컴포넌트에는 자식 Tag(Element)를 가질 수 있는 Tag를 정의한다.
toolTip: 웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다. 마우스 over시 표현된다.
tooltipDisplay: [default:false, true] cell의 데이터가 width보다 긴 경우 해당 데이터를 마우스 over시 툴팁으로 표현할지의 여부.
tooltipFormatter: tooltipDisplay속성이 true일 때 데이터를 표현 할 tooltip의 내용을 변경 할 사용자 함수명.
사용자 함수에서는 componentId, label을 인자로 받아 tooltip에 표현 할 string을 return한다.
tooltipPositionX: [defulat:20] tooltipDisplay가 true일 경우 표현 될 tooltip의 x좌표로 마우스 오버된 엘리먼트의 왼쪽 끝이 원점이며 px단위로 계산된다.
좌표를 계산 할 수식도 넣을 수 있으며 cellWidth(cell의 width)와 cellHeight(cell의 height)를 이용하여 수식을 넣을 수 있다.
예시 ) cellWidth/2 : body cell의 중앙이 툴팁의 x축 시작점이 된다.
tooltipPositionY: [defulat:cellHeight+3] tooltipDisplay가 true일 경우 표현 될 tooltip의 y좌표로 마우스 오버된 엘리먼트의 왼쪽 상단이 원점이며 px단위로 계산된다.
좌표를 계산 할 수식도 넣을 수 있으며 cellWidth(cell의 width)와 cellHeight(cell의 height)를 이용하여 수식을 넣을 수 있다.
예시 ) cellHeight : bocy cell이 끝나는 바로 하위가 y축 시작점이 된다.
주의 사항으로 컴포넌트의 style에 margin-top이 적용 된 경우 y축에 영향을 미친다.
tooltipTime: tooltipDisplay속성의 값이 true일 때, tooltip이 보이는데 걸리는 초(second)
userData1: 사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2: 사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3: 사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.

Event Detail

onblur

포커스를 잃었을 때 발생

Parameter
name	type	description
e	Object	이벤트 객체

onclick

마우스로 group을 클릭했을 때 발생

Parameter
name	type	description
e	Object	이벤트 객체

ondblclick

마우스로 group을 더블 클릭했을 때 발생

Parameter
name	type	description
e	Object	이벤트 객체

onfocus

포커스를 얻었을 때 발생

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	이벤트 객체

ontooltiphide

툴팁이 사라질 때 발생

ontooltipshow

툴팁이 나타날 때 발생

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

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

getAttributeNode( attributeName )

기본적으로 tagname속성의 확장을 위해 만든 html attributes(스튜디오에서의 명칭)를 이용하여 정의 된 속성값을 반환한다.
정의 한 tagname의 Tag가 갖는 html 속성 또한 반환가능하다. 예를 들어 id,class,style등의 속성은 반환되나 tagname과 같은 속성값은 반환되지 않는다.

Parameter
name	type	required	description
attributeName	String	Y	속성명

Sample

//아래와 같이 tagname속성을 이용하여 attribute를 추가 한 경우 <xf:group id="ui_btnLoginGrp" style="" tagname="a"> <w2:attributes> <w2:href>#</w2:href> </w2:attributes> <xf:image id="ui_btnLoginImg" alt="login" src="/images/btn_login.gif"></xf:image> </xf:group> ui_btnLoginGrp.getAttributeNode("href"); //return 예시 ) "#" ui_btnLoginGrp.getAttributeNode("id"); //return 예시 ) "ui_btnLoginGrp" ui_btnLoginGrp.getAttributeNode("tagname"); //return 예시 ) null

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

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

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"

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

init( options )

Group 하위의 입력 가능한 컴포넌트의 value를 초기화(기본 '') 시킨다. 파라메터를 통해 제외시킬 컴포넌트의 옵션을 적용 할 수 있다.
초기화가 가능한 컴포넌트로는 calendar, checkbox, grid, input, inputCalendar, multiselect, radio, selectbox, textarea 가 있다.

Parameter
name	type	required	description
options	Object	N	초기화 동작에서 제외되는 컴포넌트를 설정하는 값의 객체.

Sample

//group1컴포넌트 하위의 사용자 입력용 컴포넌트에 대하여 초기화. group1.init(); //group1컴포넌트 하위에 있는 gridView, radio 컴포넌트와 id가 input1, calendar1인 컴포넌트를 제외한 사용자 입력용 컴포넌트에 대해 초기화하며, 값 변경에 따른 이벤트를 발생시킨다. var options = { excludePlugin : "gridView radio", excludeId : "input1 calendar1", fireEvent : true }; group1.init(options);

invoke( funcName , param , options )

Group 하위의 모든 컴포넌트에 API 또는 사용자 정의함수를 호출시켜주는 함수이다.

Parameter
name	type	required	description
funcName	String	Y	호출하려는 API명 또는 사용자 함수를 사용할 때는 "assert"로 정의
param	Object	N	호출하려는 API에 넘겨질 파라메터 또는 사용자 정의함수
options	JSON	N	함수 호출에서 제외되는 컴포넌트를 설정하는 값의 객체.

Sample

group1.invoke("setValue", "WebSquare"); 그룹의 하위의 모든 컴포넌트에 componentId.setValue("WebSquare"); 한것과 같다. 만약 하위의 컴포넌트에 setValue 함수를 가지지 않는 컴포넌트(예:grid)가 있다면 에러. function createValue(obj){ var pluginName = obj.getPluginName(); // 컴포넌트의 종류. var id = obj.getID(); // 컴포넌트의 id. ... } var options = { excludePlugin : "grid calendar", excludeId : "radio1" }; group1.invoke("setValue", createValue, options); 그룹의 하위의 grid와 calendar, id가 radio1인 컴포넌트를 제외하고 componentId.setValue(사용자 정의 함수(createValue)를 호출하여 반환된 리턴 값); 한것과 같다. var options = { includePlugin : "grid calendar", includeId : "radio1" }; group1.invoke("setValue", createValue, options); 그룹의 하위의 grid와 calendar, id가 radio1인 컴포넌트만 componentId.setValue(사용자 정의 함수(createValue)를 호출하여 반환된 리턴 값); 한것과 같다.

removeAttributeNode( nodeName )

attributes 노드에서 nodeName에 해당하는 하위 노드를 삭제합니다.
nodeName으로 사용할 수 있는 값은 config.xml의 attributes 설정을 따릅니다.

Parameter
name	type	required	description
nodeName	String	Y	삭제할 하위 노드의 이름

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

setAttributeNode( nodeName , nodeValue )

attributes 노드에서 nodeName에 해당하는 하위 노드에 값을 설정합니다.
nodeName으로 사용할 수 있는 값은 config.xml의 attributes 설정을 따릅니다.

Parameter
name	type	required	description
nodeName	String	Y	값을 설정할 하위 노드의 이름
nodeValue	String	Y	노드에 설정할 값

setDisabled( disabled )

그룹 하위 component에 disabled속성을 적용한다.

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

Sample

//그룹 하위의 컴포넌트에 disabled 속성 활성화. group1.setDisabled(true); //그룹 하위의 컴포넌트에 disabled 속성 비활성화. group1.setDisabled(false);

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

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 )

그룹 하위의 component에 readOnly속성을 적용합니다.

Parameter
name	type	required	description
readOnly	String	Y	readOnly설정 값 (true \| false)

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

setTitle( title )

title속성에 값을 설정한다.

Parameter
name	type	required	description
title	String	Y	속성에 설정할 값

Sample

group1.setTitle("title"); // group1 컴포넌트에 title속성 값은 "title"로 나타난다.

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.

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

visible( flag )

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

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