WebSquare.uiplugin.treeview

계층 구조를 가지는 데이터를 Tree형태로 출력하는 컴포넌트이다.
각 노드에 checkbox와 image(icon)를 넣을 수 있으며 TeeView 컴포넌트간 마우스의 Drag&Drop을 이용하여 Data(노드)를 주고 받을 수 있다.
본 컴포넌트는 최상위에는 div Tag로, 하위에는 복합 Tag를 이용하여 표현하고 있다.

Type

uiplugin

Property Summary

accessibility: [true,false]웹접근성 모드의 사용 여부로 true로 설정할 경우 각 노드의 line은 그려지지 않으며 aria-expanded와 같은 HTML 속성들이 추가된다
alwaysDraw: [default:false, true]초기에 child 노드를 전부 표현할지의 여부로 true이면 화면 로딩시 child를 모두 그리고 false이면 노드의 Depth가 showTreeDepth속성의 값보다 작은 노드만 먼저 그린다
checkAllChildNodes: [default:false, true]부모노드를 체크하면 자식노드도 모두 체크할지의 여부
checkboxDisabledFalseValue: 체크박스의 disabled여부의 false값으로 기본적으로 checkbox의 ref 및 checkboxDisabled의 ref가 설정되어야 동작한다
checkboxDisabledTrueValue: 체크박스의 disabled여부의 true값으로 기본적으로 checkbox의 ref 및 checkboxDisabled의 ref가 설정되어야 동작한다
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
dataType: [default:recursive, listed]데이터의 포맷이 tree형태인지 list형태인지를 정의한다.
defaultImage: 노드에 보여질 기본 아이콘의 이미지경로를 설정한다.
disabled: disabled 유무
dynamicAppend: [true,false]동적 트리 추가 사용 여부
escape: [true, false] <>&"를 HTML Escape 문자로 변환하여 화면에 표시한다
expandedImage: 노드(폴더)가 확장되었을 때의 이미지 경로
falseValue: chckbox의 false 값
hierarchy: [default:false, true]하위 노드가 선택되었을 때, 상위 노드를 체크할지 여부.
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다
labelclass: 노드의 label에 적용할 class명
lineShow: [default:true, false]노드 사이에 선을 적용할 지의 여부
refreshCheckboxDisableModel: [default:false, true]checkbox의 disable이 변경된 경우 model영역(DataCollection, InstanceData)에 실시간 반영할지 여부
refreshCheckboxModel: [default:false, true]checkbox의 값이 변경된 경우 model영역(DataCollection, InstanceData)에 실시간 반영할지 여부
scrollFix: [default:false, true]노드를 click할 경우 포커스를 주지 않도록 하여 스크롤을 고정시킬지(true), 해당 노드에 포커스를 주어 스크롤이 움직이게 할지(false)의 여부
showCheckbox: [default:false, true]노드에 checkbox의 표시 여부
showTreeDepth: 초기 로딩시 확장되어 보여질 노드의 depth값
title: HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다
toggleButtonEvent: [default:onclick, onmousedown]toggleButton(toggleImage)을 마우스로 클릭할 때 toggle할 것인지, 또는 마우스를 누르는 순간 바로 toggle될 것인지를 설정한다
toggleEvent: [default:ondblclick, onclick, none]노드에 마우스 이벤트를 적용하여 리스트를 펼치고 접을 때의 적용하고자 하는 이벤트
toolTip: 웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다
tooltipClass: tooltipDisplay속성에 true일 경우 해당 toolTip에 적용 할 class명
tooltipDisplay: [default:false, true]노드의 label이 화면에 다 보여지지 않을 경우 해당 label을 tooltip으로 표현할지의 여부
tooltipGroupClass: [default:true, false]tooltip에 w2group 스타일을 포함시킬지(true)의 여부
tooltipTime: tooltipDisplay가 true일 경우 해당 tooltip이 보이는데 걸리는 초(second)
trueValue: checkbox의 true 값
useDrag: [default:false, true]drag의 사용여부
useHirarchySelect: [default:false, true] 하위 노드를 선택했을 때 상위 노드도 같이 선택할지의 여부
userData1: 사용자 정의 데이터 속성
userData2: 사용자 정의 데이터 속성
userData3: 사용자 정의 데이터 속성

Event Summary

onchange: 선택된 노드가 변경될 경우 발생한다
oncheckboxclick: Checkbox가 클릭된 경우 발생
onclick: label, checkbox, icon, toggle버튼(+,-버튼)을 클릭했을 때 발생한다
ondblclick: label을 더블클릭했을 때 발생한다
ondragleave: useDrag속성이 true이고 drag하는 도중에 마우스 위치가 노드의 순수 label영역(icon영역 미포함)을 벗어난 경우 발생한다
ondragover: useDrag속성이 true이고 drag하는 도중에 마우스의 위치가 노드의 위에 있을 때 발생한다
ondrop: useDrag속성이 true이고 다른 treeview의 노드가 drag되어 본 treeview의 노드 위에서 drop 되었을 때 발생한다
onimageclick: 노드의 icon을 클릭한 경우 발생한다
onlabelclick: 노드의 label을 클릭한 경우 발생한다
onrightbuttonclick: 노드의 영역에서 마우스 오른쪽 버튼이 클릭된 경우 발생한다
ontoggleclick: toggle 이미지(아이콘)이 클릭된 경우 발생한다
onviewchange: treeview의 label, checkbox, icon, toggle버튼을 마우스나 키보드로 선택(클릭)했을 때만 발생하는 이벤트로 스크립트를 통해 변경된 경우에는 발생하지 않는다

Method Summary

