PropertyEventMethod찾아보기
WebSquare.uiplugin.checkcombobox - 5.0_1.3521B.20190311.114514

HTML의 select Tag에서 확장된 기능을 제공하는 컴포넌트로 selectbox와 checkbox가 결합되어있어 항목을 다중으로 선택 할 수 있다.
본 컴포넌트는 최상위 div Tag로, 하위에는 여러가지 Tag이 결합되어 구현되어있다.

Type

uiplugin

Property Summary

allOption
[default:false, true] 전체항목 표시 여부로 label은 "-전체-" 로 value는 "all" 로 설정된다
appearance
xforms select1의 appearance속성
checkboxClickSync
[default:false, true] 목록의 checkbox를 클릭시 선택된 아이템셋과 싱크를 맞출지 여부
checkDisabledOnAllCheck
[default:true, false]
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 이벤트에 의해 닫을지 여부
delimiter
displayMode속성에서 참조하고 있으며 value와 label을 함께 표현 할 때 사용하는 구분자이다.
direction
[defulat:auto, down, up] 항목의 열림 방향
disabled
[default:false, true] HTML의 disabled속성과 동일한 기능을 제공하며 컴포넌트를 비활성화 시킨다
displayAllOptionLabel
[default:false, true] 전체항목을 선택한 경우, 선택된 아이템 label 전체를 출력하지 않고, 전체선택으로 출력
displaymessage
[default:false, true] validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 표시 할지의 여부.
displayMode
[default:label, value delim label, label delim value] 항목의 표현 방법으로 label과 value를 함께 표현 할 수 있다
escape
<>&"를 HTML Escape 문자로 변환하여 화면에 표시한다
id
컴포넌트의 ID로 전역객체로 할당되며 script에서 본 id로 컴포넌트에 접근이 가능하다
invalidMessage
validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 본 속성의 값으로 표현되는 기능으로 displaymessage속성이 true로 되어있어야 한다.
invalidMessageFunc
validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 별도로 정의 한 Function에서 동적으로 표현 할 수 있는 기능으로 정의 된 function의 이름을 명시한다.
labelWidthAuto
[default:false, true]
mandatory
[default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부
ref
DataCollection의 value 경로로 컴포넌트와 DataCollection의 value를 binding을 시킬 때 사용하며 "data:"라는 prefix는 필수로 붙여주어야 한다.
separator
[default:" "(space)] 선택 된 항목의 label을 나열(표현)하기 위한 구분자이다
sortMethod
[default:ascending, descending] sortOption속성에서 참조하며 sortOption에 정의 된 값에 대한 정렬 방법
sortOption
[label,value] 항목을 label 또는 value를 기준으로 정렬 할 때 사용된다.
submenuSize
[default:auto, fixed] labelWidthAuto속성이 true인 경우 미동작하며 목록(항목)창 크기를 label에 맞출지 기본 width로 고정 할지에 대한 설정
tabIndex
Tab Key를 이용 한 컴포넌트의 포커스 순서로 HTML의 tabindex속성과 동일한 기능을 제공한다
title
HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다
useLocale
[default:false, true] Client 다국어를 이용하여 항목의 label에 표현되는 값을 다국어 key를 이용하여 표현 할 지에 대한 설정이다.( 세부 내용은 Client 다국어 가이드 참고 )
userData1
사용자 정의 데이터 속성
userData2
사용자 정의 데이터 속성
userData3
사용자 정의 데이터 속성
validator
유효성 체크 함수명
visibleRowNum
표현 될 항목 행수
wmode
[default:false, true] wmode 사용 여부로 항목이 object(activeX 또는 flash)에 가려 질 경우 해당 속성을 사용한다.

Event Summary

onblur
포커스를 잃었을 때 발생
onchange
사용자가 항목을 변경하거나 API를 이용하여 value를 설정할 경우 발생하며 사용자가 항목을 변경했을때만 제어하고자 할 경우 onviewchange 이벤트를 사용한다.
onclick
마우스로 checkcombobox를 클릭했을 때 발생
onclose
목록을 선택하고 다른 영역을 클릭하여 목록이 닫혔을 때 발생한다
ondblclick
마우스로 checkcombobox를 더블 클릭했을 때 발생
onfocus
포커스를 얻었을 때 발생
onviewchange
목록의 값이 키보드나 마우스 조작을 통해 변경된 경우에만 발생하는 이벤트

Method Summary

addClass( className )
컴포넌트에 class를 추가한다
addItem( value , label , idx )
항목을 추가하는 기능으로 index를 주지 않으면 하위로 append된다.
bind( eventType , function )
컴포넌트의 이벤트를 동적으로 할당한다
changeClass( oldClassName , newClassName )
컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
checkAll( checked )
모든 항목을 선택하거나 해제 시킨다
deleteItem( idx )
index에 해당하는 항목을 삭제하며 allOption속성이 true로 설정 된 경우 항목의 index에 포함된다
focus( )
컴포넌트에 focus를 준다
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다
getGenerator( )
generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다
getID( )
웹스퀘어 컴포넌트의 id를 반환한다
getInfo( index )
index에 해당하는 항목의 정보가 담긴 JSON을 반환한다
getInfoArray( )
모든 항목들의 각각의 정보가 담긴 JSON을 Array에 담아 반환한다
getItemCount( )
항목 수를 반환한다
getItemDisabled( index )
index에 해당하는 항목의 활성화(disabled) 여부를 반환한다
getOpacity( )
CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다
getPluginName( )
웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다
getPosition( positionName )
컴포넌트의 left 또는 top의 위치 값을 반환한다
getReadOnly( )
현재 설정되어있는 readOnly 속성값을 반환한다
getSelectedInfo( )
선택 된 항목들의 정보가 담긴 JSON을 Array에 담아 반환한다
getSize( sizeName )
컴포넌트의 크기 값을 반환합니다
getStyle( propertyName )
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다
getStyleValue( style )
[deprecated]getStyle로 사용.
getText( separator )
선택 된 항목들의 label을 반환하는 기능으로 항목이 여러 개인 경우 separator속성에 정의 된 값을 구분자로 하여 반환한다.
getTextArray( )
선택 된 항목들의 label을 Array에 담아 반환한다
getTitle( )
title 속성값을 반환한다
getUserData( key )
setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
getValue( separator )
선택 된 항목들의 value를 반환하는 기능으로 항목이 여러 개인 경우 separator속성에 정의 된 값을 구분자로 하여 반환한다.
getValueArray( )
선택 된 항목들의 value를 담은 Array를 반환한다
hasClass( className )
컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다
hide( )
컴포넌트를 화면에서 보이지 않도록 숨깁니다
removeAll( isInitialize )
[default:false, true] 모든 항목을 삭제하는 기능으로 allOption이 정의 된 경우 isInitialize값을 true로 적용하면 해당 항목은 삭제되지 않는다
removeClass( className )
컴포넌트에 className의 class를 삭제한다.
setDisabled( disabled )
컴포넌트의 disabled 속성을 설정한다
setEventPause( evList , flag )
컴포넌트의 이벤트를 disable 또는 enable시킨다
setItemDisabled( idx , value )
해당 인덱스의 항목을 비활성화시키거나 활성화 시킵니다
setNodeSet( nodeset , label , value )
항목의 itemset 설정을 변경하는 기능으로 DataList와 연동 할 경우 nodeset 파라메터에 "data:" prefix를 꼭 붙여야한다
setOpacity( value )
컴포넌트의 CSS Opacity(불투명도)값를 설정한다
setPosition( left , top , mode )
컴포넌트의 위치(left,top)를 설정한다
setReadOnly( readOnly )
readOnly 속성값을 설정한다
setRef( ref )
ref 속성을 설정하는 기능으로 DataCollection과 연동시 "data:"라는 prefix를 꼭 붙여야한다.
setSelectedInfo( infoArray )
항목의 선택여부가 담긴 정보(JSON)를 기반으로 항목을 선택/해지한다
setSize( width , heigth )
컴포넌트의 크기(width,height)를 설정한다
setStyle( propertyName , value )
컴포넌트의 property별 style을 설정한다
setText( label )
파라메터로 넘어온 label이 항목에 있는 경우 해당 항목이 선택되며 separator속성에 정의 한 구분자로 label간의 구분자를 넣어야 한다.
setUserData( key , value )
컴포넌트에 사용자 데이터를 설정한다
setValue( value )
파라메터로 넘어온 value가 항목에 있는 경우 해당 항목이 선택되며 해당값으로 value가 할당된다.
show( displayType )
컴포넌트를 화면에 보이도록 설정한다.
toggleClass( className )
컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
trigger( type , array )
컴포넌트에 등록 된 특정 이벤트를 발생시킨다
unbind( type , function )
컴포넌트에 등록 된 이벤트를 제거한다
unbindRef( )
ref 바인딩을 해제합니다
validateObject( )
컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
visible( flag )
[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.

Property Detail

allOption
[default:false, true] 전체항목 표시 여부로 label은 "-전체-" 로 value는 "all" 로 설정된다.
appearance
xforms select1의 appearance속성
checkboxClickSync
[default:false, true] 목록의 checkbox를 클릭시 선택된 아이템셋과 싱크를 맞출지 여부
checkDisabledOnAllCheck
[default:true, false]
전체 선택시 disabled 처리된 항목도 함께 선택하는 기능. (5.0_1.2701A.20170714.211228 버전에서 추가.)
true (기본 값): 전체 선택 시 disabled 처리된 항목도 함께 선택.
false: 전체 선택 시 disabled 처리된 항목은 선택하지 않음.
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 이벤트에 의해 닫을지 여부
delimiter
displayMode속성에서 참조하고 있으며 value와 label을 함께 표현 할 때 사용하는 구분자이다.
displayMode속성의 "delim"에 해당하는 값이 본 속성에 정의 된 값이다.
direction
[defulat:auto, down, up] 항목의 열림 방향.
disabled
[default:false, true] HTML의 disabled속성과 동일한 기능을 제공하며 컴포넌트를 비활성화 시킨다.
displayAllOptionLabel
[default:false, true] 전체항목을 선택한 경우, 선택된 아이템 label 전체를 출력하지 않고, 전체선택으로 출력
displaymessage
[default:false, true] validate API를 호출 하였을 때 검증 실패에 대한 결과 메세지를 표시 할지의 여부.
기본적으로 엔진에서 정의 된 메세지가 표현되며 별도의 메세지를 정의하고자 할 때는 invalidMessageFunc속성을 이용한다.
displayMode
[default:label, value delim label, label delim value] 항목의 표현 방법으로 label과 value를 함께 표현 할 수 있다.delim(구분자)는 delimiter속성에 정의 된 값을 참조한다.
escape
<>&"를 HTML Escape 문자로 변환하여 화면에 표시한다.
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 "필수 검증 항목입니다."; } }
labelWidthAuto
[default:false, true]
주의 사항으로 style의 position이 absolute로 되어있고 우측에 컴포넌트가 배치 되어있을 경우 UI가 틀어질 수 있음으로 우측에 컴포넌트가 없도록 설계되거나 컴포넌트들의 position을 relative로 설정해야한다.
mandatory
[default:false, true]validate API를 호출 시 필수입력을 체크 할지의 여부.
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
separator
[default:" "(space)] 선택 된 항목의 label을 나열(표현)하기 위한 구분자이다.
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속성과 동일한 기능을 제공한다.
title
HTML의 title속성과 동일한 기능으로 명시 된 값을 브라우저에서 마우스 over시 툴팁형태로 표현한다.
useLocale
[default:false, true] Client 다국어를 이용하여 항목의 label에 표현되는 값을 다국어 key를 이용하여 표현 할 지에 대한 설정이다.( 세부 내용은 Client 다국어 가이드 참고 )
본 속성에 추가적으로 영향을 받는 속성으로는 chooseOptionLabel이 있으며 해당 속성에도 다국어 key가 정의되어야한다.
userData1
사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2
사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3
사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.
validator
유효성 체크 함수명
visibleRowNum
표현 될 항목 행수.
wmode
[default:false, true] wmode 사용 여부로 항목이 object(activeX 또는 flash)에 가려 질 경우 해당 속성을 사용한다.
wmode가 true이면 object 태그보다 상위에 보이도록 하는 설정으로 본 컴포넌트에 wmode를 설정하는 것이 아닌 object(activeX, flash 등)태그의 wmode를 사용하는 것을 권장한다.

