WebSquare.uiplugin.selectbox

HTML에서 select Tag와 같은 기능을 제공하는 컴포넌트로 여러개의 항목 중 1가지를 선택 할 수 있다.
주의 사항으로는 본 컴포넌트가 브라우저에 표현 될 때는 select Tag가 아닌 최상위에 div Tag로 감싸고 하위에 복합 Tag를 이용하여 표현하고 있음으로 select Tag로 표현하고자 할 때는 별도의 설정을 통해 변경해야 한다.

Type

uiplugin

Property Summary

allOption: [default:false, true] 전체항목 표시 여부로 label은 "-전체-" 로 value는 "all" 로 설정된다
animation: [default: "", show, fadeIn, slideDown] itemtable의 animation을 설정한다. 각각의 세부내용은 아래와 같다.
appearance: [default:minimal,full] xforms select1의 appearance속성으로 minimall의 경우 selectbox로 full의 경우 radio로 표현된다
chooseOption: [default:false,true] 선택항목 표시 여부로 chooseOptionLabel속성이 설정되어 있지 않으면 label은 "-선택-"으로 value는 ""(empty string)으로 설정된다
chooseOptionLabel: chooseOption속성이 true로 설정 된 경우 label에 표현 될 text를 정의 한다
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
closeonmouseleave: [default:false, true] subLayer open되어 있을때, mouseleave 이벤트에 의해 닫을지 여부
customFormatter: [default:""] 아이템 목록을 커스텀할 수 있는 사용자 정의 함수를 설정한다
customLabelFormatter: [default:""] selectbox label 값을 커스텀할 수 있는 사용자 정의 함수를 설정한다
dataListAutoRefresh: [default: false, true] SelectBox의 선택 대상 목록이 DataList와 바인딩된 경우, addItem 혹은 deleteItem 함수 실행에 따른 DataList 자동 갱신 여부.
delimiter: displayMode속성에서 참조하고 있으며 value와 label을 함께 표현 할 때 사용하는 구분자이다.
direction: [defulat:auto, down, up] 항목의 열림 방향
disabled: [default:false, true] HTML의 disabled속성과 동일한 기능을 제공하며 컴포넌트를 비활성화 시킨다
disabledClass: disabled속성이 true일 경우 적용 할 class명
displaymessage: [default:false, true] validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 표시 할지의 여부.
displayMode: [default:label, value delim label, label delim value, value] 항목의 표현 방법으로 label과 value를 함께 표현 할 수 있다. delim(구분자)는 delimiter속성에 정의 된 값을 참조한다.
emptyItem: [default:false, true] 항목에 없는 value나 index가 설정되는 경우(setValue, setSelectedIndex와 같은 API로 설정) 빈 label과 빈 value(empty string)로 설정 할지에 대한 여부.
emptyValue: emptyItem속성이 true로 설정 된 경우 본 속성의 값으로 value를 설정한다.
escape: <>&"를 HTML Escape 문자로 변환하여 화면에 표시한다
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다
invalidMessage: validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 본 속성의 값으로 표현되는 기능으로 displaymessage속성이 true로 되어있어야 한다.
invalidMessageFunc: validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 별도로 정의 한 Function에서 동적으로 표현 할 수 있는 기능으로 정의 된 function의 이름을 명시한다.
keyMoveListSync: [default:false, true] 키보드로 item목록을 이동하면서 동시에 selectbox의 값을 설정하는 기능 사용 여부.
labelWidthAuto: [default:false, true] 컴포넌트에 정의 된 width을 무시하고 항목 중 text가 가장 긴 크기에 맞게 출력 할지 여부.
mandatory: [default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부
nextTabID: tab으로 이동시 이동할 컴포넌트 ID
optionOrder: [default:choose, all] 전체 항목과 선택 항목을 동시에 사용하는 경우 전체, 선택의 출력 순서
preventWheelEvent: [default:false, true] selectbox에서 mouseWheelEvent를 발생시키지 않습니다
ref: DataCollection의 value 경로로 컴포넌트와 DataCollection의 value를 binding을 시킬 때 사용하며 "data:"라는 prefix는 필수로 붙여주어야 한다.
refreshSelectedIndex: [default:false, true] item목록이 dataList와 연동된 경우 dataList가 갱신될 때 selectedIndex값이 실제 selectbox 선택된 항목과 일치시키도록 하는 설정.
renderType: [default:component, auto, native, select] 본 컴포넌트가 브라우저에 표현 될 레이아웃 구조로 세부 내용은 아래와 같다.
selectedData: [default: true, false] 선택한 값이 바인딩된 DataList의 결과 목록에 없을 경우 선택한 값 유지 여부.
setDataRemoveAll: removeAll시에 data 초기화 처리 사용 여부
sortMethod: [default:ascending, descending] sortOption속성에서 참조하며 sortOption에 정의 된 값에 대한 정렬 방법
sortOption: [label,value] 항목을 label 또는 value를 기준으로 정렬 할 때 사용된다.
submenuSize: [default:auto, fixed] labelWidthAuto속성이 true인 경우 미동작하며 목록(항목)창 크기를 label에 맞출지 기본 width로 고정 할지에 대한 설정
tabIndex: Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다
textAlign: [default:center, left, right] 항목의 text 정렬 방법
title: HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다
toolTip: 웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다
tooltipClass: tooltipDisplay속성의 값이 true일 때, tooltip에 적용 할 class명
tooltipDisplay: [default:false, true] 선택된 값에 대한 tooltip 표현여부
tooltipTime: tooltipDisplay속성의 값이 true일 때, tooltip이 보이는데 걸리는 초(second)
useLocale: [default:false, true] Client 다국어를 이용하여 항목의 label에 표현되는 값을 다국어 key를 이용하여 표현 할 지에 대한 설정이다.( 세부 내용은 Client 다국어 가이드 참고 )
userData1: 사용자 정의 데이터 속성
userData2: 사용자 정의 데이터 속성
userData3: 사용자 정의 데이터 속성
visibleRowNum: 표현 될 항목 행수
wmode: [default:false, true] wmode 사용 여부로 항목이 object(activeX 또는 flash)에 가려 질 경우 해당 속성을 사용한다.

Event Summary

onblur: 포커스를 잃었을 때 발생
onchange: 선택항목 변경 시 발생
onclick: 마우스로 selectbox를 클릭했을 때 발생
ondblclick: 마우스로 selectbox를 더블 클릭했을 때 발생
onfocus: 포커스를 얻었을 때 발생
ontooltiphide: 툴팁이 사라질 때 발생
ontooltipshow: 툴팁이 나타날 때 발생
onviewchange: 목록의 값이 키보드나 마우스 조작을 통해 변경된 경우에만 발생하는 이벤트로 스크립트를 통해 값이 변경된 경우에는 해당 이벤트가 발생하지 않는다

Method Summary

addClass( className ): 컴포넌트에 CSS class를 추가
addItem( value , label , index , refresh ): 항목을 추가하는 기능으로 index를 주지 않으면 하위로 append된다.
bind( eventType , function ): 컴포넌트에 이벤트와 핸들러 함수를 동적으로 할당
changeChooseOption( newValue , newLabel ): chooseOption의 label과 value의 값을 변경한다
changeClass( oldClassName , newClassName ): 웹스퀘어 컴포넌트의 class를 변경. (웹스퀘어 컴포넌트 공통.)
deleteItem( idx , refresh ): index에 해당하는 항목을 삭제하며 chooseOpion속성과 allOption속성이 true로 설정 된 경우 항목의 index에 포함된다
focus( ): 웹스퀘어 컴포넌트에 포커스를 줌
getDataListInfo( ): selectbox에 바인딩되어 있는 dataList를 반환합니다
getDisabled( ): 현재 웹스퀘어 컴포넌트에 설정된 disabled 속성 값을 반환
getGenerator( ): 컴포넌트가 Generator에 의해 생성된 경우, 자신을 생성한 부모 Generator 객체를 반환
getID( ): 웹스퀘어 컴포넌트의 ID를 반환
getInitStyle( CSS ): 웹스퀘어 컴포넌트의 초기 스타일을 반환
getItemCount( ): 항목 수를 반환하며 chooseOption, allOption 속성이 적용 된 경우 해당 item도 count에 포함된다
getNextTabID( ): nextTabID 옵션값을 반환한다
getOpacity( ): 웹스퀘어 컴포넌트의 불투명도를 반환. (웹스퀘어 컴포넌트 공통.)
getOriginalID( ): 웹스퀘어 컴포넌트의 originalID를 반환. (웹스퀘어 컴포넌트 공통.)
getPluginName( ): 웹스퀘어 컴포넌트의 이름(pluginName)을 반환
getPosition( positionName ): 웹스퀘어 컴포넌트의 위치(left, top)를 반환
getReadOnly( ): 현재 웹스퀘어 컴포넌트에 설정된 readOnly 속성 값을 반환
getScope( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getScopeWindow( ): scope="true"인 WFrame의 자식 컴포넌트인 경우, 부모 WFrame 객체를 반환. (웹스퀘어 컴포넌트 공통.)
getSelectedIndex( ): 선택된 항목의 index를 반환하며 chooseOption, allOption 속성이 적용 된 경우 해당 item도 index에 포함된다
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( ): 컴포넌트를 화면에서 보이지 않도록 숨깁니다
removeAll( isInitialize ): [default:false, true] 모든 항목을 삭제하는 기능으로 chooseOption, allOption이 정의 된 경우 isInitialize값을 true로 적용하면 해당 항목은 삭제되지 않는다
removeClass( className ): 웹스퀘어 컴포넌트에서 class를 삭제.(웹스퀘어 컴포넌트 공통.)
setDisabled( disabled ): 웹스퀘어 컴포넌트의 disabled 속성을 설정
setEventPause( evList , flag ): 지정한 이벤트를 중단함
setGridItemset( obj ): gridViewItemset을 동적으로 변경한다
setInitStyle( property ): 웹스퀘어 컴포넌트의 초기 스타일을 복구
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 속성을 설정하는 기능으로 DataCollection과 연동시 "data:"라는 prefix를 꼭 붙여야한다.
setSelectedIndex( idx ): idx에 해당하는 index로 항목을 선택하는 기능으로 chooseOption, allOption 속성이 정의 된 경우 해당 item도 index에 포함된다
setSize( width , height ): 웹스퀘어 컴포넌트의 크기(width, height)를 설정
setStyle( propertyName , value ): 웹스퀘어 컴포넌트의 CSS 속성을 설정
setText( lbl , isOriginal ): lbl 파라메터와 같은 label을 가지는 항목을 선택한다
setTitle( title ): 컴포넌트의 title속성을 설정한다
setUserData( key , value ): 웹스퀘어 컴포넌트에 임의의 데이터를 설정
setValue( value ): 파라메터로 넘어온 value가 항목에 있는 경우 해당 항목이 선택되며 해당값으로 value가 할당된다.
show( displayType ): 웹스퀘어 컴포넌트를 화면에 표시. (웹스퀘어 컴포넌트 공통.)
showChooseOption( chooseOption ): chooseOption을 설정합니다
toggleClass( className ): 웹스퀘어 컴포넌트에서 특정 class를 제거하거나 추가. (웹스퀘어 컴포넌트 공통.)
trigger( type , array ): 컴포넌트에서 특정 이벤트를 발생시킴
unbind( type , function ): 컴포넌트에서 이벤트를 제거
unbindRef( ): ref 바인딩을 해제합니다
validate( ): 컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
validateObject( ): 컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
visible( flag ): [deprecated]

Property Detail

allOption: [default:false, true] 전체항목 표시 여부로 label은 "-전체-" 로 value는 "all" 로 설정된다.
animation: [default: "", show, fadeIn, slideDown] itemtable의 animation을 설정한다. 각각의 세부내용은 아래와 같다.
기본값 : 전체 내역이 한번에 보여진다.
show : 한 점에서 퍼지면서 내역이 보여진다.
fadeIn : 전체가 점점 선명하게 내역이 보여진다.
slideDown : 하위로 내려오면서 순차적으로 보여진다.
appearance: [default:minimal,full] xforms select1의 appearance속성으로 minimall의 경우 selectbox로 full의 경우 radio로 표현된다.
chooseOption: [default:false,true] 선택항목 표시 여부로 chooseOptionLabel속성이 설정되어 있지 않으면 label은 "-선택-"으로 value는 ""(empty string)으로 설정된다.
chooseOptionLabel: chooseOption속성이 true로 설정 된 경우 label에 표현 될 text를 정의 한다.
class: HTML의 class속성과 동일한 기능을 제공하며 css파일 또는 style블럭에 정의한 class를 1개 또는 공백(space)를 이용하여 다중 적용이 가능하다.
기본적으로 엔진 내부에서 컴포넌트별로 class를 적용하고 있으며 해당 class를 이용하여 컴포넌트의 css를 공통으로 적용할 수 있다.
closeonmouseleave: [default:false, true] subLayer open되어 있을때, mouseleave 이벤트에 의해 닫을지 여부
customFormatter: [default:""] 아이템 목록을 커스텀할 수 있는 사용자 정의 함수를 설정한다.(gridItemset 및 gridViewItemset 인 경우는 제외)
customLabelFormatter: [default:""] selectbox label 값을 커스텀할 수 있는 사용자 정의 함수를 설정한다.
dataListAutoRefresh: [default: false, true] SelectBox의 선택 대상 목록이 DataList와 바인딩된 경우, addItem 혹은 deleteItem 함수 실행에 따른 DataList 자동 갱신 여부.
true: 자동 갱신. false: 기본 값. 자동 갱신 안 함.
하위 호환을 위한 설정으로 true를 권장. (config.xml 파일에 설정하여 일괄 적용.)
delimiter: displayMode속성에서 참조하고 있으며 value와 label을 함께 표현 할 때 사용하는 구분자이다.
displayMode속성의 "delim"에 해당하는 값이 본 속성에 정의 된 값이다.
direction: [defulat:auto, down, up] 항목의 열림 방향.
disabled: [default:false, true] HTML의 disabled속성과 동일한 기능을 제공하며 컴포넌트를 비활성화 시킨다.
disabledClass: disabled속성이 true일 경우 적용 할 class명.
displaymessage: [default:false, true] validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 표시 할지의 여부.
기본적으로 엔진에서 정의 된 메세지가 표현되며 별도의 메세지를 정의하고자 할 때는 invalidMessageFunc속성을 이용한다.
displayMode: [default:label, value delim label, label delim value, value] 항목의 표현 방법으로 label과 value를 함께 표현 할 수 있다. delim(구분자)는 delimiter속성에 정의 된 값을 참조한다.
label (기본 값): "label"
value delilm label: "value + 구분자 + label"
label delim value: "label + 구분자 + value"
value: "value"
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: <>&"를 HTML Escape 문자로 변환하여 화면에 표시한다. (기본 값: false)
id: 컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다.
invalidMessage: validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 본 속성의 값으로 표현되는 기능으로 displaymessage속성이 true로 되어있어야 한다.
invalidMessageFunc과 동시 적용이 불가하다.
invalidMessageFunc: validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 별도로 정의 한 Function에서 동적으로 표현 할 수 있는 기능으로 정의 된 function의 이름을 명시한다.
displaymessage속성이 true로 되어있어야 하며 invalidMessage와 동시 적용이 불가하다.
사용자 Function(아래 예시 참조)에서는 this.getType()을 통해 검증 실패 type(아래 type 참조)과 this.getValue()를 value값을 가져와 메세지를 동적으로 생성하여 return 한다.
type)mandatory, allowChar, ignoreChar, minLength, maxLength, minByteLength, maxByteLength
예시)function fn_msg(){ var tmpType = this.getType(); var tmpValue = this.getValue(); if(tmpType == "mandatory"){ return "필수 검증 항목입니다."; } }
keyMoveListSync: [default:false, true] 키보드로 item목록을 이동하면서 동시에 selectbox의 값을 설정하는 기능 사용 여부.
키보드로 item목록을 이동할때마다 값이 변경되므로 그때마다 onviewchange 이벤트가 발생한다.
labelWidthAuto: [default:false, true] 컴포넌트에 정의 된 width을 무시하고 항목 중 text가 가장 긴 크기에 맞게 출력 할지 여부.
주의 사항으로 style의 position이 absolute로 되어있고 우측에 컴포넌트가 배치 되어있을 경우 UI가 틀어질 수 있음으로 우측에 컴포넌트가 없도록 설계되거나 컴포넌트들의 position을 relative로 설정해야한다.
mandatory: [default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부.
nextTabID: tab으로 이동시 이동할 컴포넌트 ID
optionOrder: [default:choose, all] 전체 항목과 선택 항목을 동시에 사용하는 경우 전체, 선택의 출력 순서
preventWheelEvent: [default:false, true] selectbox에서 mouseWheelEvent를 발생시키지 않습니다.
ref: DataCollection의 value 경로로 컴포넌트와 DataCollection의 value를 binding을 시킬 때 사용하며 "data:"라는 prefix는 필수로 붙여주어야 한다.
작성 방법은 data:[DataCollection ID].[Key id 또는 Column id]와 같다. 예시)data:dataMap1.dept
DataList와 연동 된 경우는 GridView에서 선택 된 Row의 값이 binding 된다.
Instance Data와 연동 할 경우 연동 할 XML 데이터의 XPath를 명시한다. 예시)res/userInfo/dept/@value
refreshSelectedIndex: [default:false, true] item목록이 dataList와 연동된 경우 dataList가 갱신될 때 selectedIndex값이 실제 selectbox 선택된 항목과 일치시키도록 하는 설정.
하위호환을 위한 속성이며 신규 프로젝트에서는 이 속성을 true로 설정해야 한다.
renderType: [default:component, auto, native, select] 본 컴포넌트가 브라우저에 표현 될 레이아웃 구조로 세부 내용은 아래와 같다.
component : select Tag를 사용하지 않고 div Tag하위로 table Tag를 이용하여 항목을 표현한다.
native : 주로 웹 접근성 지원을 위해 사용되는 속성으로 모든 브라우저 환경에서 완벽하게 동일한 모양과 기능을 제공하면서도 title 속성과 함께 제공한다면 접근성 지원에도 전혀 문제가 없다.
select : 단순히 select Tag로만 렌더링되는 모드로서, 접근성 지원에는 완벽한 사용법이지만, 모든 브라우저에서 동일한 모양세로 보여지지 않는 문제가 발생한다.
auto : 모바일 브라우저인 경우 native, 그렇지 않을 경우 component로 동작한다.
selectedData: [default: true, false] 선택한 값이 바인딩된 DataList의 결과 목록에 없을 경우 선택한 값 유지 여부.
true (기본 값): 선택 값을 무시하고 이전 값 유지.
false: 선택 값 유지.
setDataRemoveAll: removeAll시에 data 초기화 처리 사용 여부
sortMethod: [default:ascending, descending] sortOption속성에서 참조하며 sortOption에 정의 된 값에 대한 정렬 방법.
sortOption: [label,value] 항목을 label 또는 value를 기준으로 정렬 할 때 사용된다.
기본적으로 ascending으로 정렬되며 sortMethod속성에 값이 정의 된 경우 해당값으로 정렬 방법이 결정된다.
submenuSize: [default:auto, fixed] labelWidthAuto속성이 true인 경우 미동작하며 목록(항목)창 크기를 label에 맞출지 기본 width로 고정 할지에 대한 설정.
tabIndex: Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다.
textAlign: [default:center, left, right] 항목의 text 정렬 방법.
title: HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다. 일반적으로 웹접근성 작업 시 설정한다.
toolTip: 웹스퀘어에서 만든 toolTip으로 컴포넌트의 추가정보를 명시한다. 마우스 over시 표현된다.
tooltipClass: tooltipDisplay속성의 값이 true일 때, tooltip에 적용 할 class명.
tooltipDisplay: [default:false, true] 선택된 값에 대한 tooltip 표현여부.
tooltipTime: tooltipDisplay속성의 값이 true일 때, tooltip이 보이는데 걸리는 초(second)
useLocale: [default:false, true] Client 다국어를 이용하여 항목의 label에 표현되는 값을 다국어 key를 이용하여 표현 할 지에 대한 설정이다.( 세부 내용은 Client 다국어 가이드 참고 )
본 속성에 추가적으로 영향을 받는 속성으로는 chooseOptionLabel이 있으며 해당 속성에도 다국어 key가 정의되어야한다.
userData1: 사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2: 사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3: 사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.
visibleRowNum: 표현 될 항목 행수. 1로 설정하는 것은 권장하지 않습니다.
wmode: [default:false, true] wmode 사용 여부로 항목이 object(activeX 또는 flash)에 가려 질 경우 해당 속성을 사용한다.
wmode가 true이면 object 태그보다 상위에 보이도록 하는 설정으로 본 컴포넌트에 wmode를 설정하는 것이 아닌 object(activeX, flash 등)태그의 wmode를 사용하는 것을 권장한다.

