WebSquare.uiplugin.autoComplete

SelectBox 컴포넌트의 확장 컴포넌트로 사용자가 입력한 값을 통해 항목을 나열해주는 기능을 제공하고 있다.
초성을 이용한 검색이 가능하며 interactionMode속성을 통해 사용자가 입력한 값을 실시간 서버 통신을 하여 항목을 나열하는 기능도 제공된다.
본 컴포넌트는 최상위에는 div Tag로, 하위에는 복합 Tag를 이용하여 표현하고 있다.

Type

uiplugin

Property Summary

allOption: override 후 제거될 예정입니다
allowEmptySubmission: [default:false, true]interactionMode속성이 true 일 경우 빈 문자열의 검색 허용 유무
animation: [default: "", show, fadeIn, slideDown] itemtable의 animation을 설정한다. 각각의 세부내용은 아래와 같다.
caseSensitive: [default:true, false]검색 시 영문 대소문자 구분 여부
chooseOption: [default:false,true] 선택항목 표시 여부로 chooseOptionLabel속성이 설정되어 있지 않으면 label은 "-선택-"으로 value는 ""(empty string)으로 설정된다
chooseOptionLabel: chooseOption속성이 true로 설정 된 경우 label에 표현 될 text를 정의 한다
chooseOptionValue: 선택옵션 value
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
closeonmouseleave: [default:false, true] subLayer open되어 있을때, mouseleave 이벤트에 의해 닫을지 여부
delimiter: displayMode속성에서 참조하고 있으며 value와 label을 함께 표현 할 때 사용하는 구분자이다.
direction: [defulat:auto, down, up, fit]항목의 열림 방향
disabled: 컴포넌트에 비활성 여부
disableEdit: [default:false, true] click했을 때 edit모드로 진입하고 목록만 나타나도록 할지 여부
displayFormatter: 컴포넌트의 value를 이용하여 사용자 format을 정의할 수 있는 기능으로 format을 정의한 function의 이름을 명시한다.
displayMode: [default:label, value delim label, label delim value] 항목의 표현 방법으로 label과 value를 함께 표현 할 수 있다
editModeEvent: [default:onclick, onfocus] 수정모드로 변경할 이벤트를 설정한다
editType: [default:select, focus] 사용자가 컴포넌트를 클릭하여 input에 포커스가 발생했을 때 선택된 Text를 selection할지(select), Text의 맨 끝으로 커서를 이동(focus)할 지를 설정한다
emptyIndex: 처음 autoComplete를 그릴 때 선택하게 할 아이템의 인덱스.
emptyItem: [default:false, true] 항목에 없는 value나 index가 설정되는 경우(setValue, setSelectedIndex와 같은 API로 설정) 빈 label과 빈 value(empty string)로 설정 할지에 대한 여부.
emptyValue: emptyItem속성이 true로 설정 된 경우 본 속성의 값으로 value를 설정한다.
escape: [default:false, true] <>&"를 HTML Escape 문자로 변환하여 화면에 표시한다
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다
interactionEnterKey: [default:false, true] interactionMode = "true"인 경우, 입력창에 값을 입력 후 enter 키를 눌렀을 때만
interactionMode: [default:false, true] 사용자가 입력한 값에 따라 항목을 생성할지의 여부
keyInputRef: interactionMode속성이 true일 때 적용되며 검색 값을 InstanceData에 연동하고자 할때의 XPath로 지정된 경로하위에 key노드가 생성되며 해당 노드에 값이 담긴다.
mandatory: [default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부
nextTabID: tab으로 이동시 이동할 컴포넌트 ID
noResult: [default:previous, clear, noEnd, useData, first] 사용자가 입력한 값에 대한 검색결과가 없을때 화면에 표현할 Text의 처리방식.
noResultFirstItem: [default:false, true] ref를 통해 dataCollection과 바인딩되고 noResult="first" 속성이 설정된 경우, 첫번째 로딩시 첫번째 값을 선택해서 표시.
preventWheelEvent: [default:false, true] autoComplete에서 mouseWheelEvent를 발생시키지 않습니다
readOnly: [default:false, true]autoComplete를 readOnly로 사용할 지의 여부
ref: autoComplete 초기값을 model이나 dataCollection과 연동할 시에 사용하는 옵션
search: [default:start, contain, none] interactionMode속성이 false일 때의 사용자가 입력한 값에 대한 검색 모드.
searchTarget: [default:label, value, both] 사용자의 입력 값을 기반으로 선택대상항목을 제안하기 위해 검색할 대상.
selectedData: [default:true, false] 선택한 값이 바인딩된 DataList의 목록에 없을 경우 선택한 값 유지 여부.
sortMethod: [ascending,descending] 항목의 정렬 방법으로 sortOption속성이 정의된 경우만 동작된다
sortOption: [label,value] 정렬의 기준이 될 값
submenuSize: [default:fixed, auto] 목록(항목)창 크기를 label에 맞출지 기본 width로 고정 할지에 대한 설정
submission: interactioMode속성이 true일 때, 호출할 submission의 ID.
submissionFunc: interactioMode가 true일 때, 호출할 Function명.
tabIndex: Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다
textAlign: [default:center, left, right] 항목의 text 정렬 방법
title: HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다
tooltipClass: tooltipDisplay속성의 값이 true일 때, tooltip에 적용 할 class명
tooltipDisplay: [default:false, true] 선택된 값에 대한 tooltip 표현여부
tooltipTime: tooltipDisplay속성의 값이 true일 때, tooltip이 보이는데 걸리는 초(second)
type: [default:text] html의 type 속성과 동일한 기능으로 동작됨
useKeywordHighlight: [default:false, true] 검색된 항목중 keyword에 별도의 class를 적용할 지의 여부.
useMousewheel: [default:true, false]label위에서 마우스 wheel 동작 사용 유무
userData1: 사용자 정의 데이터 속성
userData2: 사용자 정의 데이터 속성
userData3: 사용자 정의 데이터 속성
visibleRowNum: 목록을 펼쳤을 때 보여줄 row의 수를 설정한다
wmode: [default:false, true] wmode 사용 여부로 항목이 object(activeX 또는 flash)에 가려 질 경우 해당 속성을 사용한다.

Event Summary

onafteredit: value(선택된 값)가 변경되었을 경우 값 변경 처리가 완전히 끝난 뒤에 발생한다
onchange: value(선택된 값)가 변경되었을 경우 발생한다
onitemclick: itemTable의 아이템이 클릭됐을 때 발생한다
ontoggleclick: toggle버튼(▼)이 클릭된 경우 발생한다
onviewchange: value의 값이 사용자가 입력하거나 키보드 또는 마우스 조작을 통해 변경된 경우에만 발생한다.

Method Summary

addClass( className ): 컴포넌트에 CSS class를 추가
addItem( label , value , nodest , index ): 목록에 뿌려진 항목을 추가한다
bind( eventType , function ): 컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당
changeChooseOption( newValue , newLabel ): chooseOption의 label과 value의 값을 변경한다
changeClass( oldClassName , newClassName ): 웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
disableEdit( onoff ): click했을 때, edit상태로 변경되지 않지만 item목록들은 나타나서 선택 가능함
focus( ): 웹스퀘어 컴포넌트에 포커스를 줌
getDataListInfo( ): autocomplete에 바인딩되어 있는 dataList를 반환합니다
getDisabled( ): 현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환
getGenerator( ): 컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환
getID( ): 웹스퀘어 컴포넌트의 ID를 반환
getInitStyle( CSS ): 웹스퀘어 컴포넌트의 초기 스타일을 반환
getItem( index ): index에 해당하는 항목의 정보가 담긴 객체를 반환한다
getItemCount( ): 항목의 개수
getNextTabID( ): nextTabID 옵션값을 반환한다
getOpacity( ): 웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
getOriginalID( ): 웹스퀘어 컴포넌트의 originalID를 반환. (웹스퀘어 컴포넌트 공통.)
getPluginName( ): 웹스퀘어 컴포넌트의 이름(pluginName)을 반환
getPosition( positionName ): 웹스퀘어 컴포넌트의 위치(left, top)를 반환
getReadOnly( ): 현재 웹스퀘어 컴포넌트에 설정된 readOnly 속성 값을 반환
getScope( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getScopeWindow( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getSearchedItems( ): 검색된 목록의 모든 항목들을 배열로 반환한다
getSelectedIndex( ): 선택된 항목의 index를 반환한다.
getSelectedRow( ): 선택된 항목의 정보가 담긴 객체를 반환한다.
getSize( sizeName ): 웹스퀘어 컴포넌트의 크기(width, height)를 설정
getStyle( propertyName ): 웹스퀘어 컴포넌트의 CSS 속성 값을 반환
getStyleValue( style ): [deprecated]
getText( isOriginal ): 선택된 항목의 label을 반환한다
getTitle( ): 컴포넌트의 title 속성 값을 반환
getUdcHome( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 파일명을 포함해서 반환. (웹스퀘어 컴포넌트 공통.)
getUdcRoot( ): UDC 객체가 자신을 정의한 UDC 파일 경로를 반환. (웹스퀘어 컴포넌트 공통.)
getUserData( key ): setUserData로 웹스퀘어 컴포넌트에 설정한 key의 value 혹은 사용자가 직접 페이지 소스(XML)에 속성으로 정의한 value를 반환
getValue( ): 현재 선택된 항목의 value값을 반환한다
hasClass( className ): 웹스퀘어 컴포넌트가 특정 class를 포함하고 있는지 확인
hide( ): 컴포넌트를 화면에서 보이지 않도록 숨깁니다
initAutoComplete( ): autoCompelete을 초기화한다
openTable( ): 항목창을 연다.
removeClass( className ): 웹스퀘어 컴포넌트에서 class를 삭제.(웹스퀘어 컴포넌트 공통.)
setDisabled( disabled ): 웹스퀘어 컴포넌트의 disabled 속성을 설정
setDummyData( value , label ): 항목에 나열된 값이 아닌 임의의 값을 설정(value와 label)한다.
setEditMode( ): 입력창(input)에 foucs를 준다
setEventPause( evList , flag ): 지정한 이벤트를 중단함
setGridItemset( obj ): gridViewItemset을 동적으로 변경한다
setInitStyle( property ): 웹스퀘어 컴포넌트의 초기 스타일을 복구
setItem( label , value , nodest , index ): itemTable의 index번째 항목의 label과 value을 변경한다
setItemSet( nodeset , label , value ): 항목의 itemset을 설정한다
setMaxLength( maxlength ): maxlength를 동적으로 설정합니다
setNextTabID( componentID , componentScope ): nextTabID 옵션값을 설정합니다
setNodeSet( nodeset , label , value ): 항목의 itemset 설정을 변경하는 기능으로 DataList와 연동 할 경우 nodeset 파라메터에 "data:" prefix를 꼭 붙여야한다
setOpacity( value ): 웹스퀘어 컴포넌트의 불투명도를 설정. (웹스퀘어 컴포넌트 공통.)
setPosition( left , top , mode ): 웹스퀘어 컴포넌트의 위치(left, top)를 설정
setReadOnly( readOnly ): 웹스퀘어 컴포넌트의 readOnly 속성을 설정
setRef( ref ): 바인딩 된 ref 경로를 동적으로 변경합니다
setSize( width , height ): 웹스퀘어 컴포넌트의 크기(width, height)를 설정
setStyle( propertyName , value ): 컴포넌트의 propertyName에 해당하는 style의 값을 설정합니다
setText( label , isOriginal ): 인자로 넘겨진 label과 같은 label을 가지는 항목을 선택한다
setTitle( title ): 컴포넌트의 title속성을 설정한다
setUserData( key , value ): 웹스퀘어 컴포넌트에 임의의 데이터를 설정
setValue( value ): 인자로 넘겨진 value와 같은 값을 가진 항목을 선택한다
show( displayType ): 웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
toggleClass( className ): 웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
trigger( type , array ): 컴포넌트에서 특정 이벤트를 발생시킴
unbind( type , function ): 컴포넌트에서 이벤트를 제거
unbindRef( ): ref 바인딩을 해제합니다
validate( ): autoComplete의 validate를 체크합니다
validateObject( ): 컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
visible( flag ): [deprecated]

Property Detail

allOption: override 후 제거될 예정입니다.
allowEmptySubmission: [default:false, true]interactionMode속성이 true 일 경우 빈 문자열의 검색 허용 유무
animation: [default: "", show, fadeIn, slideDown] itemtable의 animation을 설정한다. 각각의 세부내용은 아래와 같다.
기본값 : 전체 내역이 한번에 보여진다.
show : 한 점에서 퍼지면서 내역이 보여진다.
fadeIn : 전체가 점점 선명하게 내역이 보여진다.
slideDown : 하위로 내려오면서 순차적으로 보여진다.
caseSensitive: [default:true, false]검색 시 영문 대소문자 구분 여부
chooseOption: [default:false,true] 선택항목 표시 여부로 chooseOptionLabel속성이 설정되어 있지 않으면 label은 "-선택-"으로 value는 ""(empty string)으로 설정된다.
chooseOptionLabel: chooseOption속성이 true로 설정 된 경우 label에 표현 될 text를 정의 한다.
chooseOptionValue: 선택옵션 value
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
기본적으로 엔진 내부에서 컴포넌트별로 class를 적용하고 있으며 해당 class를 이용하여 컴포넌트의 css를 공통으로 적용할 수 있다.
closeonmouseleave: [default:false, true] subLayer open되어 있을때, mouseleave 이벤트에 의해 닫을지 여부
delimiter: displayMode속성에서 참조하고 있으며 value와 label을 함께 표현 할 때 사용하는 구분자이다.
displayMode속성의 "delim"에 해당하는 값이 본 속성에 정의 된 값이다.
direction: [defulat:auto, down, up, fit]항목의 열림 방향.
disabled: 컴포넌트에 비활성 여부
disableEdit: [default:false, true] click했을 때 edit모드로 진입하고 목록만 나타나도록 할지 여부
displayFormatter: 컴포넌트의 value를 이용하여 사용자 format을 정의할 수 있는 기능으로 format을 정의한 function의 이름을 명시한다.
정의한 function에서는 엔진에서 파라메터로 넘겨준 value에 format을 적용한 뒤 화면에 표현할 최종 값을 return 한다.
displayMode: [default:label, value delim label, label delim value] 항목의 표현 방법으로 label과 value를 함께 표현 할 수 있다.delim(구분자)는 delimiter속성에 정의 된 값을 참조한다.
editModeEvent: [default:onclick, onfocus] 수정모드로 변경할 이벤트를 설정한다.
editType: [default:select, focus] 사용자가 컴포넌트를 클릭하여 input에 포커스가 발생했을 때 선택된 Text를 selection할지(select), Text의 맨 끝으로 커서를 이동(focus)할 지를 설정한다.
emptyIndex: 처음 autoComplete를 그릴 때 선택하게 할 아이템의 인덱스.
emptyItem 속성을 true로 주고, emptyIndex 속성을 -1 값으로 주면 초기로딩시 빈 값을 선택하게 할 수 있다.
emptyItem: [default:false, true] 항목에 없는 value나 index가 설정되는 경우(setValue, setSelectedIndex와 같은 API로 설정) 빈 label과 빈 value(empty string)로 설정 할지에 대한 여부.
별도의 value를 설정하고자 할 때는 emptyValue속성을 이용하며 빈 value가 설정된 상태에서 item이 추가되거나 삭제되면 첫번째 항목이 선택된다.(HTML select에서 selectedIndex=-1 기능)
주의 사항으로 chooseOption속성이 true일 경우에도 label은 ""(empty string)으로 표현된다.
emptyValue: emptyItem속성이 true로 설정 된 경우 본 속성의 값으로 value를 설정한다.
주의 사항으로 emptyValue에 정의 된 값이 항목의 value와 동일하더라도 label은 ""으로 표현된다.
escape: [default:false, true] <>&"를 HTML Escape 문자로 변환하여 화면에 표시한다.
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다.
interactionEnterKey: [default:false, true] interactionMode = "true"인 경우, 입력창에 값을 입력 후 enter 키를 눌렀을 때만
submission이 실행되도록 설정. interactionKey = "all" 인 경우에는 동작하지 않음.
interactionMode: [default:false, true] 사용자가 입력한 값에 따라 항목을 생성할지의 여부.
keyInputRef: interactionMode속성이 true일 때 적용되며 검색 값을 InstanceData에 연동하고자 할때의 XPath로 지정된 경로하위에 key노드가 생성되며 해당 노드에 값이 담긴다.
예시 )keyInputRef="req/search" 일 때, 검색어
mandatory: [default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부.
nextTabID: tab으로 이동시 이동할 컴포넌트 ID
noResult: [default:previous, clear, noEnd, useData, first] 사용자가 입력한 값에 대한 검색결과가 없을때 화면에 표현할 Text의 처리방식.
previous:이전 결과값 표현(interactionMode속성이 false일 때만 적용가능), clear:입력값 삭제, noEnd:editMode 유지, useData:입력값을 표현, first:조회된 항목 중 첫번째 데이터를 표현
noResultFirstItem: [default:false, true] ref를 통해 dataCollection과 바인딩되고 noResult="first" 속성이 설정된 경우, 첫번째 로딩시 첫번째 값을 선택해서 표시.
true: 첫번째 항목을 선택.
false (기본 값): 첫번째 항목을 선택하지 않음.
preventWheelEvent: [default:false, true] autoComplete에서 mouseWheelEvent를 발생시키지 않습니다.
readOnly: [default:false, true]autoComplete를 readOnly로 사용할 지의 여부.
ref: autoComplete 초기값을 model이나 dataCollection과 연동할 시에 사용하는 옵션
search: [default:start, contain, none] interactionMode속성이 false일 때의 사용자가 입력한 값에 대한 검색 모드.
start:입력값과 항목의 시작과 같을 경우만, contain:입력값이 항목 어디든 속해 있는 경우, none:입력값이 항목과 완전히 같은 경우만.
searchTarget: [default:label, value, both] 사용자의 입력 값을 기반으로 선택대상항목을 제안하기 위해 검색할 대상.
label (기본 값): label 검색
value: value 검색
both: label과 value 모두 검색.
selectedData: [default:true, false] 선택한 값이 바인딩된 DataList의 목록에 없을 경우 선택한 값 유지 여부.
true (기본 값): 선택 값을 무시하고 이전 값 유지.
false: 선택 값 유지.
sortMethod: [ascending,descending] 항목의 정렬 방법으로 sortOption속성이 정의된 경우만 동작된다.
sortOption: [label,value] 정렬의 기준이 될 값
submenuSize: [default:fixed, auto] 목록(항목)창 크기를 label에 맞출지 기본 width로 고정 할지에 대한 설정.
submission: interactioMode속성이 true일 때, 호출할 submission의 ID.
submissionFunc속성과 동시사용이 불가하며(submissionFunc가 실행) inkeractionKey속성의 값에 따라 submisison의 실행된다.
submissionFunc: interactioMode가 true일 때, 호출할 Function명.
submissionFunc속성과 동시사용이 불가하며(submissionFunc가 실행) inkeractionKey속성의 값에 따라 function이 호출된다.
tabIndex: Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다.
textAlign: [default:center, left, right] 항목의 text 정렬 방법.
title: HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다. 일반적으로 웹접근성 작업 시 설정한다.
tooltipClass: tooltipDisplay속성의 값이 true일 때, tooltip에 적용 할 class명.
tooltipDisplay: [default:false, true] 선택된 값에 대한 tooltip 표현여부.
tooltipTime: tooltipDisplay속성의 값이 true일 때, tooltip이 보이는데 걸리는 초(second)
type: [default:text] html의 type 속성과 동일한 기능으로 동작됨.
useKeywordHighlight: [default:false, true] 검색된 항목중 keyword에 별도의 class를 적용할 지의 여부.
true: 검색된 키워드에 "w2autoComplete_keyword" class를 적용.
false (기본 값): 적용하지 않음.
useMousewheel: [default:true, false]label위에서 마우스 wheel 동작 사용 유무
userData1: 사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2: 사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3: 사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.
visibleRowNum: 목록을 펼쳤을 때 보여줄 row의 수를 설정한다.
wmode: [default:false, true] wmode 사용 여부로 항목이 object(activeX 또는 flash)에 가려 질 경우 해당 속성을 사용한다.
wmode가 true이면 object 태그보다 상위에 보이도록 하는 설정으로 본 컴포넌트에 wmode를 설정하는 것이 아닌 object(activeX, flash 등)태그의 wmode를 사용하는 것을 권장한다.

Event Detail

onafteredit

value(선택된 값)가 변경되었을 경우 값 변경 처리가 완전히 끝난 뒤에 발생한다.

onchange

value(선택된 값)가 변경되었을 경우 발생한다.

onitemclick

itemTable의 아이템이 클릭됐을 때 발생한다.

Parameter
name	type	description
클릭된	number	아이템의 index

ontoggleclick

toggle버튼(▼)이 클릭된 경우 발생한다.

Parameter
name	type	description
isOpen	boolean	이벤트가 발생하기 전에 아이템목록이 펼쳐졌는지에 대한 여부

onviewchange

value의 값이 사용자가 입력하거나 키보드 또는 마우스 조작을 통해 변경된 경우에만 발생한다.
스크립트를 통해 값이 변경된 경우에는 해당 이벤트가 발생하지 않는다. (native onchange 이벤트와 유사합니다.)

Parameter
name	type	description
info	Object	이전 선택값과 현재 선택된 값의 정보를 담고있는 객체.

Sample

Method Detail

addClass( className )

컴포넌트에 CSS class를 추가. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
className	String	Y	추가할 class의 이름

Sample

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

addItem( label , value , nodest , index )

목록에 뿌려진 항목을 추가한다.

Parameter
name	type	required	description
label	String	Y	항목의 label 값
value	String	Y	항목의 value 값
nodest	Element	Y	항목의 nodeset 값
index	Number	N	항목의 index 값

Return
type	description
Boolean	addItem 성공 여부. false 리턴시 addItem을 수행하지 않음.

Sample

추가할 아이템의 예: label은 책제목 , value는 isbn이며, 괄호()로 구분된다. 금토일 해외여행 (9788959136315) var returnValue = autoComplete1.addItem("금토일 해외여행","9788959136315"); 아이템 리스트의 마지막에 '금토일 해외여행' 책제목이 추가된다.

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

changeChooseOption( newValue , newLabel )

chooseOption의 label과 value의 값을 변경한다.

Parameter
name	type	required	description
newValue	String	Y	변경할 chooseOption의 value 값
newLabel	String	Y	변경할 chooseOption의 label 값

Sample

value "0", label "선택"으로 변경 autoComplete1.changeChooseOption("0","선택");

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

disableEdit( onoff )

click했을 때, edit상태로 변경되지 않지만 item목록들은 나타나서 선택 가능함

Parameter
name	type	required	description
onoff	Boolean	Y	edit상태 변경에 대한 설정 값

focus( )

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

getDataListInfo( )

autocomplete에 바인딩되어 있는 dataList를 반환합니다.

Return
type	description
Object:Y	nodeset, label, value id를 객체로 반환

Sample

autoComplete1.getDataListInfo();

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

getItem( index )

index에 해당하는 항목의 정보가 담긴 객체를 반환한다.

Parameter
name	type	required	description
index	Number	Y	항목의 index 값

Return
type	description
JSON	항목의 정보가 담긴 객체

Sample

//아래와 같이 DataList 정의 <w2:dataList baseNode="list" id="dc_tmpList"> <w2:columnInfo> <w2:column id="country" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> </w2:columnInfo> <w2:data use="true"> <w2:row> <country><![CDATA[네덜란드]]></country> <value><![CDATA[0016]]></value> </w2:row> <w2:row> <country><![CDATA[대한민국]]></country> <value><![CDATA[0022]]></value> </w2:row> <w2:row> <country><![CDATA[덴마크]]></country> <value><![CDATA[0023]]></value> </w2:row> </w2:data> </w2:dataList> //AutoComplete 정의 - dc_tmpList와 항목 연동 //항목에 label과 value를 함께 표현하기 위해 displayMode의 속성값을 "label delim value", delimiter속성 값을 "::"로 설정. <w2:autoComplete id="autoComplete1" style="position: relative;width:126px;height:21px;margin-right:10px;" displayMode="label delim value" delimiter="::" submenuSize="auto"> <w2:choices> <w2:itemset nodeset="data:dc_tmpList"> <w2:label ref="country"></w2:label> <w2:value ref="value"></w2:value> </w2:itemset> </w2:choices> </w2:autoComplete> //getItem 호출 - 1번째 항목을 꺼내옴 var tmpObj = autoComplete1.getItem(0) //return 예시 ) { "label":"네덜란드::0016", "value":"0026", "orgLabel":"네덜란드" }

getItemCount( )

항목의 개수

getNextTabID( )

nextTabID 옵션값을 반환한다.

Sample

var nextTabID = autoComplete1.getNextTabID();

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

getSearchedItems( )

검색된 목록의 모든 항목들을 배열로 반환한다.

Return
type	description
Array	항목의 정보가 담긴 객체를 담고 있는 1차원 배열

Sample

//아래와 같이 DataList 정의 <w2:dataList baseNode="list" id="dc_tmpList"> <w2:columnInfo> <w2:column id="country" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> </w2:columnInfo> <w2:data use="true"> <w2:row> <country><![CDATA[네덜란드]]></country> <value><![CDATA[0016]]></value> </w2:row> <w2:row> <country><![CDATA[대한민국]]></country> <value><![CDATA[0022]]></value> </w2:row> <w2:row> <country><![CDATA[덴마크]]></country> <value><![CDATA[0023]]></value> </w2:row> </w2:data> </w2:dataList> //AutoComplete 정의 - dc_tmpList와 항목 연동 //항목에 label과 value를 함께 표현하기 위해 displayMode의 속성값을 "label delim value", delimiter속성 값을 "::"로 설정. <w2:autoComplete id="autoComplete1" style="position: relative;width:126px;height:21px;margin-right:10px;" displayMode="label delim value" delimiter="::" submenuSize="auto"> <w2:choices> <w2:itemset nodeset="data:dc_tmpList"> <w2:label ref="country"></w2:label> <w2:value ref="value"></w2:value> </w2:itemset> </w2:choices> </w2:autoComplete> //getSearchedItems를 호출 var tmpRsArr = autoComplete1.getSearchedItems(); //총 3건 항목이 담긴 배열 //첫번째 항목의 객체를 꺼내옴 var tmpObj = tmpRsArr[0]; //return 예시 ) { "label":"네덜란드::0016", "value":"0026", "orgLabel":"네덜란드", "index":0 }

getSelectedIndex( )

선택된 항목의 index를 반환한다.
선택된 항목이 없는 경우 -1을 반환한다.

Return
type	description
Number	선택된 항목의 index

getSelectedRow( )

선택된 항목의 정보가 담긴 객체를 반환한다.
그리드 아이템셋이 적용된 경우 선택된 row를 반환한다.

Return
type	description
JSON	항목의 정보가 담긴 객체 - 기본 반환 정보

Sample

//아래와 같이 DataList 정의 <w2:dataList baseNode="list" id="dc_tmpList"> <w2:columnInfo> <w2:column id="country" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> </w2:columnInfo> <w2:data use="true"> <w2:row> <country><![CDATA[네덜란드]]></country> <value><![CDATA[0016]]></value> </w2:row> <w2:row> <country><![CDATA[대한민국]]></country> <value><![CDATA[0022]]></value> </w2:row> <w2:row> <country><![CDATA[덴마크]]></country> <value><![CDATA[0023]]></value> </w2:row> </w2:data> </w2:dataList> //AutoComplete 정의 - dc_tmpList와 항목 연동 //항목에 label과 value를 함께 표현하기 위해 displayMode의 속성값을 "label delim value", delimiter속성 값을 "::"로 설정. <w2:autoComplete id="autoComplete1" style="position: relative;width:126px;height:21px;margin-right:10px;" displayMode="label delim value" delimiter="::" submenuSize="auto"> <w2:choices> <w2:itemset nodeset="data:dc_tmpList"> <w2:label ref="country"></w2:label> <w2:value ref="value"></w2:value> </w2:itemset> </w2:choices> </w2:autoComplete> //사용자가 첫번째 항목을 선택한 경우 //getSelectedRow 호출 var tmpObj = autoComplete1.getSelectedRow(); //return 예시 ) { "label":"네덜란드", "value":"0026" }

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

getText( isOriginal )

선택된 항목의 label을 반환한다.

Parameter
name	type	required	description
isOriginal	Boolean	N	[default:false, true]true일 경우 본래의 label을 반환.

Return
type	description
String	현재 선택된 항목의 label

Sample

//아래와 같이 DataList 정의 <w2:dataList baseNode="list" id="dc_tmpList"> <w2:columnInfo> <w2:column id="country" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> </w2:columnInfo> <w2:data use="true"> <w2:row> <country><![CDATA[네덜란드]]></country> <value><![CDATA[0016]]></value> </w2:row> <w2:row> <country><![CDATA[대한민국]]></country> <value><![CDATA[0022]]></value> </w2:row> <w2:row> <country><![CDATA[덴마크]]></country> <value><![CDATA[0023]]></value> </w2:row> </w2:data> </w2:dataList> //AutoComplete 정의 - dc_tmpList와 항목 연동 //항목에 label과 value를 함께 표현하기 위해 displayMode의 속성값을 "label delim value", delimiter속성 값을 "::"로 설정. <w2:autoComplete id="autoComplete1" style="position: relative;width:126px;height:21px;margin-right:10px;" displayMode="label delim value" delimiter="::" submenuSize="auto"> <w2:choices> <w2:itemset nodeset="data:dc_tmpList"> <w2:label ref="country"></w2:label> <w2:value ref="value"></w2:value> </w2:itemset> </w2:choices> </w2:autoComplete> //사용자가 첫번째 항목을 선택한 경우 //현재 화면에 표현 된 lael을 반환 var tmpObj = autoComplete1.getText(); //return 예시 ) "네덜란드::0016" //원래의 lael을 반환 var tmpObj = autoComplete1.getText(true); //return 예시 ) "네덜란드"

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"

getValue( )

현재 선택된 항목의 value값을 반환한다

Return
type	description
String	선택된 항목의 value.

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

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

initAutoComplete( )

autoCompelete을 초기화한다. (항목 삭제 및 value 초기화)

Sample

autoComplete1.initAutoComplete();

openTable( )

항목창을 연다.
interactionMode속성이 true인 경우 submission 또는 submissionFunc가 실행 후에 호출해야 한다.

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

setDisabled( disabled )

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

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

Sample

//컴포넌트 disabled 속성을 활성화. componentId.setDisabled(true);

setDummyData( value , label )

항목에 나열된 값이 아닌 임의의 값을 설정(value와 label)한다.
항목에는 해당 값을 추가하지 않으며 selectedIndex는 -1로 설정된다.

Parameter
name	type	required	description
value	String	Y	저장하고자 하는 value 값
label	String	Y	저장하고자 하는 label 값

Sample

//임의 값을 설정 autoComplete1.setDummyData("0000","WebSquare"); //"WebSquare" 문자열이 보여짐 //value값 꺼내오기 var tmpRs = autoComplete1.getValue(); //return 예시 ) "0000" //선택 된 항목의 index 꺼내오기 var tmpIdx = autoComplete1.getSelectedIndex(); //항목에서 선택된 값이 아니므로 -1 반환 //return 예시 ) -1

setEditMode( )

입력창(input)에 foucs를 준다.

Sample

autoComplete1.setEditMode();

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

setGridItemset( obj )

gridViewItemset을 동적으로 변경한다. 기존의 gridViewItemset을 삭제하고 새로 만든다.

Parameter
name	type	required	description
obj	JSON\|\|XML	Y	새로 구성할 gridViewItemset에 대한 정보를 담은 객체. JSON객체 또는 XML객체여야 한다.

Sample

var obj = { "nodeset" : "data:dataList2", "label" : "col1", "value" : "col2", "width" : 400, "height" : 300, "item" : [{"ref" : "col1", "header" : "label"},{"ref" : "col2", "header" : "value"},{"ref" : "col3", "header" : "dummy"}] }; autoComplete1.setGridItemset(obj);

setInitStyle( property )

웹스퀘어 컴포넌트의 초기 스타일을 복구. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
property	String	N	CSS 속성 (지정하지 않으면 모든 속성의 초기 값으로 복구.)

Sample

// (예제) group1.setInitStyle();

setItem( label , value , nodest , index )

itemTable의 index번째 항목의 label과 value을 변경한다.

Parameter
name	type	required	description
label	String	Y	항목의 label 값
value	String	Y	항목의 value 값
nodest	Element	Y	항목의 nodeset 값
index	Number	Y	항목의 index 값

setItemSet( nodeset , label , value )

항목의 itemset을 설정한다. 현재 선택(입력)된 값은 그대로 있고 항목만 변경된다.

Parameter
name	type	required	description
nodeset	String	N	변경하려는 nodeset의 값
label	String	N	변경하려는 label 경로
value	String	N	변경하려는 value 경로

Sample

//id가 "dc_tmpSearchList"인 DataList를 항목의 itemSet에 연동하고 disp컬럼을 label로 code컬럼을 value로 설정 autoComplete1.setItemSet("dc_tmpSearchList","disp","code");

setMaxLength( maxlength )

maxlength를 동적으로 설정합니다.

Parameter
name	type	required	description
maxlength	Number	Y	설정할 maxlength 속성 값

Sample

autoComplete1.setMaxLength(7);

setNextTabID( componentID , componentScope )

nextTabID 옵션값을 설정합니다. 두번째 인자로 nextTabID에 해당하는 컴포넌트가 위치한 frame의 ID를 넘겨주면 scope를 설정할 수 있습니다.

Parameter
name	type	required	description
componentID	String	Y	nextTabID로 설정할 컴포넌트의 id
componentScope	String	N	nextTabID로 설정할 컴포넌트의 scope

Sample

autoComplete1.setNextTabID("input2", "wframe1");

setNodeSet( nodeset , label , value )

항목의 itemset 설정을 변경하는 기능으로 DataList와 연동 할 경우 nodeset 파라메터에 "data:" prefix를 꼭 붙여야한다.

Parameter
name	type	required	description
nodeset	String	Y	DataList의 ID로 "data:"이라는 prefix를 붙여야한다. ( 또는 InstanceData의 XPath )
label	String	N	label에 설정 될 column의 id로 값을 할당하지 않으면 기존에 설정된 값이 그대로 적용된다. ( 또는 label에 설정 할 nodeset 하위의 XPath )
value	String	N	value에 설정 될 column의 id로 값을 할당하지 않으면 기존에 설정된 값이 그대로 적용된다. ( 또는 value에 설정 할 nodeset 하위의 XPath )

Sample

//아래와 같은 DataList가 정의 된 경우. <w2:dataList id="dataList1"> <w2:columnInfo> <w2:column id="lbl" dataType="text"></w2:column> <w2:column id="code" dataType="text"></w2:column> </w2:columnInfo> <w2:data use="true"> <w2:row> <lbl><![CDATA[zero]]></lbl> <code><![CDATA[0]]></code> </w2:row> <w2:row> <lbl><![CDATA[one]]></lbl> <code><![CDATA[1]]></code> </w2:row> </w2:data> </w2:dataList> //autoComplete1의 itemset설정을 DataCollection의 dataList1로 변경하고 label은 lbl column으로 value는 code column으로 설정 할 경우 autoComplete1.setNodeSet('data:dataList1','lbl','code'); //dataList1과 컬럼이 동일하고 실 data만 다른 dataList2로 변경 할 경우 autoComplete1.setNodeSet('data:dataList2'); //기존에 할당 된 label의 lbl과 value의 code는 그대로 유지되고 dataList만 변경된다.

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

setRef( ref )

바인딩 된 ref 경로를 동적으로 변경합니다.

Parameter
name	type	required	description
ref	String	Y	변경할 ref의 XPath

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 )

컴포넌트의 propertyName에 해당하는 style의 값을 설정합니다.

Parameter
name	type	required	description
propertyName	String	Y	바꾸고 싶은 style 값의 이름
value	String	Y	설정할 style의 값

Sample

예: 컴포넌트 스타일 width를 변경하고자 하는 경우. componentId.setStyle("width", 100); 픽셀 단위를 기본으로 하며, componentId.setStyle("width", "100px"); 과 동일하다. %단위의 표현을 하고자 하면 componentId.setStyle("width", "100%"); 로 명시하여 준다.

setText( label , isOriginal )

인자로 넘겨진 label과 같은 label을 가지는 항목을 선택한다.

Parameter
name	type	required	description
label	String	Y	선택하고자 하는 항목의 label
isOriginal	Boolean	N	[default:false, true]label을 format이 적용되지 않은 본래의 값으로 찾을 것인지에 대한 여부.

Sample

//아래와 같이 DataList 정의 <w2:dataList baseNode="list" id="dc_tmpList"> <w2:columnInfo> <w2:column id="country" name="label" dataType="text"></w2:column> <w2:column id="value" name="value" dataType="text"></w2:column> </w2:columnInfo> <w2:data use="true"> <w2:row> <country><![CDATA[네덜란드]]></country> <value><![CDATA[0016]]></value> </w2:row> <w2:row> <country><![CDATA[대한민국]]></country> <value><![CDATA[0022]]></value> </w2:row> <w2:row> <country><![CDATA[덴마크]]></country> <value><![CDATA[0023]]></value> </w2:row> </w2:data> </w2:dataList> //AutoComplete 정의 - dc_tmpList와 항목 연동 //항목에 label과 value를 함께 표현하기 위해 displayMode의 속성값을 "label delim value", delimiter속성 값을 "::"로 설정. <w2:autoComplete id="autoComplete1" style="position: relative;width:126px;height:21px;margin-right:10px;" displayMode="label delim value" delimiter="::" submenuSize="auto"> <w2:choices> <w2:itemset nodeset="data:dc_tmpList"> <w2:label ref="country"></w2:label> <w2:value ref="value"></w2:value> </w2:itemset> </w2:choices> </w2:autoComplete> //"대한민국" label이 있는 항목을 선택할 때 - 화면에 표현된 label의 값으로 선택 autoComplete1.setText("대한민국::0022"); //display 예시 ) "대한민국::0022" 가 선택 된다 //"대한민국" label이 있는 항목을 선택할 때 (isOriginal 파라메터를 통해 본래의 label값으로 선택) autoComplete1.setText("대한민국",true); //display 예시 ) "대한민국::0022" 가 선택 된다 //동일한 API의 2번째 파라메터인 isOriginal를 주지 않았을 경우 autoComplete1.setText("대한민국"); //display 예시 ) 항목이 선택되지 않는다.

setTitle( title )

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

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

Sample

autoComplete1.setTitle("test"); // autoComplete1의 title속성 값은 "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( value )

인자로 넘겨진 value와 같은 값을 가진 항목을 선택한다.

Parameter
name	type	required	description
value	String	Y	선택하려는 항목의 value

Sample

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

unbindRef( )

ref 바인딩을 해제합니다

validate( )

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

Return
type	description
Boolean	validate 결과 반환 (true/false)

Sample

interactionMode를 사용하는 경우, 필수입력 여부에 상관 없이 true를 리턴한다. var returnValue = autoComplete1.validate();

validateObject( )

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

Return
type	description
Object	object 유효성 검사 결과 객체

Sample

//아래와 같이 autoComplete 컴포넌트에 chooseOption과 mandatory 속성을 정의했을 경우 <w2:autoComplete id="autoComplete1" style="position: absolute;width:213px;height:74px;left:891px;top:69px;" chooseOption="true" mandatory="true" chooseOptionLabel="-선택-"> <w2:choices> <w2:itemset nodeset="data:dataList3"> <w2:label ref="label"></w2:label> <w2:value ref="value"></w2:value> </w2:itemset> </w2:choices> </w2:autoComplete> var returnObj = autoComplete1.validateObject(); //return 예시 - autoComplete의 값이 없을 경우 ) returnObj 객체 반환 returnObj.callerId = "autoComplete1" returnObj.type = "mandatory" returnObj.value = "" //return 예시 - autoComplete의 값이 있을 경우) 비어있는 객체가 반환 autoComplete 컴포넌트의 displaymessage="true" 설정을 함께 사용하면 유효성 검사에서 false가 된 경우 엔진에서 설정 된 메세지가 alert으로 뜬다. //alert 메세지 예시 ) 필수 입력 항목입니다

visible( flag )

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

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