addClass( className ): 컴포넌트에 class를 추가한다
appendData( index , xmlArray ): index에 해당하는 노드 하위에 사용자 데이터를 기반으로 노드를 추가한다.
appendNode( parentNode , childNode ): TreeView에서 반환하는 Node를 기반으로 parentNode 하위에 childNode를 추가한다.
appendXmlNodes( parentNode , xmlArray ): TreeView에서 반환하는 Node(parentNode)의 하위에 XML 데이터를 기반으로 노드를 추가한다.
bind( eventType , function ): 컴포넌트의 이벤트를 동적으로 할당한다
changeClass( oldClassName , newClassName ): 컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
checkByIndex( value , checkValue , childCheck ): index를 기반으로 노드(항목)을 찾아 checkbox의 value를 설정한다.
checkByValue( value , checkValue , childCheck ): value를 기반으로 노드(항목)을 찾아 checkbox의 value를 설정한다.
collapseNode( value , hierarchy ): value 또는 index를 기반으로 찾은 노드(항목)를 접는다
disableCheckboxByValue( value , checkDisabled , childDisalbed ): value를 기반으로 노드(항목)을 찾아 checkbox의 disabled를 설정한다
expandNode( value , hierarchy ): value 또는 index를 기반으로 찾은 노드(항목)를 확장한다
findNodeByIndex( index , select ): 초기에 각 노드에 설정된 index를 기반으로 노드 반환한다. 두번째 인자가 true인 경우 해당 노드를 선택한다.
findNodeByValue( value , select ): value를 기반으로 노드를 찾아서 해당 노드를 반환한다. 두번째 인자가 true인 경우 해당 노드를 선택한다.
focus( ): 컴포넌트에 focus를 준다
getCheckedIndexes( options ): checkbox가 체크된 노드들의 index(초기 로딩시 설정)를 배열에 담아 반환한다.
getCheckedLabels( options ): checkbox가 체크된 노드들의 label을 배열에 담아 반환한다
getCheckedNodes( options ): checkbox가 체크된 노드들을 배열에 담아 반환한다.
getCheckedValues( options ): checkbox가 체크된 노드들의 value를 배열에 담아 반환한다
getChildData( value , hierarchy ): value에 해당하는 node의 자식의 data(model에 존재하는)를 반환합니다
getDataListInfo( ): 바이딩된 데이터리스트 정보를 반환한다
getDisabled( ): 현재 설정되어있는 disabled 속성값을 반환한다
getGenerator( ): generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다
getID( ): 웹스퀘어 컴포넌트의 id를 반환한다
getLastChildIndex( srcIndex ): srcIndex에 해당하는 노드의 최종자식노드(자식의 자식을 중첩 탐색)의 index를 반환한다
getOpacity( ): CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다
getParentValue( value ): 노드의 value를 기반으로 부모 노드를 찾아 value를 반환한다.
getPluginName( ): 웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다
getPosition( positionName ): 컴포넌트의 left 또는 top의 위치 값을 반환한다
getReadOnly( ): 현재 설정되어있는 readOnly 속성값을 반환한다
getSelectedIndex( ): 선택된 노드의 index(초기 로딩시 설정 된 값)를 반환한다.
getSelectedLabel( ): 선택된 노드의 label을 반환한다.
getSelectedNode( ): 선택된 노드객체를 반환한다.
getSelectedValue( ): 선택된 노드의 value를 반환한다.
getSize( sizeName ): 컴포넌트의 크기 값을 반환합니다
getStyle( propertyName ): 컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다
getStyleValue( style ): [deprecated]getStyle로 사용.
getTitle( ): title 속성값을 반환한다
getUserData( key ): setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
getXPathByValue( value ): value에 해당하는 노드의 XPath를 반환한다.
hasClass( className ): 컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다
hide( ): 컴포넌트를 화면에서 보이지 않도록 숨긴다.
isLeaf( ): 선택된 노드가 leaf인지(자식노드가 없는지)의 여부를 반환한다
isOpen( index ): 초기에 각 노드에 설정된 index를 기반으로 해당 index에 상응하는 노드가 열려있는지 닫혀있는지 여부를 반환한다.
moveNode( srcIndex , destIndex , bAppendChild ): srcIndex에 해당하는 노드 및 자식 노드들을 destIndex에 해당하는 노드의 동일레벨 또는 자식 노드가 되도록 노드를 이동시킨다.
notifyDataChanged( ): treeview와 dataList를 전체적으로 동기화한다
removeClass( className ): 컴포넌트에 className의 class를 삭제한다.
removeNode( node ): 노드 객체를 기반으로 노드(자식노드 포함)를 삭제한다
removeNodeList( nodeList ): 노드 객체를 기반으로 다건의 노드(자식노드 포함)를 삭제한다.
setCustomFormatter( userFunction ): 사용자가 지정한 함수를 treeview의 node를 돌면서 각각 한번씩 호출합니다
setEventPause( evList , flag ): 컴포넌트의 이벤트를 disable 또는 enable시킨다
setLabelByIndex( index , label ): 노드의 index를 기반으로 label을 변경한다.
setLabelByValue( value , label ): 노드의 value를 기반으로 label을 변경한다
setLabelStyle( index , styleName , styleValue , applyChildNodes ): 해당 node의 label style(node의 글자색, 글자크기, 글꼴 등)을 변경합니다
setNodeSet( nodeset , columnInfo ): treeView와 연동된 dataList를 다른 dataList로 변경한다
setOpacity( value ): 컴포넌트의 CSS Opacity(불투명도)값를 설정한다
setPosition( left , top , mode ): 컴포넌트의 위치(left,top)를 설정한다
setReadOnly( readOnly ): readOnly 속성값을 설정한다
setSize( width , heigth ): 컴포넌트의 크기(width,height)를 설정한다
setStyle( propertyName , value ): 컴포넌트의 property별 style을 설정한다
setUserData( key , value ): 컴포넌트에 사용자 데이터를 설정한다
setValueByIndex( index , value ): 노드의 index 기반으로 value을 변경한다
show( displayType ): 컴포넌트를 화면에 보이도록 설정한다.
spanAll( openCloseFlag ): openCloseFlag에 따라서 모든 자식 노드를 span시켜 준다
spanNode( nodeIndex , openCloseFlag , applyChildNodes ): 옵션에 해당하는 node를 span시켜 준다
toggleClass( className ): 컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
trigger( type , array ): 컴포넌트에 등록 된 특정 이벤트를 발생시킨다
unbind( type , function ): 컴포넌트에 등록 된 이벤트를 제거한다
visible( flag ): [deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.

Property Detail

accessibility: [true,false]웹접근성 모드의 사용 여부로 true로 설정할 경우 각 노드의 line은 그려지지 않으며 aria-expanded와 같은 HTML 속성들이 추가된다.
alwaysDraw: [default:false, true]초기에 child 노드를 전부 표현할지의 여부로 true이면 화면 로딩시 child를 모두 그리고 false이면 노드의 Depth가 showTreeDepth속성의 값보다 작은 노드만 먼저 그린다.
checkAllChildNodes: [default:false, true]부모노드를 체크하면 자식노드도 모두 체크할지의 여부
checkboxDisabledFalseValue: 체크박스의 disabled여부의 false값으로 기본적으로 checkbox의 ref 및 checkboxDisabled의 ref가 설정되어야 동작한다.
checkboxDisabledTrueValue: 체크박스의 disabled여부의 true값으로 기본적으로 checkbox의 ref 및 checkboxDisabled의 ref가 설정되어야 동작한다.
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
기본적으로 엔진 내부에서 컴포넌트별로 class를 적용하고 있으며 해당 class를 이용하여 컴포넌트의 css를 공통으로 적용할 수 있다.
dataType: [default:recursive, listed]데이터의 포맷이 tree형태인지 list형태인지를 정의한다.
DataCollection으로 적용할 경우 listed로 설정한다.
defaultImage: 노드에 보여질 기본 아이콘의 이미지경로를 설정한다.
아이콘의 기본 크기 - width:18px, height:20px
disabled: disabled 유무
dynamicAppend: [true,false]동적 트리 추가 사용 여부.
escape: [true, false] <>&"를 HTML Escape 문자로 변환하여 화면에 표시한다.
expandedImage: 노드(폴더)가 확장되었을 때의 이미지 경로.
falseValue: chckbox의 false 값
hierarchy: [default:false, true]하위 노드가 선택되었을 때, 상위 노드를 체크할지 여부.
하위 노드 중 체크되지 않은 항목이 있는 경우, 상위 노드의 체크박스를 반투명하게 표시하며 showCheckbox 속성이 true일 경우 적용된다.
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다.
labelclass: 노드의 label에 적용할 class명
lineShow: [default:true, false]노드 사이에 선을 적용할 지의 여부
refreshCheckboxDisableModel: [default:false, true]checkbox의 disable이 변경된 경우 model영역(DataCollection, InstanceData)에 실시간 반영할지 여부
refreshCheckboxModel: [default:false, true]checkbox의 값이 변경된 경우 model영역(DataCollection, InstanceData)에 실시간 반영할지 여부
scrollFix: [default:false, true]노드를 click할 경우 포커스를 주지 않도록 하여 스크롤을 고정시킬지(true), 해당 노드에 포커스를 주어 스크롤이 움직이게 할지(false)의 여부.
showCheckbox: [default:false, true]노드에 checkbox의 표시 여부.
showTreeDepth: 초기 로딩시 확장되어 보여질 노드의 depth값
title: HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다.
toggleButtonEvent: [default:onclick, onmousedown]toggleButton(toggleImage)을 마우스로 클릭할 때 toggle할 것인지, 또는 마우스를 누르는 순간 바로 toggle될 것인지를 설정한다.
toggleEvent: [default:ondblclick, onclick, none]노드에 마우스 이벤트를 적용하여 리스트를 펼치고 접을 때의 적용하고자 하는 이벤트.
toolTip: 웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다. 마우스 over시 표현된다.
tooltipClass: tooltipDisplay속성에 true일 경우 해당 toolTip에 적용 할 class명
tooltipDisplay: [default:false, true]노드의 label이 화면에 다 보여지지 않을 경우 해당 label을 tooltip으로 표현할지의 여부
tooltipGroupClass: [default:true, false]tooltip에 w2group 스타일을 포함시킬지(true)의 여부.
tooltipTime: tooltipDisplay가 true일 경우 해당 tooltip이 보이는데 걸리는 초(second)
trueValue: checkbox의 true 값
useDrag: [default:false, true]drag의 사용여부
useHirarchySelect: [default:false, true] 하위 노드를 선택했을 때 상위 노드도 같이 선택할지의 여부.
userData1: 사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2: 사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3: 사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.

Event Detail

onchange

선택된 노드가 변경될 경우 발생한다.

Parameter
name	type	description
oldNode	node	이전 노드
newNode	node	현재 선택된 노드

Sample

ev:event="onchange(oldNode,newNode)" 로 인자가 정의된 경우, newNode.label , newNode.value를 통해 getSelectedLabel(), getSelectedValue()를 대체가능 Node에 모든정보가 담겨져있어 필요한정보만 가져다 쓰면됩니다.

oncheckboxclick

Checkbox가 클릭된 경우 발생

Parameter
name	type	description
value	String	클릭된 node의 value
nodeElement	Document	클릭된 node의 Element
index	String	클릭된 node의 index

Sample

ev:event="oncheckboxclick(value, nodeElement)" 로 인자가 정의된 경우, bag인 label의 checkbox를 클릭. var xmlStr = WebSquare.xml.indent(nodeElement); xmlStr의 예는 다음과 같다. <data> <label>bag</label> <value>2</value> <depth>1</depth> <chk>T</chk> <disableChk></disableChk> <img>images/bag.gif</img> </data> value는 2이다.

onclick

label, checkbox, icon, toggle버튼(+,-버튼)을 클릭했을 때 발생한다.

ondblclick

label을 더블클릭했을 때 발생한다

ondragleave

useDrag속성이 true이고 drag하는 도중에 마우스 위치가 노드의 순수 label영역(icon영역 미포함)을 벗어난 경우 발생한다.

Parameter
name	type	description
e	Object	이벤트(e)

ondragover

useDrag속성이 true이고 drag하는 도중에 마우스의 위치가 노드의 위에 있을 때 발생한다.

Parameter
name	type	description
dragNode	Object	drag중인 treeview의 node
dropNode	Object	dragover된 위치에 해당하는 treeview의 node
dragControl	Object	drag가 발생한 treeview component 객체. 일반적으로 dragControl = this;
dropControl	Object	drop된 위치에 해당하는 treeview component 객체.
e	Object	이벤트(e)

ondrop

useDrag속성이 true이고 다른 treeview의 노드가 drag되어 본 treeview의 노드 위에서 drop 되었을 때 발생한다.

Parameter
name	type	description
dragNode	Object	drag중인 treeview의 노드
dropNode	Object	drop된 위치에 해당하는 treeview의 노드
dragControl	TreeView	drag가 발생한 treeview 객체
dropControl	TreeView	drop된 위치에 해당하는 treeview 객체로 이벤트 안에서의 this와 같다
e	Object	이벤트(e)

Sample

//drag된 노드를 drop된 노드 하위로 추가하고 drag된 노드는 삭제할 경우 (useDrag속성을 true로 설정 후 로직을 구현한다) <script ev:event="ondrop(dragNode,dropNode,dragControl,dropControl,e)"type="javascript"><![CDATA[ //현재의 treeview에 drag된 노드 추가 this.appendNode(dropnode,dragnode); //this 대신 dropControl로 접근해도 된다 //drag가 발생한 treeview의 drag된 노드 삭제 dragControl.removeNode( dragnode ); ]]></script>

onimageclick

노드의 icon을 클릭한 경우 발생한다.

Parameter
name	type	description
value	String	클릭된 노드의 value
nodeElement	XML	클릭된 노드의 정보가 담긴 XML
index	String	클릭된 노드의 index 문자열

onlabelclick

노드의 label을 클릭한 경우 발생한다.

Parameter
name	type	description
value	String	클릭된 노드의 value
nodeElement	XML	클릭된 노드의 정보가 담긴 XML
index	String	클릭된 노드의 index 문자열

Sample

//아래와 같이 labelclick이벤트가 정의 된 경우의 arguments 예시 <script ev:event="onlabelclick(value,nodeElement,index)" type="javascript"><![CDATA[ //nodeElement 예시 ) <data index="3"> <label>bag</label> <value>2</value> <depth>1</depth> <chk>t</chk> <rowStatus statusValue="0">R</rowStatus> </data> //index의 return 예시 ) "3" ]]></script>

onrightbuttonclick

노드의 영역에서 마우스 오른쪽 버튼이 클릭된 경우 발생한다. 노드의 영역 범위는 label, 이미지(아이콘), 체크박스까지이다.

Parameter
name	type	description
node	Object	오른쪽버튼 클릭이 발생한 위치에 해당하는 node. 아래는 주요 정보들이다.
leftPosition	Number	click 된 마우스 좌표의 left(x)값
topPosition	Number	click 된 마우스 좌표의 top(y)값

ontoggleclick

toggle 이미지(아이콘)이 클릭된 경우 발생한다.

Parameter
name	type	description
nodeElement	Document	클릭된 노드의 정보가 담긴 XML
index	String	클릭된 노드의 index 문자열
isRendered	boolean	하위 노드의 렌더링 유무

Sample

//아래와 같이 toggleclick이벤트가 정의 된 경우의 arguments 예시 <script ev:event="ontoggleclick(nodeElement,index,isRendered)" type="javascript"><![CDATA[ //nodeElement 예시 ) <data index="2"> <depth>2</depth> <label>메뉴1-2</label> <value>menu1-2</value> <chk>f</chk> <rowStatus statusValue="0">R</rowStatus> <data index="3"> <depth>3</depth> <label>메뉴1-2-1</label> <value>menu1-2-1</value> <chk>f</chk> <rowStatus statusValue="0">R</rowStatus> </data> </data> //index의 return 예시 ) "3" //isRendered의 return 예시 ) true ]]></script>

onviewchange

treeview의 label, checkbox, icon, toggle버튼을 마우스나 키보드로 선택(클릭)했을 때만 발생하는 이벤트로 스크립트를 통해 변경된 경우에는 발생하지 않는다.

Parameter
name	type	description
info	JSON	oldNode, newNode를 포함한 JSON을 반환한다.

Sample

Method Detail

addClass( className )

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

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

Sample

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

appendData( index , xmlArray )

index에 해당하는 노드 하위에 사용자 데이터를 기반으로 노드를 추가한다.
dynamicAppend속성이 true로 설정되야한다.

Parameter
name	type	required	description
index	Number	Y	노드의 index
xmlArray	Array	Y	추가할 노드의 XML 데이터가 담긴 1차원 배열

Sample

//구현 샘플 : DataLiat를 정의하고 TreeView와 연동한 다음 appendData API를 이용하여 "즐겨찾기"노드의 하위에 XML 데이터를 기반으로 노드를 추가한다. //1. DataList 정의. <w2:dataList id="dc_favMenu" baseNode="list" style="" repeatNode="data" valueAttribute=""> <w2:columnInfo> <w2:column id="depth" name="depth" dataType="text"></w2:column> <w2:column id="label" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> <w2:column id="chk" name="체크박스" dataType="text"></w2:column> </w2:columnInfo> <w2:data xmlns="" use="true"> <w2:row> <depth><![CDATA[1]]></depth> <label><![CDATA[즐겨찾기]]></label> <value><![CDATA[menu00]]></value> <chk><![CDATA[f]]></chk> </w2:row> </w2:data> </w2:dataList> //2. TreeView 정의 (소스의 길이가 길어져서 필요 없는 속성 및 항목은 삭제함.) <w2:treeview dataType="listed" id="treeview1" refreshCheckboxModel="true" showCheckbox="true" dynamicAppend="true" trueValue="t" falseValue="f" style="position: relative;width: 200px;height: 400px;float:left;margin-right:10px;border:1px solid pink;"> <w2:itemset nodeset="data:dc_favMenu"> <w2:label ref="label"></w2:label> <w2:value ref="value"></w2:value> <w2:depth ref="depth"></w2:depth> <w2:checkbox ref="chk"></w2:checkbox> </w2:itemset> </w2:treeview> //3.appendData API로 노드 추가하기 //3.1 XML 문자열 정의- XML데이터는 DataList에 정의 된 Data구를 참조하여 생성한다. var tmpStr = "<list>"; tmpStr += "<data><depth>2</depth><label>메뉴1-1</label><value>menu1-1</value><chk>f</chk></data>"; tmpStr += "<data><depth>2</depth><label>메뉴1-2</label><value>menu1-2</value><chk>f</chk></data>"; tmpStr += "</list>"; //3.2 XML 생성 var tmpDoc = WebSquare.xml.parse(tmpStr); //3.3 appendData에 사용할 파라메터 (XML Array) 생성 var tmpDocArr = WebSquare.xml.findNodes(tmpDoc,"list/data"); //3.4 TreeView의 첫번째 노드에 추가. treeview1.appendData(1,tmpDocArr); //appendData 호출 이전의 Display 예시 ) - 즐겨찾기 //appendData 호출 후 Display 예시 ) -[-] 즐겨찾기 - └─ 메뉴1-1 - └─ 메뉴2-1

appendNode( parentNode , childNode )

TreeView에서 반환하는 Node를 기반으로 parentNode 하위에 childNode를 추가한다.
dynamicAppend속성이 true로 설정되야하며 일반적으로 TreeView끼리의 노드 추가 시에 사용되며 TreeView의 이벤트 또는 API로 Node를 반환 받아 파라메터로 사용한다.

Parameter
name	type	required	description
parentNode	Object	Y	기준 Node
childNode	Object	Y	추가할 Node

Sample

//샘플 예제 - 왼쪽 TreeView(treeview1)에서 항목(노드)을 Drag하여 오른쪽 TreeView(treeview2)의 항목(노드) 위에서 Drop하여 항목(노드)을 이동시킨다. //1. DataList와 임시 데이터 정의 - 왼쪽 트리뷰 : dc_menu , 오른쪽 트리뷰 - dc_favMenu <w2:dataList id="dc_menu" baseNode="list" repeatNode="data"> <w2:columnInfo> <w2:column id="depth" name="depth" dataType="text"></w2:column> <w2:column id="label" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> </w2:columnInfo> <w2:data xmlns="" use="true"> <w2:row> <depth><![CDATA[1]]></depth> <label><![CDATA[메뉴1]]></label> <value><![CDATA[menu1]]></value> </w2:row> <w2:row> <depth><![CDATA[2]]></depth> <label><![CDATA[메뉴1-1]]></label> <value><![CDATA[menu1-1]]></value> </w2:row> <w2:row> <depth><![CDATA[2]]></depth> <label><![CDATA[메뉴1-2]]></label> <value><![CDATA[menu1-2]]></value> </w2:row> <w2:row> <depth><![CDATA[3]]></depth> <label><![CDATA[메뉴1-2-1]]></label> <value><![CDATA[menu1-2-1]]></value> </w2:row> <w2:row> <depth><![CDATA[2]]></depth> <label><![CDATA[메뉴1-3]]></label> <value><![CDATA[menu1-3]]></value> </w2:row> <w2:row> <depth><![CDATA[1]]></depth> <label><![CDATA[메뉴2]]></label> <value><![CDATA[menu2]]></value> </w2:row> </w2:data> </w2:dataList> <w2:dataList id="dc_favMenu" baseNode="list" repeatNode="data"> <w2:columnInfo> <w2:column id="depth" name="depth" dataType="text"></w2:column> <w2:column id="label" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> </w2:columnInfo> <w2:data xmlns="" use="true"> <w2:row> <depth><![CDATA[1]]></depth> <label><![CDATA[즐겨찾기]]></label> <value><![CDATA[menu00]]></value> </w2:row> </w2:data> </w2:dataList> //2. TreeView 정의 //2.1 메뉴가 담길 왼쪽 TreeView로 Drag를 사용해야 함으로 userDrag 속성을 true로 설정 <w2:treeview dataType="listed" id="treeview1" useDrag="true" style="position: relative;width: 200px;height: 400px;float:left;margin-right:10px;border:1px solid orange;"> <w2:itemset nodeset="data:dc_menu"> <w2:label ref="label"></w2:label> <w2:value ref="value"></w2:value> <w2:depth ref="depth"></w2:depth> <w2:folder ref=""></w2:folder> <w2:checkbox ref=""></w2:checkbox> <w2:checkboxDisabled ref=""></w2:checkboxDisabled> <w2:image ref=""></w2:image> <w2:iconImage ref=""></w2:iconImage> <w2:selectedImage ref=""></w2:selectedImage> <w2:expandedImage ref=""></w2:expandedImage> <w2:leafImage ref=""></w2:leafImage> </w2:itemset> </w2:treeview> //2.2 메뉴가 추가 될 오른쪽 TreeView로 동적으로 노드를 추가해야하므로 dynamicAppend속성을 true로 설정. //2.3 항목(노드)위에서 Drop시 해당 항목 하위로 노드를 추가해야하므로 ondrop 이벤트 설정. <w2:treeview dataType="listed" id="treeview2" dynamicAppend="true" style="position: relative;width: 200px;height: 400px;float:left;margin-right:10px;border:1px solid pink;"> <w2:itemset nodeset="data:dc_favMenu"> <w2:label ref="label"></w2:label> <w2:value ref="value"></w2:value> <w2:depth ref="depth"></w2:depth> <w2:folder ref=""></w2:folder> <w2:checkbox ref=""></w2:checkbox> <w2:checkboxDisabled ref=""></w2:checkboxDisabled> <w2:image ref=""></w2:image> <w2:iconImage ref=""></w2:iconImage> <w2:selectedImage ref=""></w2:selectedImage> <w2:expandedImage ref=""></w2:expandedImage> <w2:leafImage ref=""></w2:leafImage> </w2:itemset> <script ev:event="ondrop(dragNode,dropNode,dragControl,dropControl,e)" type="javascript"><![CDATA[ //이벤트에서 넘어오는 dropNode와 dragNode를 이용하여 현재 컴포넌트에 노드 추가 //dropNode : drop 이벤트가 일어난 노드, dragNode : drag 되어 넘어온 노드 this.appendNode(dropNode,dragNode); //drag되어 넘어 온 노드를 drag된 컴포넌트에서 삭제 //dragNode : drag 된 노드, dragControl : drag가 일어난 컴포넌트로 treeview1 이다. dragControl.removeNode( dragNode ); ]]></script> </w2:treeview>

appendXmlNodes( parentNode , xmlArray )

TreeView에서 반환하는 Node(parentNode)의 하위에 XML 데이터를 기반으로 노드를 추가한다.
dynamicAppend속성이 true로 설정되야한다.

Parameter
name	type	required	description
parentNode	Object	Y	기준 Node
xmlArray	Array	Y	추가할 노드의 XML 데이터가 담긴 1차원 배열

Sample

//사용자가 선택한 TreeView의 항목(노드)에 XML 데이터를 기반으로 항목(노드)를 추가하기 //1. DataList 정의 <w2:dataList id="dc_favMenu" baseNode="list" repeatNode="data" valueAttribute=""> <w2:columnInfo> <w2:column id="depth" name="depth" dataType="text"></w2:column> <w2:column id="label" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> </w2:columnInfo> <w2:data xmlns="" use="true"> <w2:row> <depth><![CDATA[1]]></depth> <label><![CDATA[즐겨찾기]]></label> <value><![CDATA[menu00]]></value> </w2:row> </w2:data> </w2:dataList> //2. TreeView 정의 - 소스의 길이가 길어져서 필요 없는 속성 및 항목은 삭제함. //동적 노드(항목) 추가를 위해 dynamicAppend속성을 true로 설정. <w2:treeview dataType="listed" id="treeview1" dynamicAppend="true" style="position: relative;width: 200px;height: 400px;float:left;margin-right:10px;border:1px solid pink;"> <w2:itemset nodeset="data:dc_favMenu"> <w2:label ref="label"></w2:label> <w2:value ref="value"></w2:value> <w2:depth ref="depth"></w2:depth> </w2:itemset> </w2:treeview> //3. Script 영역에서 TreeView에 선택 된 노드 하위로 appendXmlNodes API를 호출하여 노드(항목)추가하기 //3.1 TreeView에서 선택 된 노드 얻기 var tmpPNode = treeview1.getSelectedNode(); //3.2 선택 된 노드가 없는 경우 alert. if(!tmpPNode){ alert("TreeView의 항목(노드)를 선택하세요"); return; } //3.3 추가할 XML 문자열 생성 var tmpStr = "<list>"; tmpStr += "<data><depth>2</depth><label>메뉴1-1</label><value>menu1-1</value><chk>f</chk></data>"; tmpStr += "<data><depth>2</depth><label>메뉴1-2</label><value>menu1-2</value><chk>f</chk></data>"; tmpStr += "</list>"; //3.4 XML 생성 var tmpDoc = WebSquare.xml.parse(tmpStr); //3.5 appendXmlNodes에 사용할 파라메터 (XML Array) 생성 var tmpDocArr = WebSquare.xml.findNodes(tmpDoc,"list/data"); //3.6 선택 된 노드에 추가. treeview1.appendXmlNodes( tmpPNode , tmpDocArr );

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

checkByIndex( value , checkValue , childCheck )

index를 기반으로 노드(항목)을 찾아 checkbox의 value를 설정한다.
trueValue, falseValue 속성의 값을 참조하여 check되며 해당 속성이 정의되지 않은 경우 각 true, false로 제어 가능하다.

Parameter
name	type	required	description
value	String	Y	대상 노드의 index
checkValue	Boolean\|\|String	Y	checkbox의 value ( trueValue와 falseValue 속성이 정의되지 않은 경우 true, false로 제어가능하다 )
childCheck	Boolean	N	선택한 노드의 자녀 노드의 checkbox check여부

Sample

//index가 1인 노드의 checkbox만 check한다. treeview1.checkByIndex( 1 , true); //index가 1인 노드와 하위 노드의 checkbox에 모두 check한다. treeview1.checkByIndex( 1 , true, true);

checkByValue( value , checkValue , childCheck )

value를 기반으로 노드(항목)을 찾아 checkbox의 value를 설정한다.
trueValue, falseValue 속성의 값을 참조하여 check되며 해당 속성이 정의되지 않은 경우 각 true, false로 제어 가능하다.

Parameter
name	type	required	description
value	String	Y	대상 노드의 value
checkValue	Boolean\|\|String	Y	checkbox의 value ( trueValue와 falseValue 속성이 정의되지 않은 경우 true, false로 제어가능하다 )
childCheck	Boolean	N	선택한 노드의 자녀 노드의 checkbox check여부

Sample

//"menu1-2" value를 가진 노드의 checkbox만 check한다. treeview1.checkByValue( "menu1-2" , true); //"menu1-2" value를 가진 노드와 하위 노드의 checkbox에 모두 check한다. treeview1.checkByValue( "menu1-2" , true, true);

collapseNode( value , hierarchy )

value 또는 index를 기반으로 찾은 노드(항목)를 접는다. index는 1부터 시작한다.

Parameter
name	type	required	description
value	String\|\|Number	Y	대상 노드의 value 또는 index (index는 1부터 시작한다.)
hierarchy	Boolean	N	자식 노드까지 적용할지의 여부

Sample

//첫번째 노드를 찾아 해당 노드만 접는다. treeview1.collapseNode( 1 , true); //value가 "menu1-2"인 노드를 찾아 해당 노드만 접는다. treeview1.collapseNode("menu1-2"); //value가 "menu1-2"인 노드를 찾아 해당 노드와 하위 노드를 접는다. treeview1.collapseNode("menu1-2" , true);

disableCheckboxByValue( value , checkDisabled , childDisalbed )

value를 기반으로 노드(항목)을 찾아 checkbox의 disabled를 설정한다.

Parameter
name	type	required	description
value	String	Y	대상 노드의 value
checkDisabled	Boolean	Y	checkbox의 disabled 적용 여부
childDisalbed	Boolean	N	자녀 노드까지의 적용 여부

Sample

//value가 "menu1"인 노드를 찾아 해당 노드만 checkbox를 disabeld 처리한다. treeview1.disableCheckboxByValue("menu1",true);
//value가 "menu1"인 노드를 찾아 해당 노드와 하위 노드의 checkbox를 disabeld 처리한다. treeview1.disableCheckboxByValue("menu1",true,true);

expandNode( value , hierarchy )

value 또는 index를 기반으로 찾은 노드(항목)를 확장한다. index는 1부터 시작한다.

Parameter
name	type	required	description
value	String\|\|Number	Y	value 대상 노드의 value 또는 index (index는 1부터 시작한다.)
hierarchy	Boolean	N	자식 노드까지 적용할지의 여부

Sample

//첫번째 노드를 찾아 해당 노드만 확장한다. treeview1.expandNode( 1 , true); //value가 "menu1-2"인 노드를 찾아 해당 노드만 확장한다. treeview1.expandNode("menu1-2"); //value가 "menu1-2"인 노드를 찾아 해당 노드와 하위 노드를 확장한다. treeview1.expandNode("menu1-2" , true);

findNodeByIndex( index , select )

초기에 각 노드에 설정된 index를 기반으로 노드 반환한다. 두번째 인자가 true인 경우 해당 노드를 선택한다.
index는 1부터 시작하며 로딩 후 노드의 순서가 변경되도 초기에 설정된 index로 접근해야 한다.

Parameter
name	type	required	description
index	String	Y	초기 로딩 시 할당 된 노드의 index
select	boolean	N	[default:true, false]노드를 선택 할지의 여부

Return
type	description
Node	검색된 Node

Sample

//로딩 후 노드의 이동이 없고 첫번째 노드를 선택 할 경우 var node1 = treeview1.findNodeByIndex(1); index가 1인 Node를 얻을 수 있다. var node1 = treeview1.findNodeByIndex(1, true); 위와 같이 두번째 인자에 true를 주면, index가 1인 Node를 선택함과 동시에 해당 Node를 얻을 수 있다.

findNodeByValue( value , select )

value를 기반으로 노드를 찾아서 해당 노드를 반환한다. 두번째 인자가 true인 경우 해당 노드를 선택한다.
반환 된 노드는 appendData, appendNode등의 API의 파라메터로 사용할 수 있다.

Parameter
name	type	required	description
value	String	Y	찾을 node의 value
select	boolean	N	[default:true, false]노드를 선택 할지의 여부

Return
type	description
Node	검색된 Node

Sample

treeview에서 clothes, bags, shoes의 value는 1,2,3 이고 outer, bottom, dress의 value는 1-1, 1-2, 1-3인 경우, clothes 라벨이 선택되어 있는 예. -[-] clothes - │ [+] outer - │ [+] bottom - │ └─ dress -[+] bags - └─ shoes var node = treeview1.findNodeByValue("1-2"); bottom 라벨의 Node를 얻을 수 있다. var node = treeview1.findNodeByValue("1-2", true); 위와 같이 두번째 인자에 true를 주면, bottom 라벨의 Node를 선택함과 동시에 해당 Node를 얻을 수 있다.

focus( )

컴포넌트에 focus를 준다.

getCheckedIndexes( options )

checkbox가 체크된 노드들의 index(초기 로딩시 설정)를 배열에 담아 반환한다.
로딩 후 노드의 순서가 변경되면 index가 화면에 보여지는 순서와 다르게 반환될 수 있다.

Parameter
name	type	required	description
options	JSON> options hierarchy를 포함한 JSON \| <Boolean> options.hierarchy		hierarchy를 포함한 JSON

Return
type	description
Array	체크된 노드들의 index가 담긴 배열

Sample

//1번째와 3번째 노드의 checkbox가 check된 경우 var tmpRs = treeview1.getCheckedIndexes(); //return 예시 )[1, 3]

getCheckedLabels( options )

checkbox가 체크된 노드들의 label을 배열에 담아 반환한다.

Parameter
name	type	required	description
options	JSON> options hierarchy를 포함한 JSON \| <Boolean> options.hierarchy		hierarchy를 포함한 JSON

Return
type	description
Array	체크된 노드들의 label가 담긴 배열

Sample

//1번째와 3번째 노드의 checkbox가 check되어 있고 각 노드의 label이 "Menu1", "Menu1-2"일 경우. var tmpRs = treeview1.getCheckedLabels(); //return 예시 ) ["Menu1", "Menu1-2"]

getCheckedNodes( options )

checkbox가 체크된 노드들을 배열에 담아 반환한다.
로딩 후 노드의 순서가 변경되면 index가 화면에 보여지는 순서와 다르게 반환될 수 있다.

Parameter
name	type	required	description
options	JSON> options hierarchy를 포함한 JSON \| <Boolean> options.hierarchy		hierarchy를 포함한 JSON

Return
type	description
Array	체크된 노드들이 담긴 배열

Sample

//1번째와 3번째 노드의 checkbox가 check된 경우 var tmpRs = treeview1.getCheckedNodes(); //return 예시 )1번째와 3번째 노드가 담긴 배열

getCheckedValues( options )

checkbox가 체크된 노드들의 value를 배열에 담아 반환한다.

Parameter
name	type	required	description
options	JSON> options hierarchy를 포함한 JSON \| <Boolean> options.hierarchy		hierarchy를 포함한 JSON

Return
type	description
Array	체크된 노드들의 value가 담긴 배열

Sample

//1번째와 3번째 노드의 checkbox가 check되어 있고 각 노드의 value이 "m1", "m1-2"일 경우. var tmpRs = treeview1.getCheckedValues(); //return 예시 ) ["m1", "m1-2"]

getChildData( value , hierarchy )

value에 해당하는 node의 자식의 data(model에 존재하는)를 반환합니다.

Parameter
name	type	required	description
value	String	Y	자식의 data를 반환할 node의 value
hierarchy	Boolean	N	모든 자식의 data를 가져올지의 여부

Return
type	description
Object	자식의 data를 가지고 있는 배열

Sample

treeview에서 clothes, bags, shoes의 value는 1,2,3 이고 outer, bottom, dress의 value는 1-1, 1-2, 1-3인 경우, -[-] clothes - │ [+] outer - │ [+] bottom - │ └─ dress -[+] bags - └─ shoes var returnDoc = treeview1.getChildData('1'); returnDoc.length는 3이다. WebSquare.xml.indent(returnDoc[0])은 다음과 같다. <data> <label>outer</label> <value>1-1</value> <depth>2</depth> <chk></chk> <excChk></excChk> <img></img> <folder>true</folder> </data>

getDataListInfo( )

바이딩된 데이터리스트 정보를 반환한다.

Return
type	description
Object:Y	dataList Info

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" }

getLastChildIndex( srcIndex )

srcIndex에 해당하는 노드의 최종자식노드(자식의 자식을 중첩 탐색)의 index를 반환한다.

Parameter
name	type	required	description
srcIndex	Number	Y	대상 노드의 index

Return
type	description
Number	최종자식노드의 index값

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"

getParentValue( value )

노드의 value를 기반으로 부모 노드를 찾아 value를 반환한다.
value로 검색 된 노드가 최상위 노드이거나 검색된 노드가 없을 경우 빈값(emptyString)을 반환한다.

Parameter
name	type	required	description
value	String	Y	노드의 value

Return
type	description
String	부모 노드의 vlaue

Sample

//최상위 노드의 value가 "m1"일 경우 var tmpRs = treeview1.getParentValue("menu1"); return 예시 ) "" //기준 노드의 값이 "m1-1"이고 부모 노드의 value가 "m1"일 경우 var tmpRs1 = treeview1.getParentValue("menu1"); return 예시 ) "m1"

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

getSelectedIndex( )

선택된 노드의 index(초기 로딩시 설정 된 값)를 반환한다.
로딩 후 노드의 순서가 변경되면 보여지는 노드의 순서와 index가 다를 수 있다.

Return
type	description
String	선택된 노드의 index(초기 로딩시 설정 된 값)

Sample

//최상위 노드가 선택된 경우 var tmpRs = treeview1.getSelectedIndex(); return 예시 ) 1 //선택된 노드가 없는 경우 var tmpRs1 = treeview1.getSelectedIndex(); return 예시 ) ""

getSelectedLabel( )

선택된 노드의 label을 반환한다.
선택된 노드가 없는 경우 빈값(emptyString)을 반환한다.

Return
type	description
String	선택된 노드의 label

Sample

//선택된 노드가 없는 경우 var tmpRs = treeview1.getSelectedLabel(); //return 예시 ) ""

getSelectedNode( )

선택된 노드객체를 반환한다.
반환된 노드는 appendNode, appendData등의 API에 파라메터로 사용가능하며 노드에 담긴 값을 통해 자식노드, 부모노드 등의 정보를 참조할 수 있다.

Return
type	description
Object	선택된 노드 - 주요 정보만 명시됨

Sample

//노드의 label이 "Menu1-2"인 노드가 선택된 경우 var tmpRs = treeview1.getSelectedNode(); //return 예시 - 주요정보만 명시 ) { index: 6, label: "Menu1-2", value: "m1-2", checkboxDisabled: false, checked: false, childNodes: Array[1], //노드 객체가 담긴 배열 depth: 2, folder: null, parentNode: WebSquare.collection.node //노드 객체 } //선택된 노드의 value값을 꺼내올 경우 var tmpValue = tmpRs.value; //return 예시 ) "m1-2" //선택된 노드의 부모노드의 value값을 꺼내올 경우 var tmpParent = tmpRs.parentNode; var tmpParentValue = tmpParent.value //return 예시 ) "m1"

getSelectedValue( )

선택된 노드의 value를 반환한다.
선택된 노드가 없는 경우 빈값(emptyString)을 반환한다.

Return
type	description
String	선택된 노드의 value

Sample

//선택된 노드가 없는 경우 var tmpRs = treeview1.getSelectedValue(); //return 예시 ) ""

getSize( sizeName )

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

Parameter
name	type	required	description
sizeName	String	Y	[height,innerHeight,outerHeight,outerMarginHeight,width,innerWidth,outerWidth,outerMarginWidth]크기 값의 종류. szieName별 계산 방법은 아래를 참고.

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"

getXPathByValue( value )

value에 해당하는 노드의 XPath를 반환한다.
본 기능은 데이터를 InstanceData로 연동하거나 XML로 데이터를 제어할 때 사용한다.
DataList와 연동된 경우 DataList의 baseNode와 repeatNode속성값을 참조하여 XPath를 반환한다.

Parameter
name	type	required	description
value	String	Y	노드의 value

Return
type	description
String	Xpath

Sample

//DataList와 연동된 경우의 반환값 확인하기 //1. DataList 정의 //baseNode 속성은 "list"로 repeatNode속성은 "map"으로 설정 <w2:dataList id="dc_menu" baseNode="list" repeatNode="map"> <w2:columnInfo> <w2:column id="depth" name="depth" dataType="text"></w2:column> <w2:column id="label" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> </w2:columnInfo> <w2:data xmlns="" use="true"> <w2:row> <depth><![CDATA[1]]></depth> <label><![CDATA[메뉴1]]></label> <value><![CDATA[menu1]]></value> </w2:row> <w2:row> <depth><![CDATA[2]]></depth> <label><![CDATA[메뉴1-1]]></label> <value><![CDATA[menu1-1]]></value> </w2:row> <w2:row> <depth><![CDATA[1]]></depth> <label><![CDATA[메뉴2]]></label> <value><![CDATA[menu2]]></value> </w2:row> </w2:data> </w2:dataList> //2. TreeView 정의 - 필요 없는 항목들은 삭제 처리 <w2:treeview dataType="listed" id="treeview1" style="position: relative;width: 200px;height: 400px;"> <w2:itemset nodeset="data:dc_menu"> <w2:label ref="label"></w2:label> <w2:value ref="value"></w2:value> <w2:depth ref="depth"></w2:depth> </w2:itemset> </w2:treeview> //value가 "menu1-1"인 노드의 XPath 꺼내오기 var tmpRs = treeview1.getXPathByValue("menu1-1"); //return 예시 ) "list/map[value='menu1-1']"

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

isLeaf( )

선택된 노드가 leaf인지(자식노드가 없는지)의 여부를 반환한다.

Return
type	description
boolean	[true,false]leaf인지의 여부

isOpen( index )

초기에 각 노드에 설정된 index를 기반으로 해당 index에 상응하는 노드가 열려있는지 닫혀있는지 여부를 반환한다.
자식 노드들이 보여져 있는 상태면 true를, 자식 노드들이 숨겨져 있는 상태면 false를 각각 리턴한다. 자식이 없는 노드의 경우 false를 리턴한다.

Parameter
name	type	required	description
index	String	Y	초기 로딩 시 할당 된 노드의 index

Return
type	description
Node	index에 해당하는 Node의 open 여부

Sample

//로딩 후 노드의 이동이 없고 첫번째 노드를 선택 할 경우 var node1 = treeview1.isOpen(1); index가 1인 Node의 open 여부를 얻을 수 있다.

moveNode( srcIndex , destIndex , bAppendChild )

srcIndex에 해당하는 노드 및 자식 노드들을 destIndex에 해당하는 노드의 동일레벨 또는 자식 노드가 되도록 노드를 이동시킨다.
treeview가 dataList와 연동된 경우에만 지원한다.

Parameter
name	type	required	description
srcIndex	Number	Y	옮길 대상이 되는 노드의 index
destIndex	Number	Y	옮길 위치 기준이 되는 노드의 index
bAppendChild	Boolean	N	노드를 붙일 때 자식 노드로 붙일지(true), 동일 레벨로 붙일지(false)에 대한 여부

notifyDataChanged( )

treeview와 dataList를 전체적으로 동기화한다.

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

removeNode( node )

노드 객체를 기반으로 노드(자식노드 포함)를 삭제한다.

Parameter
name	type	required	description
node	Object	Y	노드 객체

Sample

//선택된 노드를 삭제할 경우 var tmpObj = treeview1.getSelectedNode(); treeview1.removeNode(tmpObj); //노드의 value가 "m1-1"인 노드를 삭제할 경우 var tmpObj1 = treeview1.findNodeByValue("m1-1"); treeview1.removeNode(tmpObj1);

removeNodeList( nodeList )

노드 객체를 기반으로 다건의 노드(자식노드 포함)를 삭제한다.
삭제 후 컴포넌트를 다시 그리며 removeNode함수를 여러 번 호출하는 것보다 처리속도가 빠른다.

Parameter
name	type	required	description
nodeList	Array	Y	노드가 담긴 1차원 배열

setCustomFormatter( userFunction )

사용자가 지정한 함수를 treeview의 node를 돌면서 각각 한번씩 호출합니다.

Parameter
name	type	required	description
userFunction	Function	Y	초기에 세팅된 label값, formattedLabel, node를 각각 인자로 받아 formattedLabel 반환하는 사용자 함수

Sample

treeview에서 number, 1, 5, date, 20130530, 05302013, test, test0의 value는 "n0,n1,n2,d0,d1,d2,t0,t1" 이라고 할 때, -[-] number - │ [+] 1 - │ [+] 5 -[-] date - └─ [+] 20130530 - └─ [+] 05302013 -[-] test - └─ [+] test0 -[-] dummy number의 하위 노드는 빨간색, date의 하위 노드는 노란색, test의 하위 노드는 회색, 그 외는 녹색으로 스타일을 변경하고자 할 때는 아래와 같이 하면 된다. var myCustomFormatter = function(orgLabel, formattedLabel, node){ if(node.value.indexOf("n") >=0) { this.setLabelStyle(node.index, 'color', 'red', false);} else if(node.value.indexOf("d") >= 0) { this.setLabelStyle(node.index, 'color', 'yellow', false);} else if(node.value.indexOf("t") >= 0) { this.setLabelStyle(node.index, 'color', 'gray', false);} else { this.setLabelStyle(node.index, 'color', 'green', false);} return formattedLabel; } treeview1.setCustomFormatter(myCustomFormatter);

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 한다.

setLabelByIndex( index , label )

노드의 index를 기반으로 label을 변경한다.
index값은 초기 로딩 시 설정 된 노드의 index로 1부터 시작한다.

Parameter
name	type	required	description
index	Number	Y	노드의 index
label	String	Y	새로 설정할 label의 값

Sample

//노드의 위치가 변경되지 않은 최상위 노드의 label을 변경하고자 할 때 treeview1.setLabelByIndex(1,"즐겨찾기");

setLabelByValue( value , label )

노드의 value를 기반으로 label을 변경한다.

Parameter
name	type	required	description
value	String	Y	노드의 value
label	String	Y	새로 설정할 label의 값

Sample

//value가 "m1"인 노드의 label을 변경 treeview1.setLabelByValue("m1","즐겨찾기");

setLabelStyle( index , styleName , styleValue , applyChildNodes )

해당 node의 label style(node의 글자색, 글자크기, 글꼴 등)을 변경합니다.

Parameter
name	type	required	description
index	Number\|\|String	Y	노드의 index 또는 value
styleName	String	Y	style의 속성명
styleValue	String	Y	style 속성값
applyChildNodes	Boolean	N	[default:false, true]하위노드 적용 여부

Sample

//value가 "menu1-1"인 노드의 label의 글자색을 "orange"로 변경할 경우 treeview1.setLabelStyle( "menu1-1", "color", "orange" );

setNodeSet( nodeset , columnInfo )

treeView와 연동된 dataList를 다른 dataList로 변경한다.

Parameter
name	type	required	description
nodeset	String	Y	변경할 dataList id. "data:"을 prefix로 붙여야 한다.
columnInfo	JSON	N	label, value, depth, checkbox, folder 속성을 포함한 JSON 객체

setOpacity( value )

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

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

Sample

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

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

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

setValueByIndex( index , value )

노드의 index 기반으로 value을 변경한다.

Parameter
name	type	required	description
index	String	Y	노드의 index
value	String	Y	새로 설정할 value의 값

Sample

//index가 2인 노드의 value를 변경 treeview1.setValueByIndex(2,"즐겨찾기");

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

spanAll( openCloseFlag )

openCloseFlag에 따라서 모든 자식 노드를 span시켜 준다.

Parameter
name	type	required	description
openCloseFlag	boolean	Y	자식 노드를 접을지 확장할 지의 여부

Sample

//자식 노드들을 모두 접는다. treeview1.spanAll(false); //자식 노드들을 모두 확장한다. treeview1.spanAll(true);

spanNode( nodeIndex , openCloseFlag , applyChildNodes )

옵션에 해당하는 node를 span시켜 준다.

Parameter
name	type	required	description
nodeIndex	String	Y	노드의 index 혹은 depth. 5.0_1.2700B.20170714.195510 버전에서 depth를 지정하여 해당 depth의 모든 노드를 접거나 확장하는 기능 추가. 또한 {index:1} 혹은 {depth:1} 형식을 사용할 경우 applyChildNodes 속성을 두번째에 사용. 아래 예제 참고.
openCloseFlag	boolean	Y	노드를 접을지 확장할 지의 여부
applyChildNodes	boolean	Y	child 노드까지 같이 확장할 지의 여부

Sample

//nodeIndex 1에 해당하는 노드를 토글한다 treeview1.spanNode(1); //nodeIndex 1에 해당하는 노드를 접는다 treeview1.spanNode(1, false); //nodeIndex 1에 해당하는 노드를 확장한다 treeview1.spanNode(1, true); //nodeIndex 1에 해당하는 노드와 자식노드까지 접는다 treeview1.spanNode(1, false, true); //nodeIndex 1에 해당하는 노드와 자식노드까지 확장한다 treeview1.spanNode(1, true, true); //nodeDepth 2에 해당하는 노드를 토글한다. treeview1.spanNode({depth:2}); //nodeDepth 2에 해당하는 모든 노드를 접는다. treeview1.spanNode({depth:2}, false); //nodeDpeth 2에 해당하는 모든 노드와 각 노드의 자식까지 확장한다 treeview1.spanNode({depth:2, applyChildNodes:true}, true); //nodeIndex 1에 해당하는 노드와 자식 노드를 확장한다 treeview1.spanNode({index:1, applyChildNodes:true}, true);

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

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"을 설정)