Event Detail

onblur

포커스를 잃었을 때 발생

Parameter
name	type	description
e	Object	이벤트 객체

onchange

선택항목 변경 시 발생

onclick

마우스로 selectbox를 클릭했을 때 발생

Parameter
name	type	description
e	Object	이벤트 객체

ondblclick

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

Parameter
name	type	description
e	Object	이벤트 객체

onfocus

포커스를 얻었을 때 발생

Parameter
name	type	description
e	Object	이벤트 객체

ontooltiphide

툴팁이 사라질 때 발생

ontooltipshow

툴팁이 나타날 때 발생

onviewchange

목록의 값이 키보드나 마우스 조작을 통해 변경된 경우에만 발생하는 이벤트로 스크립트를 통해 값이 변경된 경우에는 해당 이벤트가 발생하지 않는다.(native onchange 이벤트와 유사)

Parameter
name	type	description
info	JSON	oldValue, newValue, oldSelectedIndex, newSelectedIndex를 포함한 객체를 반환한다.

Sample

Method Detail

addClass( className )

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

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

Sample

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

addItem( value , label , index , refresh )

항목을 추가하는 기능으로 index를 주지 않으면 하위로 append된다.
주의 사항으로는 chooseOption 및 allOption 속성을 사용 할 경우 해당 item들도 index에 포함된다.