Event Detail

onblur
포커스를 잃었을 때 발생
Parameter
nametypedescription
eObject이벤트 객체
onchange
사용자가 항목을 변경하거나 API를 이용하여 value를 설정할 경우 발생하며 사용자가 항목을 변경했을때만 제어하고자 할 경우 onviewchange 이벤트를 사용한다.
이벤트 핸들러(function)에서는 this를 이용하여 컴포넌트에 접근이 가능하다. ex)this.getValue();
onclick
마우스로 checkcombobox를 클릭했을 때 발생
Parameter
nametypedescription
eObject이벤트 객체
onclose
목록을 선택하고 다른 영역을 클릭하여 목록이 닫혔을 때 발생한다.
Parameter
nametypedescription
flagBooleantrue : 다른 영역을 클릭하여 목록이 닫혔을 때 false : 화살표를 클릭하거나 엔터키를 눌러서 목록이 닫혔을 때
ondblclick
마우스로 checkcombobox를 더블 클릭했을 때 발생
Parameter
nametypedescription
eObject이벤트 객체
onfocus
포커스를 얻었을 때 발생
Parameter
nametypedescription
eObject이벤트 객체
onviewchange
목록의 값이 키보드나 마우스 조작을 통해 변경된 경우에만 발생하는 이벤트. 스크립트를 통해 값이 변경된 경우에는 해당 이벤트가 발생하지 않습니다. (native onchange 이벤트와 유사합니다.)
Parameter
nametypedescription
infoJSONoldInfo, newInfo, oldValue, newValue를 포함한 오브젝트를 반환합니다. <String> info.oldValue : 이전 값 <String> info.newValue : 변경된 값 <Array> info.oldInfo : 이전에 상태를 기준으로 전체 항목들의 각각을 JSON으로 변환하여 저장한 배열 <Array> info.newInfo : 변경 된 후의 상태를 기준으로 전체 항목들의 각각을 JSON으로 변환하여 저장한 배열
Sample
<script ev:event="onviewchange( info )"><![CDATA[ var oldValue = info.oldValue; //이전 value var newValue = info.newValue; //현재 value var oldInfoArr = info.oldInfo; //이전 상태의 항목 정보 Array var newInfoArr = info.newInfo; //현재 상태의 항목 정보 Array //현재 상태의 항목 중 첫번째 항목에 대한 세부 정보에 접근 할 경우 var tmpInfo = newInfoArr[0]; var tmpInfoValue = tmpInfo.value; //return 예시 ) "1" var tmpInfoLabel = tmpInfo.label; //return 예시 ) "사과" var tmpInfoChecked = tmpInfo.checked; //return 예시 ) true var tmpInfoIndex = tmpInfo.index; //return 예시 ) 0 ]]></script>

Method Detail

addClass( className )
컴포넌트에 class를 추가한다.
Parameter
nametyperequireddescription
classNameStringY추가하고 싶은 class의 이름
Sample
//input1 컴포넌트에 oddClass 라는 class를 추가 할 때 input1.addClass("oddClass");
addItem( value , label , idx )
항목을 추가하는 기능으로 index를 주지 않으면 하위로 append된다.
주의 사항으로는 allOption 속성을 사용 할 경우 해당 item도 index에 포함되며 chooseOption속성은 index에 포함되지 않음.
Parameter
nametyperequireddescription
valueStringY항목의 value
labelStringY항목의 label
idxNumberN항목이 추가 될 index
Return
typedescription
Number추가 된 항목의 index
Sample
//아래와 같이 항목을 추가하지 않고 chooseOption속성과 allOption속성이 true로 정의 한 경우 <xf:checkcombobox id="checkcombobox1" chooseOption="true" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"></xf:checkcombobox> //index를 지정하지 않고 항목 추가 checkcombobox1.addItem( "1" , "사과"); //결과 - "전체 선택" 항목 하위로(제일 마지막에) 추가된다. 항목의 순서는 "전체 선택", "사과" 가 된다. // "선택"(chooseOption)은 선택 가능 한 항목에는 빠져있고 항목이 선택되지 않은 경우 label에 표현된다. //index를 0으로 지정하여 항목 추가 checkcombobox1.addItem( "2" , "오렌지",0); //결과 - 0번째에 항목이 추가되어 "전체 선택" 항목 위에 추가된다. 항목의 순서는 "오렌지", "전체 선택", "사과" 가 된다. // "선택"(chooseOption)은 선택 가능 한 항목에는 빠져있고 항목이 선택되지 않은 경우 label에 표현된다.
bind( eventType , function )
컴포넌트의 이벤트를 동적으로 할당한다.
Parameter
nametyperequireddescription
eventTypeStringY할당 할 이벤트명.
functionFunctionY동적으로 할당 할 이벤트의 핸들러 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
nametyperequireddescription
oldClassNameStringY삭제 할 class의 이름
newClassNameStringY추가 할 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");
checkAll( checked )
모든 항목을 선택하거나 해제 시킨다.
Parameter
nametyperequireddescription
checkedBooleanY선택/선택해제 값 (true/false)
Sample
//전체 선택 checkcombobox1.checkAll(true); //전체 해제 checkcombobox1.checkAll(false);
deleteItem( idx )
index에 해당하는 항목을 삭제하며 allOption속성이 true로 설정 된 경우 항목의 index에 포함된다.
Parameter
nametyperequireddescription
idxNumberN삭제 할 항목의 index
Return
typedescription
JSON삭제된 항목의 정보가 담긴 JSON
<String> label : 항목의 label. <String> value : 항목의 value.
Sample
//아래와 같이 항목을 추가하고 chooseOption속성과 allOption속성이 true로 정의 한 경우 <xf:checkcombobox id="checkcombobox1" chooseOption="true" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> </xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> var returnValue = checkcombobox1.deleteItem(0); //allOption이 true로 정의되어있음으로 allOption에 대한 항목이 삭제된다. //return 예시 ) {label: "전체 선택", value: "all"}
focus( )
컴포넌트에 focus를 준다.
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다.
Return
typedescription
Booleandisabled 속성값
Sample
var returnValue = componentId.getDisabled(); return 예시 ) false
getGenerator( )
generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다.
Return
typedescription
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
typedescription
String웹스퀘어 컴포넌트의 id
Sample
//동적으로 웹스퀘어 컴포넌트를 파라메터로 받았을 경우 아래와 같이 사용 할 수 있다. function fn_validCheck(tmpObj){ //tmpObj가 input1 이라는 ID를 가지고 있는 경우 var compID = tmpObj.getID(); //return 예시 ) "input1" }
getInfo( index )
index에 해당하는 항목의 정보가 담긴 JSON을 반환한다
Parameter
nametyperequireddescription
indexIntegerY조회 대상 index
Return
typedescription
JSON항목의 세부 정보가 담긴 JSON
<Number> index : 항목의 index <String> label : 항목의 label <String> value : 항목의 value <Boolean> checked : 항목의 선택 여부
Sample
//아래와 같이 항목을 추가하고 chooseOption속성과 allOption속성이 true로 정의 한 경우 <xf:checkcombobox id="checkcombobox1" chooseOption="true" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> var returnValue = checkcombobox1.getInfo(1); //allOption이 true임으로 1번째가 사과 항목이다. //return 예시 ) {index: 1, label: "사과", value: "1", checked: false}
getInfoArray( )
모든 항목들의 각각의 정보가 담긴 JSON을 Array에 담아 반환한다.
Return
typedescription
Array모든 항목들의 정보(JSON)가 담긴 array
<JSON> info : 항목의 정보가 담긴 JSON
Sample
//아래와 같이 항목을 추가하고 chooseOption속성과 allOption속성이 true로 정의 한 경우 <xf:checkcombobox id="checkcombobox1" chooseOption="true" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> var listArray = checkcombobox1.getInfoArray(); //사과 항목의 정보를 꺼내 올 경우 var tmpListObj = listArray[1]; //return 예시 ) {index: 1, label: "사과", value: "1", checked: false} //사과 항목의 value를 꺼내 올 경우 var tmpListValue = tmpListObj.value; return 예시 ) "1"
getItemCount( )
항목 수를 반환한다.
Return
typedescription
Number항목 수
Sample
//총 2개의 항목이 있는 경우 var returnValue = checkcombobox1.getItemCount(); //return 예시 ) 2
getItemDisabled( index )
index에 해당하는 항목의 활성화(disabled) 여부를 반환한다.
Parameter
nametyperequireddescription
indexNumberY항목의 index
Return
typedescription
Boolean해당 항목의 비활성화 여부
Sample
//첫번째 항목이 활성화 되어있고 첫번째 항목의 활성여부를 반환 받고자 할 때. var returnValue = checkcombobox1.getItemDisabled(0); //return 예시 ) false
getOpacity( )
CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다.
Return
typedescription
IntegerOpacity 값
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"
getPluginName( )
웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다.
Return
typedescription
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
nametyperequireddescription
positionNameStringY[left,top]위치 종류
Return
typedescription
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
typedescription
Boolean현재 설정되어있는 readOnly 속성
Sample
var returnValue = componentId.getReadOnly(); //return 예시 ) false
getSelectedInfo( )
선택 된 항목들의 정보가 담긴 JSON을 Array에 담아 반환한다.
Return
typedescription
Array선택 된 항목들의 정보(JSON)가 담긴 array
Sample
//아래와 같이 항목을 추가하고 사과 항목이 선택 된 경우 <xf:checkcombobox id="checkcombobox1" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> var selectedArr = checkcombobox1.getSelectedInfo(); //return 예시 ) [{index: 0, label: "사과", value: "1", checked: true}] //첫번째 항목(사과)을 꺼내 올 경우 var selectedObj = selectedArr[0]; //return 예시 ) {index: 0, label: "사과", value: "1", checked: true} //첫번째 항목의 value를 꺼내 올 경우 var selectedValue = selectedObj.value; //return 예시 ) "1"
getSize( sizeName )
컴포넌트의 크기 값을 반환합니다.%로 설정된 경우, 픽셀로 변환하여 반환한다.
Parameter
nametyperequireddescription
sizeNameStringY[height,innerHeight,outerHeight,outerMarginHeight,width,innerWidth,outerWidth,outerMarginWidth]크기 값의 종류. szieName별 계산 방법은 아래를 참고.
height : element.clientHeight innerHeight : element.clientHeight + padding outerHeight : element.clientHeight + padding + border outerMarginHeight : element.clientHeight + padding + border + margin width : element.clientWidth innerWidth : element.clientWidth + padding outerWidth : element.clientWidth + padding + border outerMarginWidth : element.clientWidth + padding + border + margin
Return
typedescription
Number컴포넌트의 크기 값
Sample
var returnValue = componentId.getSize("width"); // returnValue는 픽셀 단위의 크기 값이다. %로 설정된 경우, 픽셀로 변환하여 반환한다. //return 예시 ) 100
getStyle( propertyName )
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다.
Parameter
nametyperequireddescription
propertyNameStringY반환 할 style의 property 이름
Return
typedescription
Stringstyle의 속성값
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
nametyperequireddescription
styleStringY정의 된 style에서 사용자가 반환 받고자하는 속성명.
Return
typedescription
Stringstyle 속성에 정의 된 값(색을 반환하는 경우에는 색HexCode로 반환)
getText( separator )
선택 된 항목들의 label을 반환하는 기능으로 항목이 여러 개인 경우 separator속성에 정의 된 값을 구분자로 하여 반환한다.
파라메터로 separator를 넘겨 준 경우 해당 값이 구분자로 설정이 되어 반환되며 어떤 separator도 정의 하지 않은 경우에는 공백(space)이 구분자로 사용된다.
Parameter
nametyperequireddescription
separatorStringN항목 구분자
Return
typedescription
String선택 된 항목들의 label이 담긴 문자열
Sample
//항목 중 "사과"와 "오렌지"가 선택 된 경우 var returnValue = checkcombobox1.getText(); //return 예시 ) "사과 오렌지" //구분자 , 적용 var returnValue = checkcombobox1.getText(","); //return 예시 ) "사과,오렌지"
getTextArray( )
선택 된 항목들의 label을 Array에 담아 반환한다.
Return
typedescription
Array선택 된 항목들의 label이 담긴 Array
Sample
//항목 중 "사과"와 "오렌지"가 선택 된 경우 var returnValue = checkcombobox1.getTextArray(); //return 예시 ) ["사과", "오렌지"]
getTitle( )
title 속성값을 반환한다.
Return
typedescription
Stringtitle 속성값.
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
nametyperequireddescription
keyStringY임의 데이터의 키
Return
typedescription
Stringkey에 해당하는 데이터
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"
getValue( separator )
선택 된 항목들의 value를 반환하는 기능으로 항목이 여러 개인 경우 separator속성에 정의 된 값을 구분자로 하여 반환한다.
파라메터로 separator를 넘겨 준 경우 해당 값이 구분자로 설정이 되어 반환되며 어떤 separator도 정의 하지 않은 경우에는 공백(space)이 구분자로 사용된다.
Parameter
nametyperequireddescription
separatorStringN항목 구분자
Return
typedescription
String선택된 항목들의 value
Sample
//value가 "1"과 "2"인 항목이 선택 된 경우 //기본 API를 이용하여 꺼내 올 때 var returnValue = checkcombobox1.getValue(); //return 예시 ) "1 2" // "," 구분자를 이용하여 꺼내 올 때 var returnValue = checkcombobox1.getValue(","); //return 예시 ) "1,2"
getValueArray( )
선택 된 항목들의 value를 담은 Array를 반환한다.
Return
typedescription
Array선택 된 항목들의 value가 담긴 Array
Sample
//value가 "1"과 "2"인 항목이 선택 된 경우 var returnValue = checkcombobox1.getValueArray(); //return 예시 ) ["1", "2"]
hasClass( className )
컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다.
Parameter
nametyperequireddescription
classNameStringY검색 할 className
Return
typedescription
Booleanclass를 가지고 있는지의 여부
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( )
컴포넌트를 화면에서 보이지 않도록 숨깁니다.
removeAll( isInitialize )
[default:false, true] 모든 항목을 삭제하는 기능으로 allOption이 정의 된 경우 isInitialize값을 true로 적용하면 해당 항목은 삭제되지 않는다.
Parameter
nametyperequireddescription
isInitializeBooleanNallOption 항목 삭제 유무
Sample
//allOption의 항목이 정의 된 경우 allOption을 포함한 모든 항목이 삭제 checkcombobox1.removeAll(); //allOption의 항목이 정의 된 경우 allOption의 항목을 제외한 항목이 삭제 checkcombobox1.removeAll(true);
removeClass( className )
컴포넌트에 className의 class를 삭제한다.
기본 설정은 addClass API를 통해 추가 된 class만 적용되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>
Parameter
nametyperequireddescription
classNameStringY삭제 할 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 삭제 input1.removeClass("tmpInputClass");
setDisabled( disabled )
컴포넌트의 disabled 속성을 설정한다. disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력한다.
Parameter
nametyperequireddescription
disabledBooleanYdisabled 속성을 활성화 시키려면 true 비활성화 시키려면 false
Sample
//컴포넌트의 disabled 적용 componentId.setDisabled(true);
setEventPause( evList , flag )
컴포넌트의 이벤트를 disable 또는 enable시킨다.
Parameter
nametyperequireddescription
evListStringN대상 이벤트 목록. 해당 인자가 주어지지 않을 경우 해당 컴포넌트의 모든 사용자 이벤트가 대상이 된다. (null을 지정하면 된다.)
flagBooleanYtrue인 경우 pause시키며, false인 경우 pause를 해제한다.
Sample
input1.setEventPause("onclick", true); //onclick이벤트를 동적으로 pause 한다. input1.setEventPause("onfocus,onblur", false); //onfocus이벤트와 onblur이벤트의 pause를 해제한다. input1.setEventPause(null, true); //input에 등록된 모든 사용자 이벤트를 pause 한다.
setItemDisabled( idx , value )
해당 인덱스의 항목을 비활성화시키거나 활성화 시킵니다.
Parameter
nametyperequireddescription
idxNumberY비활성화 시키려는 항목의 인덱스
valueBooleanY활성화 여부
Sample
checkcombobox1.setItemDisabled(0, true); 첫번째 항목을 비활성화한다. 해당 항목을 선택하거나 선택을 해제할 수 없다.
setNodeSet( nodeset , label , value )
항목의 itemset 설정을 변경하는 기능으로 DataList와 연동 할 경우 nodeset 파라메터에 "data:" prefix를 꼭 붙여야한다.
Parameter
nametyperequireddescription
nodesetStringYDataList의 ID로 "data:"이라는 prefix를 붙여야한다. ( 또는 InstanceData의 XPath )
labelStringNlabel에 설정 될 column의 id로 값을 할당하지 않으면 기존에 설정된 값이 그대로 적용된다. ( 또는 label에 설정 할 nodeset 하위의 XPath )
valueStringNvalue에 설정 될 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> //checkcombobox1의 itemset설정을 DataCollection의 dataList1로 변경하고 label은 lbl column으로 value는 code column으로 설정 할 경우 checkcombobox1.setNodeSet('data:dataList1','lbl','code'); //dataList1과 컬럼이 동일하고 실 data만 다른 dataList2로 변경 할 경우 checkcombobox1.setNodeSet('data:dataList2'); //기존에 할당 된 label의 lbl과 value의 code는 그대로 유지되고 dataList만 변경된다.
setOpacity( value )
컴포넌트의 CSS Opacity(불투명도)값를 설정한다.
Parameter
nametyperequireddescription
valueNumberYOpacity 값 (0과 1사이의 실수)
Sample
componentId.setOpacity(0.45);
setPosition( left , top , mode )
컴포넌트의 위치(left,top)를 설정한다.
Parameter
nametyperequireddescription
leftNumberYleft의 값 또는 null.
topNumberYtop의 값 또는 null.
modeStringN[defulat:absolute, delta]absolute이면 x,y로 현재 값을 설정하고 delta이면 현재 값에 x,y값만큼을 더해서 설정.
Sample
//컴포넌트의 top만 100px로 설정. componentId.setPosition(null, 100);
setReadOnly( readOnly )
readOnly 속성값을 설정한다. readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력합니다.
Parameter
nametyperequireddescription
readOnlyBooleanYreadOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false
Sample
//컴포넌트의 readonly 적용. componentId.setReadOnly(true);
setRef( ref )
ref 속성을 설정하는 기능으로 DataCollection과 연동시 "data:"라는 prefix를 꼭 붙여야한다.
명시하지 않는 경우 InstanceData의 XPath로 인식한다.
Parameter
nametyperequireddescription
refStringY적용 할 ref의 경로
Sample
//dataMap1의 hobby key와 checkcombobox1 컴포넌트의 value를 binding 하는 경우 checkcombobox1.setRef("data:dataMap1.hobby"); //InstanceData의 res/userData/hobby 과 연동 할 경우. checkcombobox1.setRef("res/userData/hobby");
setSelectedInfo( infoArray )
항목의 선택여부가 담긴 정보(JSON)를 기반으로 항목을 선택/해지한다.
Parameter
nametyperequireddescription
infoArrayArrayY선택/해지하려는 각 항목의 정보가 담긴 JOSN을 담고 있는 Array
Sample
//아래와 같이 항목을 추가하고 allOption속성을 true로 정의 한 경우 <xf:checkcombobox id="checkcombobox1" allOption="true" style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> //"오렌지" 항목을 선택하고자 할 때 - allOption항목이 true임으로 해당 항목이 0번째 index이다. checkcombobox1.setSelectedInfo([{index:2,checked:true}]); //"사과"와 "오렌지"항목을 선택하고자 할 때 - allOption항목이 true임으로 해당 항목이 0번째 index이다. checkcombobox1.setSelectedInfo([{index:1,checked:true},{index:2,checked:true}]);
setSize( width , heigth )
컴포넌트의 크기(width,height)를 설정한다.
Parameter
nametyperequireddescription
widthNumberY새로 설정할 컴포넌트의 width값 또는 null
heigthNumberY새로 설정할 컴포넌트의 height값 또는 null
Sample
//컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);
setStyle( propertyName , value )
컴포넌트의 property별 style을 설정한다.
Parameter
nametyperequireddescription
propertyNameStringYstyle 속성 이름
valueStringY적용 할 style의 값
Sample
//컴포넌트의 width를 200px로 설정 할 경우 componentId.setStyle("width", "200px"); //배경색을 olive로 변경 할 경우 componentId.setStyle("background-color","olive");
setText( label )
파라메터로 넘어온 label이 항목에 있는 경우 해당 항목이 선택되며 separator속성에 정의 한 구분자로 label간의 구분자를 넣어야 한다.
separator속성을 미지정 한 경우 공백(space)를 통해 항목을 구분한다.
Parameter
nametyperequireddescription
labelStringY선택하고자 하는 항목들의 label 문자열
Sample
//아래와 같이 항목을 추가하고 separator속성을 ","로 정의 한 경우 <xf:checkcombobox id="checkcombobox1" separator="," style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> //"사과"와 "오렌지"항목을 선택 할 경우 checkcombobox1.setText("사과,오렌지");
setUserData( key , value )
컴포넌트에 사용자 데이터를 설정한다. 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하며 log에 관련 내용이 출력 된다.
Parameter
nametyperequireddescription
keyStringY임의 데이터의 키
valueStringY임의 데이터의 값
Sample
//컴포넌트에 'data'라는 key로 'WebSquare'라는 값을 설정 할 경우 componentId.setUserData("data", "WebSquare"); //아래와 같이 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하다. componentId.setUserData("title", "WebSquare"); //log 표현 예시 ) !!!WARNING - [title] can't define as UserData
setValue( value )
파라메터로 넘어온 value가 항목에 있는 경우 해당 항목이 선택되며 해당값으로 value가 할당된다.
다건을 한번에 설정 할 경우 separator속성에 정의 한 구분자로 value간의 구분자를 넣어야 한다.
separator속성이 정의 되지 않은 경우 공백(space)을 통해 value를 구분한다.
Parameter
nametyperequireddescription
valueStringY선택하려는 항목의 value
Sample
//아래와 같이 항목을 추가하고 separator속성을 ","로 정의 한 경우 <xf:checkcombobox id="checkcombobox1" separator="," style="position: relative;width: 148px;height: 21px;" appearance="minimal" direction="auto"> <xf:choices> <xf:item> <xf:label><![CDATA[사과]]></xf:label> <xf:value><![CDATA[1]]></xf:value> </xf:item> <xf:item> <xf:label><![CDATA[오렌지]]></xf:label> <xf:value><![CDATA[2]]></xf:value> </xf:item> </xf:choices> </xf:checkcombobox> //"사과"와 "오렌지"항목을 선택 할 경우 checkcombobox1.setValue("1,2");
show( displayType )
컴포넌트를 화면에 보이도록 설정한다.
엔진 내부적으로는 CSS를 display속성과 visibility:show;으로 처리한다.
Parameter
nametyperequireddescription
displayTypeStringN[default:block ,inline ,none ,""]display의 속성 값.
Sample
//display 속성이 "block"이 된다. componentId.show(); //class에 적용된 display 속성 값을 다시 복구. componentId.show("");
toggleClass( className )
컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
기본 설정은 addClass API를 통해 추가 된 class만 삭제되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>
Parameter
nametyperequireddescription
classNameStringY설정 할 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
nametyperequireddescription
typeStringY발생시킬 이벤트 이름
arrayArrayN이벤트 핸들러에 전달할 파라미터 배열
Sample
//input1 컴포넌트에 onclick이벤트를 발생시킨다. input1.trigger("onclick"); //input1에 onviewchange이벤트를 발생시키고 핸들러 함수에 (1,2) 인자를 전달하여 호출한다. input1.trigger("onviewchange", [1,2]);
unbind( type , function )
컴포넌트에 등록 된 이벤트를 제거한다.
Parameter
nametyperequireddescription
typeStringN제거할 이벤트 이름. 생략할 경우 해당 컴포넌트의 모든 이벤트를 제거한다.
functionFunctionN제거할 이벤트의 핸들러 함수. 생략할 경우 해당 이벤트 type으로 등록된 모든 핸들러 함수를 제거한다.
Sample
//input1에 등록된 모든 이벤트를 제거 input1.unbind(); //input1에 등록된 onviewchange이벤트 핸들러 함수를 모두 제거 input1.unbind("onviewchange"); //input1에 등록된 onviewchange이벤트에서 func1 이벤트 핸들러를 제거 input1.unbind("onviewchange", func1);
unbindRef( )
ref 바인딩을 해제합니다
validateObject( )
컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
유효성 관련 속성 : mandatory, minLength, maxLength, minByteLength, maxByteLength
(버전 정보: 5.0_1.2783B.20170908.145609 버전에서 추가.)
Return
typedescription
Objectobject 유효성 검사 결과 객체
<String> object.callerId 유효성 검사 대상 컴포넌트 ID <String> object.type 유효성 검사 항목 <Boolean> object.value 유효성 검사 결과 값
Sample
//아래와 같이 checkcombobox1 컴포넌트에 mandatory 속성을 정의했을 경우 <xf:checkcombobox appearance="minimal" id="checkcombobox1" style="position: absolute;width:249px;height:57px;left:74px;top:459px;" mandatory="true"> <xf:choices> <xf:itemset nodeset="data:dataList2"> <xf:label ref="label"></xf:label> <xf:value ref="value"></xf:value> </xf:itemset> </xf:choices> </xf:checkcombobox> var returnObj = checkcombobox1.validateObject(); //return 예시 - checkcombobox의 값이 없을 경우 ) 비어있는 객체가 반환 //return 예시 - checkcombobox의 값이 있을 경우) returnObj 객체 반환 returnObj.callerId = "checkcombobox1" returnObj.type = "mandatory" returnObj.value = "" input 컴포넌트의 displaymessage="true" 설정을 함께 사용하면 유효성 검사에서 false가 된 경우 엔진에서 설정 된 메세지가 alert으로 뜬다. //alert 메세지 예시 ) 필수 입력 항목입니다
visible( flag )
[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.
컴포넌트의 style 중 visibility 값을 설정한다. true이면 "visible", false이면 "hidden"을 설정.
Parameter
nametyperequireddescription
flagBooleanYvisibility 값을 설정할 값(true이면 "visible", false이면 "hidden"을 설정)