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

여러 항목 중에서 여러 항목을 selectbox의 형태로 선택할 수 있는 컴포넌트입니다.

Type

uiplugin

Property Summary

appearance
xforms select의 appearance속성
class
multiselect의 class 속성
defaultClass
multiselect의 defaultClass 속성
disabled
multiselect의 disabled 속성
displaymessage
검증 결과 메세지 표시 여부
escape
<>&"를 HTML Escape 문자로 변환하여 화면에 표시한다
id
multiselect 컴포넌트의 id
invalidMessage
검증실패 메세지
invalidMessageFunc
검증실패 메세지 함수
mandatory
필수항목여부
ref
model instance의 바인딩 정보
separator
선택된 항목이 여러 개일 때 구분할 구분자
tabIndex
multiselect의 tabIndex
toolTip
toolTip 속성
useLocale
다국어사용 여부
userData1
사용자 정의 데이터 속성
userData2
사용자 정의 데이터 속성
userData3
사용자 정의 데이터 속성
validator
유효성 체크 함수명

Event Summary

onblur
포커스를 잃었을 때 발생
onchange
입력되거나 선택된 값을 바꿀 때 발생
onclick
마우스로 multiselect를 클릭했을 때 발생
ondblclick
마우스로 multiselect를 더블 클릭했을 때 발생
onfocus
포커스를 얻었을 때 발생
onviewchange
목록의 값이 키보드나 마우스 조작을 통해 변경된 경우에만 발생하는 이벤트

Method Summary