Parameter
name	type	required	description
value	String	Y	항목의 value
label	String	Y	항목의 label
index	Number	N	항목이 추가 될 index
refresh	Boolean	N	항목이 dataList(또는 instance)와 연동되어 있는 경우, dataList(instance)를 자동으로 갱신할지에 대한 여부. 값이 명시되지 않은 경우(undefined) selectbox의 dataListAutoRefresh속성값을 따른다.

Return
type	description
Number	추가 된 항목의 index

Sample

//아래와 같이 항목을 추가하지 않고 chooseOption속성을 true로 정의 한 select의 경우 <xf:select1 chooseOption="true" id="selectbox1" style="position: relative;width: 148px;height: 21px;" disabledClass="w2selectbox_disabled" appearance="minimal"> <xf:choices></xf:choices> </xf:select1> //index를 지정하지 않고 항목 추가 selectbox1.addItem( 'M', '남성' ); //"-선택-" 항목 하위로(제일 마지막에) 추가된다. 항목의 순서는 "-선택-","남성" 가 된다. //return 예시 ) 1 //index를 0으로 지정하여 항목 추가 selectbox1.addItem( 'F', '여성' ); //0번째에 항목이 추가되어 "-선택-" 항목 위에 추가된다. 항목의 순서는 "여성","-선택-","남성" 가 된다. //return 예시 ) 0

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 "선택"으로 변경 selectbox1.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");

deleteItem( idx , refresh )

index에 해당하는 항목을 삭제하며 chooseOpion속성과 allOption속성이 true로 설정 된 경우 항목의 index에 포함된다.

Parameter
name	type	required	description
idx	Number	Y	삭제 할 항목의 index
refresh	Boolean	N	항목이 dataList(또는 instance)와 연동되어 있는 경우, dataList(instance)를 자동으로 갱신할지에 대한 여부. 값이 명시되지 않은 경우(undefined) selectbox의 dataListAutoRefresh속성값을 따른다.

Return
type	description
JSON	삭제된 항목의 정보가 담긴 JSON

Sample

//아래와 같이 chooseOption 속성과 항목이 정의 된 경우 <xf:select1 id="selectbox1" chooseOption="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> //1번째 index 항목 삭제 var returnValue = selectbox1.deleteItem(1); //0번째 index의 항목은 chooseOption 속성 설정으로 인한 "-선택-"임으로 그 하위의 "남성"가 삭제. //return 예시 ) {label: "남성", value: "M"}

focus( )

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

getDataListInfo( )

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

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

Sample

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

getItemCount( )

항목 수를 반환하며 chooseOption, allOption 속성이 적용 된 경우 해당 item도 count에 포함된다.

Return
type	description
Number	항목 수