addClass( className )
컴포넌트에 class를 추가한다
bind( eventType , function )
컴포넌트의 이벤트를 동적으로 할당한다
changeClass( oldClassName , newClassName )
컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
deleteItem( index )
인자로 넘겨진 index에 해당하는 항목을 삭제합니다
deleteSelectedItems( )
선택되어 있는 항목을 삭제합니다
focus( )
컴포넌트에 focus를 준다
getAllValue( )
컴포넌트의 모든 항목의 value를 반환합니다
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다
getGenerator( )
generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다
getID( )
웹스퀘어 컴포넌트의 id를 반환한다
getIdxValue( index )
해당 index의 항목의 value를 반환합니다
getItemCount( )
컴포넌트가 가진 항목 수를 반환합니다
getOpacity( )
CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다
getPluginName( )
웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다
getPosition( positionName )
컴포넌트의 left 또는 top의 위치 값을 반환한다
getReadOnly( )
현재 설정되어있는 readOnly 속성값을 반환한다
getSelectedIndex( separator )
선택된 항목들의 index를 반환합니다.
getSize( sizeName )
컴포넌트의 크기 값을 반환합니다
getStyle( propertyName )
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다
getStyleValue( style )
[deprecated]getStyle로 사용.
getText( separator )
현재 선택된 항목의 label을 반환합니다.
getTitle( )
title 속성값을 반환한다
getUserData( key )
setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
getValue( separator )
컴포넌트의 선택된 항목들의 value를 반환합니다.
hasClass( className )
컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다
hide( )
컴포넌트를 화면에서 보이지 않도록 숨긴다.
removeClass( className )
컴포넌트에 className의 class를 삭제한다.
setDisabled( disabled )
컴포넌트의 disabled 속성을 설정한다
setEventPause( evList , flag )
컴포넌트의 이벤트를 disable 또는 enable시킨다
setOpacity( value )
컴포넌트의 CSS Opacity(불투명도)값를 설정한다
setPosition( left , top , mode )
컴포넌트의 위치(left,top)를 설정한다
setReadOnly( readOnly )
readOnly 속성값을 설정한다
setRef( ref )
바인딩 된 ref 경로를 동적으로 변경합니다
setSelectedIndex( idx )
해당 인덱스에 해당하는 항목을 선택합니다
setSize( width , heigth )
컴포넌트의 크기(width,height)를 설정한다
setStyle( propertyName , value )
컴포넌트의 propertyName에 해당하는 style의 값을 설정합니다
setText( label )
인자로 넘겨진 label과 같은 label을 가지는 항목을 선택합니다.
setUserData( key , value )
컴포넌트에 사용자 데이터를 설정한다
setValue( value )
컴포넌트에 인자로 넘겨진 value와 같은 값을 가진 항목을 선택하고 model에 반영합니다
show( displayType )
컴포넌트를 화면에 보이도록 설정한다.
toggleClass( className )
컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
trigger( type , array )
컴포넌트에 등록 된 특정 이벤트를 발생시킨다
unbind( type , function )
컴포넌트에 등록 된 이벤트를 제거한다
unbindRef( )
ref 바인딩을 해제합니다
validate( )
multiselect의 validate를 체크합니다
validateObject( )
컴포넌트의 정의 된 유효성에 관련 속성값을 통해 유효성 검사를 실행한다.
visible( flag )
[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.

Property Detail

appearance
xforms select의 appearance속성
class
multiselect의 class 속성
defaultClass
multiselect의 defaultClass 속성
disabled
multiselect의 disabled 속성
displaymessage
검증 결과 메세지 표시 여부
escape
<>&"를 HTML Escape 문자로 변환하여 화면에 표시한다.
id
multiselect 컴포넌트의 id
invalidMessage
검증실패 메세지
invalidMessageFunc
검증실패 메세지 함수
mandatory
필수항목여부
ref
model instance의 바인딩 정보
separator
선택된 항목이 여러 개일 때 구분할 구분자
tabIndex
multiselect의 tabIndex
toolTip
toolTip 속성
useLocale
다국어사용 여부
userData1
사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2
사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3
사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.
validator
유효성 체크 함수명

Event Detail

onblur
포커스를 잃었을 때 발생
Parameter
nametypedescription
eObject이벤트 객체
onchange
입력되거나 선택된 값을 바꿀 때 발생
onclick
마우스로 multiselect를 클릭했을 때 발생
Parameter
nametypedescription
eObject이벤트 객체
ondblclick
마우스로 multiselect를 더블 클릭했을 때 발생
Parameter
nametypedescription
eObject이벤트 객체
onfocus
포커스를 얻었을 때 발생
Parameter
nametypedescription
eObject이벤트 객체
onviewchange
목록의 값이 키보드나 마우스 조작을 통해 변경된 경우에만 발생하는 이벤트. 스크립트를 통해 값이 변경된 경우에는 해당 이벤트가 발생하지 않습니다. (native onchange 이벤트와 유사합니다.)
Parameter
nametypedescription
infoObjectoldValue, newValue, oldSelectedIndex, newSelectedIndex를 포함한 오브젝트를 반환합니다. <String> info.oldValue : 이전 value <String> info.newValue : 변경된 value <Number> info.oldSelectedIndex : 이전 index <Number> info.newSelectedIndex : 변경된 index
Sample
<script ev:event="onviewchange( info )"><![CDATA[ var oldValue = info.oldValue; var newValue = info.newValue; var oldIndex = info.oldSelectedIndex; var newIndex = info.newSelectedIndex; ]]></script>

Method Detail

addClass( className )
컴포넌트에 class를 추가한다.
Parameter
nametyperequireddescription
classNameStringY추가하고 싶은 class의 이름
Sample
//input1 컴포넌트에 oddClass 라는 class를 추가 할 때 input1.addClass("oddClass");
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");
deleteItem( index )
인자로 넘겨진 index에 해당하는 항목을 삭제합니다.
Parameter
nametyperequireddescription
indexStringY삭제하고자 하는 항목의 index
Return
typedescription
Object삭제된 항목 오브젝트
{ label : new String(), value : new String(), xml : new Object() };
Sample
var returnValue = multiselect1.deleteItem(0); returnValue.label은 '빨강'이다. returnValue.value는 '#ff0000'이다. returnValue.xml은 [XML Object]이다. WebSquare.xml.serialize( returnVal.xml )로 XML String을 확인한다.
deleteSelectedItems( )
선택되어 있는 항목을 삭제합니다.
Sample
예 : 첫번째, 네번째 항목이 선택되어 있는 경우 var returnValue1 = multiselect1.deleteSelectedItems(); 첫번째, 네번째 항목이 삭제된다.
focus( )
컴포넌트에 focus를 준다.
getAllValue( )
컴포넌트의 모든 항목의 value를 반환합니다. 선택된 항목들은 공백으로 구분된 문자열로 반환합니다.
Return
typedescription
String모든 항목들의 value
Sample
예 : 첫번째, 네번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) var returnValue = multiselect1.getAllValue(); returnValue는 모든 항목의 값으로 '#ff0000 #000000 #00ff00 #0000ff ...'이다.
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" }
getIdxValue( index )
해당 index의 항목의 value를 반환합니다.
Parameter
nametyperequireddescription
indexNumberY해당 항목의 인덱스
Return
typedescription
String해당 index의 항목의 value
Sample
예 : 첫번째, 네번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) var returnValue = multiselect1.getIdxValue(0); returnValue는 '#ff0000'이다.
getItemCount( )
컴포넌트가 가진 항목 수를 반환합니다.
Return
typedescription
Number컴포넌트가 가진 항목 수
Sample
var returnValue = multiselect1.getItemCount();
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
getSelectedIndex( separator )
선택된 항목들의 index를 반환합니다.
항목이 여러 개인 경우, separator를 구분자로 하여 반환합니다.
separator를 설정하지 않은 경우 space를 구분자로 사용합니다.
Parameter
nametyperequireddescription
separatorStringN항목 구분자
Return
typedescription
Number선택된 항목들의 index
Sample
예 : 첫번째, 네번째 항목이 선택되어 있는 경우 var returnValue1 = multiselect1.getSelectedIndex(","); var returnValue2 = multiselect1.getSelectedIndex(); returnValue1은 '0,3'이다. returnValue2는 '0 3'이다.
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를 설정하지 않은 경우 space를 구분자로 사용합니다.
Parameter
nametyperequireddescription
separatorStringN항목 구분자
Return
typedescription
String선택된 항목들의 label
Sample
예 : 첫번째, 네번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) var returnValue = multiselect1.getText(','); returnValue는 '빨강,파랑'이다.
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를 설정하지 않은 경우 space를 구분자로 사용합니다.
Parameter
nametyperequireddescription
separatorStringN항목 구분자
Return
typedescription
String선택된 항목들의 value
Sample
예 : 첫번째, 네번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) var returnValue = multiselect1.getValue(','); returnValue는 '#ff0000,#0000ff'이다.
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( )
컴포넌트를 화면에서 보이지 않도록 숨긴다.
엔진 내부적으로는 CSS를 display:none;과 visibility:hidden;으로 처리한다.
Sample
componentId.hide();
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 한다.
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 경로를 동적으로 변경합니다.
Parameter
nametyperequireddescription
refStringY변경할 ref의 XPath
setSelectedIndex( idx )
해당 인덱스에 해당하는 항목을 선택합니다.
Parameter
nametyperequireddescription
idxNumberY선택하려는 항목의 인덱스
Sample
예 : 첫번째, 네번째 항목이 선택되어 있는 경우 multiselect1.setSelectedIndex(1); 첫번째, 두번째, 네번째 항목이 선택되어 있다.
setSize( width , heigth )
컴포넌트의 크기(width,height)를 설정한다.
Parameter
nametyperequireddescription
widthNumberY새로 설정할 컴포넌트의 width값 또는 null
heigthNumberY새로 설정할 컴포넌트의 height값 또는 null
Sample
//컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);
setStyle( propertyName , value )
컴포넌트의 propertyName에 해당하는 style의 값을 설정합니다.
Parameter
nametyperequireddescription
propertyNameStringY바꾸고 싶은 style 값의 이름
valueStringY설정할 style의 값
Sample
예: 컴포넌트 스타일 width를 변경하고자 하는 경우. componentId.setStyle("width", 100); 픽셀 단위를 기본으로 하며, componentId.setStyle("width", "100px"); 과 동일하다. %단위의 표현을 하고자 하면 componentId.setStyle("width", "100%"); 로 명시하여 준다.
setText( label )
인자로 넘겨진 label과 같은 label을 가지는 항목을 선택합니다.
여러 항목을 선택하려고 하는 경우는 label을 공백으로 구분하여 인자로 넘겨야 합니다.
Parameter
nametyperequireddescription
labelStringY선택하고자 하는 항목의 label
Sample
예 : 첫번째, 네번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) multiselect1.setText("검정"); 선택된 첫번째, 네번째 항목이 선택해제 되고, 검정색 항목만 선택된다. 만약 여러 항목을 선택하고자 할 경우, 공백(space)을 구분자로 한 문자열을 사용한다. var colorArr = []; colorArr[0] = "빨강" ; colorArr[1] = "파랑" ; colorArr[2] = "초록" ; multiselect1.setValue(colorArr.join(" ")); 빨강, 파랑, 초록색이 선택된다.
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와 같은 값을 가진 항목을 선택하고 model에 반영합니다.
Parameter
nametyperequireddescription
valueStringY선택하고자 하는 항목의 value
Sample
예 : 첫번째, 네번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) multiselect1.setValue("#000000"); 선택된 첫번째, 네번째 항목이 선택해제 되고, 검정색 항목만 선택된다. 만약 여러 항목을 선택하고자 할 경우, 공백(space)을 구분자로 한 문자열을 사용한다. var colorArr = []; colorArr[0] = "#ff0000" ; //빨강 colorArr[1] = "#0000ff" ; //파랑 colorArr[2] = "#00ff00" ; //초록 multiselect1.setValue(colorArr.join(" ")); 빨강, 파랑, 초록색이 선택된다.
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 바인딩을 해제합니다
validate( )
multiselect의 validate를 체크합니다. multiselect는 필수입력 여부만 체크합니다.
Sample
모든 항목이 선택 해제되어 있는 경우, var returnValue = multiselect1.validate(); returnValue는 false이다. 만약 하나의 항목이라도 선택되어 있는 경우는 true가 된다.
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
//아래와 같이 multiselect 컴포넌트에 mandatory 속성을 정의했을 경우 <xf:select appearance="minimal" id="multiselect1" style="position: absolute;width:272px;height:64px;left:889px;top:659px;" mandatory="true"> <xf:choices> <xf:itemset nodeset="data:dataList3"> <xf:label ref="label"></xf:label> <xf:value ref="value"></xf:value> </xf:itemset> </xf:choices> </xf:select> var returnObj = multiselect.validateObject(); //return 예시 - multiselect 값이 없을 경우 ) 비어있는 객체가 반환 //return 예시 - multiselect 값이 있을 경우) returnObj 객체 반환 returnObj.callerId = "multiselect" returnObj.type = "mandatory" returnObj.value = "" inputCalendar 컴포넌트의 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"을 설정)