Sample

//아래와 같이 chooseOption이 적용 된 selectbox가 정의 된 경우. <xf:select1 id="selectbox1" chooseOption="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> var returnValue = selectbox1.getItemCount(); //return 예시 ) 3

getNextTabID( )

nextTabID 옵션값을 반환한다.

Sample

var nextTabID = selectbox1.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

getSelectedIndex( )

선택된 항목의 index를 반환하며 chooseOption, allOption 속성이 적용 된 경우 해당 item도 index에 포함된다.

Return
type	description
Number	선택 된 항목의 index.

Sample

//아래와 같이 chooseOption이 적용 된 selectbox가 정의되고 남성 항목이 선택 된 경우. <xf:select1 id="selectbox1" chooseOption="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> var returnValue = selectbox1.getSelectedIndex(); //return 예시 ) 1

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:true, false] true시 formatter가 적용되지 않은 값 반환. false시 formatter가 적용 된 값 반환.

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

Sample

//label이 "남성"인 항목이 선택 된 경우 var returnValue = selectbox1.getText(); //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

Sample

//value가 "M"인 항목이 선택 된 경우. var returnValue = selectbox1.getValue(); //return 예시 ) "M"

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

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

removeAll( isInitialize )

[default:false, true] 모든 항목을 삭제하는 기능으로 chooseOption, allOption이 정의 된 경우 isInitialize값을 true로 적용하면 해당 항목은 삭제되지 않는다.

Parameter
name	type	required	description
isInitialize	Boolean	N

Sample

//chooseOption, allOption의 항목을 포함한 모든 항목이 삭제 selectbox1.removeAll(); //chooseOption, allOption의 항목을 제외한 항목이 삭제 selectbox1.removeAll(true);

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

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"}] }; selectbox1.setGridItemset(obj);

setInitStyle( property )

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

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

Sample

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

setNextTabID( componentID , componentScope )

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

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

Sample

selectbox1.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> //selectbox1의 itemset설정을 DataCollection의 dataList1로 변경하고 label은 lbl column으로 value는 code column으로 설정 할 경우 selectbox1.setNodeSet('data:dataList1','lbl','code'); //dataList1과 컬럼이 동일하고 실 data만 다른 dataList2로 변경 할 경우 selectbox1.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 속성을 설정하는 기능으로 DataCollection과 연동시 "data:"라는 prefix를 꼭 붙여야한다.
명시하지 않는 경우 InstanceData의 XPath로 인식한다.

Parameter
name	type	required	description
ref	String	Y	적용 할 ref의 경로.

Sample

//dataMap1의 hobby key와 selectbox1 컴포넌트의 value를 binding 하는 경우 selectbox1.setRef("data:dataMap1.hobby"); //InstanceData의 res/userData/hobby 과 연동 할 경우. selectbox1.setRef("res/userData/hobby");

setSelectedIndex( idx )

idx에 해당하는 index로 항목을 선택하는 기능으로 chooseOption, allOption 속성이 정의 된 경우 해당 item도 index에 포함된다.

Parameter
name	type	required	description
idx	Number	Y	항목의 index.

Sample

//아래와 같이 chooseOption이 적용 된 selectbox가 정의 된 경우. <xf:select1 id="selectbox1" chooseOption="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> selectbox1.setSelectedIndex(1); //chooseOption속성이 true임으로 "남성" 항목이 선택된다.

setSize( width , height )

웹스퀘어 컴포넌트의 크기(width, height)를 설정. (웹스퀘어 컴포넌트 공통.)

Parameter
name	type	required	description
width	Number	Y	새로 설정할 컴포넌트의 width 값 또는 null
height	Number	Y	새로 설정할 컴포넌트의 height 값 또는 null

Sample

// (예제) 컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);

setStyle( propertyName , value )

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

Parameter
name	type	required	description
propertyName	String	Y	설정할 CSS 속성
value	String	Y	해당 CSS 속성에 적용할 값

Sample

// (예제 1) 컴포넌트의 width를 200px로 설정 componentId.setStyle("width", "200px"); // (예제 2) 배경색을 olive로 변경 componentId.setStyle("background-color","olive");

setText( lbl , isOriginal )

lbl 파라메터와 같은 label을 가지는 항목을 선택한다.

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

Sample

//label이 "남성"로 정의 된 경우. selectbox1.getText('남성');

setTitle( title )

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

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

Sample

selectbox1.setTitle("test"); // selectbox1의 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가 항목에 있는 경우 해당 항목이 선택되며 해당값으로 value가 할당된다.
value에 해당하는 항목이 없는 경우 아무 동작이 일어나지 않는다.

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

Return
type	description
Boolean	셋팅 결과

Sample

//label이 "남성"이고 value가 "M"인 항목이 정의 된 경우 selectbox1.setValue("M"); //"남성" 항목이 선택된다.

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

showChooseOption( chooseOption )

chooseOption을 설정합니다.

Parameter
name	type	required	description
chooseOption	boolean	Y	설정값

Sample

selectbox1.showChooseOption(true);

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

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

Sample

//아래와 같이 chooseOption과 mandatory 속성이 적용 된 selectbox가 정의 된 경우. <xf:select1 id="selectbox1" chooseOption="true" mandatory="true" style="position: relative;width: 148px;height: 21px;"disabledClass=" w2selectbox_disabled" appearance="minimal" > <xf:choices> <xf:item> <xf:label><![CDATA[남성]]></xf:label> <xf:value><![CDATA[M]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[여성]]></xf:label> <xf:value><![CDATA[F]]></xf:value> </xf:item> </xf:choices> </xf:select1> //사용자가 아무것도 선택을 안한 상태 일 때 ( "-선택-" 항목이 선택 된 경우 ) var returnValue = selectbox1.validate(); //return 예시 ) false //만약 displaymessage속성을 true로 설정하면 엔진에서 alert으로 "필수 입력 항목입니다"를 표현한다.

validateObject( )

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

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

Sample

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

visible( flag )

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

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