WebSquare.uiplugin.selectbox

HTML에서 select와 같은 역할을 하는 컴포넌트입니다. 미리 선언된 항목들 중에서 한가지를 선택할 수 있습니다.

Type

uiplugin

Property Summary

allOption: 전체항목 표시 여부
appearance: xforms select1의 appearance속성
chooseOption: 선택옵션 표시 여부
chooseOptionLabel: 선택옵션 표시 메세지
class: selectbox의 class 속성
delimiter: 구분자
direction: 목록창 열림 방향
disabled: disabled 유무
disabledClass: disabled시에 적용될 class
displaymessage: 검증 결과 메세지 표시 여부
displayMode: 선택옵션 표시 방법
id: selectbox 컴포넌트의 id
invalidMessage: 검증실패 메세지
invalidMessageFunc: 검증실패 메세지 함수
labelWidthAuto: 가장 긴 항목의 크기에 맞게 출력 할지 여부
mandatory: 필수항목여부
ref: model instance의 바인딩 정보
setDataRemoveAll: removeAll시에 data 초기화 처리 사용 여부
sortMethod: 정렬방법
sortOption: 정렬옵션
submenuSize: 목록창 크기 조정 방법
tabIndex: selectbox의 tabIndex 속성
title: 접근성 지원용 속성
toolTip: toolTip 속성
useLocale: 다국어사용 여부
validator: 유효성 체크 함수명
visibleRowNum: 표시 항목행수
wmode: wmode 사용 여부

Event Summary

onblur: 포커스를 잃었을 때 발생
onchange: 선택항목 변경 시 발생
onclick: 마우스로 selectbox를 클릭했을 때 발생
ondblclick: 마우스로 selectbox를 더블 클릭했을 때 발생
onfocus: 포커스를 얻었을 때 발생

Method Summary

addClass( className ): 컴포넌트에 className의 이름을 가진 class를 추가합니다
addItem( value , label , idx ): 해당 인덱스에 항목을 추가한다
bind( type , function ): 컴포넌트의 이벤트를 동적으로 할당합니다
changeClass( oldClassName , newClassName ): 컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 치환합니다
deleteItem( idx ): 해당 인덱스의 항목을 삭제한다
focus( ): 객체에 focus를 줍니다
getDisabled( ): 현재 설정되어있는 disabled 속성을 반환합니다
getGeneratedComponent( id ): 동일한 index에 속한 다른 컴퍼넌트 객체를 가져옵니다
getGeneratedIndex( ): generator 반복부에서 해당 index를 반환합니다
getID( ): 웹스퀘어 컴포넌트의 id를 반환합니다
getItemCount( ): 목록의 항목 수를 반환합니다
getOpacity( ): 컴포넌트의 Opacity 값을 반환합니다
getPluginName( ): 웹스퀘어 컴포넌트의 pluginName을 반환합니다
getPosition( positionName ): 컴포넌트의 위치 값을 반환합니다
getReadOnly( ): 현재 설정되어있는 readOnly 속성을 반환합니다
getSelectedIndex( ): 선택된 항목의 index를 반환합니다
getSize( sizeName ): 컴포넌트의 크기 값을 반환합니다
getStyle( propertyName ): 컴포넌트의 propertyName에 해당하는 style의 값을 반환합니다
getStyleValue( style ): 컴포넌트의 style중에서 입력받은 style의 값을 반환합니다
getText( ): 현재 선택된 항목의 label을 반환합니다
getTitle( ): component의 title 속성을 가져온다
getUserData( key ): 설정된 사용자 임의의 데이터를 반환 합니다.
getValue( ): 현재 선택된 항목의 value값을 반환합니다
hasClass( className ): 컴포넌트가 className의 이름을 가진 class를 가지고 있는지 여부를 반환합니다
hide( ): 컴포넌트를 화면에서 보이지 않도록 숨깁니다
removeAll( isInitialize ): 모든 항목을 삭제한다.
removeClass( className ): 컴포넌트에 className의 이름을 가진 class를 삭제합니다
setDisabled( disabled ): 객체의 disabled 속성을 제어합니다
setNodeSet( nodeset , label , value ): itemset의 Model 바인딩 ref를 셋팅합니다
setOpacity( value ): 컴포넌트의 Opacity 값을 설정합니다
setPosition( left , top , mode ): 컴포넌트의 위치를 설정합니다
setReadOnly( readOnly ): 객체의 readOnly 속성을 제어합니다
setRef( 변경할 ): 바인딩 된 ref 경로를 동적으로 변경합니다
setSelectedIndex( idx ): 해당 인덱스에 해당하는 항목을 선택합니다
setSize( width , heigth ): 컴포넌트의 크기를 설정합니다
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 ): 컴포넌트의 이벤트를 동적으로 제거합니다
validate( ): selectbox의 validate를 체크합니다
visible( flag ): 컴포넌트의 style 중 visibility 값을 설정합니다

Property Detail

allOption: 전체항목 표시 여부
appearance: xforms select1의 appearance속성
chooseOption: 선택옵션 표시 여부
chooseOptionLabel: 선택옵션 표시 메세지
class: selectbox의 class 속성
delimiter: 구분자
direction: 목록창 열림 방향
disabled: disabled 유무
disabledClass: disabled시에 적용될 class
displaymessage: 검증 결과 메세지 표시 여부
displayMode: 선택옵션 표시 방법
id: selectbox 컴포넌트의 id
invalidMessage: 검증실패 메세지
invalidMessageFunc: 검증실패 메세지 함수
labelWidthAuto: 가장 긴 항목의 크기에 맞게 출력 할지 여부
mandatory: 필수항목여부
ref: model instance의 바인딩 정보
setDataRemoveAll: removeAll시에 data 초기화 처리 사용 여부
sortMethod: 정렬방법
sortOption: 정렬옵션
submenuSize: 목록창 크기 조정 방법
tabIndex: selectbox의 tabIndex 속성
title: 접근성 지원용 속성
toolTip: toolTip 속성
useLocale: 다국어사용 여부
validator: 유효성 체크 함수명
visibleRowNum: 표시 항목행수
wmode: wmode 사용 여부. wmode가 true이면 object 태그보다 상위에 보이도록 하는 설정으로 권장하지 않는다.(object 태그의 wmode를 사용하는 것을 권장)

Event Detail

onblur: 포커스를 잃었을 때 발생
onchange: 선택항목 변경 시 발생
onclick: 마우스로 selectbox를 클릭했을 때 발생
ondblclick: 마우스로 selectbox를 더블 클릭했을 때 발생
onfocus: 포커스를 얻었을 때 발생

Method Detail

addClass( className )

컴포넌트에 className의 이름을 가진 class를 추가합니다.

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

Sample

componentId.addClass("selected"); // 컴포넌트에 selected 라는 class를 추가.

addItem( value , label , idx )

해당 인덱스에 항목을 추가한다

Parameter
name	type	required	description
value	String	Y	항목의 value 값
label	String	Y	항목의 label 값
idx	Number	N	항목의 추가될 인덱스

Return
type	description
Number	항목의 추가된 인덱스

Sample

var returnValue = selectbox1.addItem( '#ffffff', '흰색', 0); 첫번째에 흰색 항목이 추가된다. returnValue값은 0이다. 유효하지 않은 인덱스의 경우, 항목의 가장 마지막 인덱스에 추가된다.

bind( type , function )

컴포넌트의 이벤트를 동적으로 할당합니다.

Parameter
name	type	required	description
type	String	Y	동적으로 할당할 이벤트의 이름
function	Function	Y	동적으로 할당할 이벤트의 핸들러 ㅎ마수

Sample

* | input1.bind("onclick", function(e){ alert(input1.getValue();})); // input1 클릭 시 이벤트 발생. 브라우저 이벤트로 등록
* | input1.bind("onchange", function(e){ alert(input1.getValue();})); // input1 값 변경 시 . 브라우저 이벤트가 아니고 웹스퀘어 엔진 내부의 이벤트로 등록된다.

changeClass( oldClassName , newClassName )

컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 치환합니다.

Parameter
name	type	required	description
oldClassName	String	Y	element에서 삭제할 class의 이름
newClassName	String	Y	element에서 추가할 class의 이름

Sample

componentId.changeClass("selected","default"); // 컴포넌트에 selected 라는 class를 default라는 class로 변경.

deleteItem( idx )

해당 인덱스의 항목을 삭제한다.

Parameter
name	type	required	description
idx	Number	N	삭제할 항목의 인덱스

Return
type	description
Object	삭제된 항목 오브젝트

Sample

var returnValue = selectbox1.deleteItem(0); returnValue.label은 '빨강'이다. returnValue.value는 '#ff0000'이다.

focus( )

객체에 focus를 줍니다.

getDisabled( )

현재 설정되어있는 disabled 속성을 반환합니다.

Return
type	description
Boolean	현재 설정되어있는 disabled 속성

Sample

var returnValue = componentId.getDisabled(); // returnValue는 true혹은 false이다.

getGeneratedComponent( id )

동일한 index에 속한 다른 컴퍼넌트 객체를 가져옵니다.

Parameter
name	type	required	description
id	String	N	찾아오려는 컴퍼넌트 id

Return
type	description
Object	동일한 id에 속한 다른 컴퍼넌트 객체

Sample

다음과 같이 사용할 수 있다. var content = this.getGeneratedComponent("content1"); content.setValue("");

getGeneratedIndex( )

generator 반복부에서 해당 index를 반환합니다.

Return
type	description
Number	generator 반복부에서 해당 index.

getID( )

웹스퀘어 컴포넌트의 id를 반환합니다.

Return
type	description
String	웹스퀘어 컴포넌트의 id

Sample

다음과 같이 사용할 수 있다. <script ev:event="onclick" type="javascript"><![CDATA[ var returnValue = this.getID(); ]]></script> returnValue는 컴포넌트의 id(예: input1)이다.

getItemCount( )

목록의 항목 수를 반환합니다.

Return
type	description
Number	목록의 항목 수

Sample

var returnValue = selectbox1.getItemCount();

getOpacity( )

컴포넌트의 Opacity 값을 반환합니다.

Return
type	description
Integer	Opacity 값

Sample

var returnValue = componentId.getOpacity(); // returnValue는 0~1사이의 실수이다.

getPluginName( )

웹스퀘어 컴포넌트의 pluginName을 반환합니다.

Return
type	description
String	웹스퀘어 컴포넌트의 pluginName

Sample

다음과 같이 사용할 수 있다. <script ev:event="onclick" type="javascript"><![CDATA[ var returnValue = this.getPluginName(); ]]></script> returnValue는 컴포넌트의 종류(예: input, checkbox ...)이다.

getPosition( positionName )

컴포넌트의 위치 값을 반환합니다.

Parameter
name	type	required	description
positionName	String	Y	위치 값의 종류('left'이거나 'top')

Return
type	description
Number	컴포넌트의 위치 값

Sample

var returnValue = componentId.getPosition("left"); // returnValue는 픽셀 단위의 위치 값이다. %로 설정된 경우, 픽셀로 변환하여 반환한다.

getReadOnly( )

현재 설정되어있는 readOnly 속성을 반환합니다.

Return
type	description
Boolean	현재 설정되어있는 readOnly 속성

Sample

var returnValue = componentId.getReadOnly(); // returnValue는 true혹은 false이다.

getSelectedIndex( )

선택된 항목의 index를 반환합니다.

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

Sample

예 : 첫번째 항목이 선택되어 있는 경우 var returnValue = selectbox1.getSelectedIndex(); returnValue은 0이다.

getSize( sizeName )

컴포넌트의 크기 값을 반환합니다.

Parameter
name	type	required	description
sizeName	String	Y	크기 값의 종류. szieName의 종류는 다음을 참고.

Return
type	description
Number	컴포넌트의 크기 값

Sample

var returnValue = componentId.getSize("width"); // returnValue는 픽셀 단위의 크기 값이다. %로 설정된 경우, 픽셀로 변환하여 반환한다.

getStyle( propertyName )

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

Parameter
name	type	required	description
propertyName	String	Y	반환할 style의 property 이름

Return
type	description
String	객체의 style 속성 값

Sample

var returnValue = componentId.getStyle("width"); // returnValue는 width에 대한 픽셀 단위, 또는 % 단위가 된다.

getStyleValue( style )

컴포넌트의 style중에서 입력받은 style의 값을 반환합니다.

Parameter
name	type	required	description
style	String	Y	style중에서 사용자가 구하고 싶은 값

Return
type	description
String	style중에서 사용자가 입력한 style의 값(색을 반환하는 경우에는 색HexCode로 반환)

getText( )

현재 선택된 항목의 label을 반환합니다.

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

Sample

예 : 첫번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) var returnValue = selectbox1.getText(); returnValue는 '빨강'이다.

getTitle( )

component의 title 속성을 가져온다.

Return
type	description
String	component의 title 속성값.

Sample

var title = componentId.getTitle();

getUserData( key )

설정된 사용자 임의의 데이터를 반환 합니다.
xml상에 설정된 사용자 값도 가져올 수 있습니다.

Parameter
name	type	required	description
key	String	Y	임의 데이터의 키

Return
type	description
String	key 값에 해당하는 데이터의 값

Sample

componentId.setUserData("data", "WebSquare"); var returnValue = componentId.getUserData("data"); returnValue는 WebSquare이다. <xf:input id="input1" style="position: absolute ;left:0px;top:0px;width: 100px;height: 20px;" data2="WEBSQUARE">... 와 같이 xml상에 설정된 사용자 정의 값도 가져올 수 있다. var returnValue = componentId.getUserData("data2"); returnValue는 WEBSQUARE이다.

getValue( )

현재 선택된 항목의 value값을 반환합니다.

Return
type	description
String	선택된 항목의 value

Sample

예 : 첫번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) var returnValue = selectbox1.getValue(); returnValue는 '#ff0000'이다.

hasClass( className )

컴포넌트가 className의 이름을 가진 class를 가지고 있는지 여부를 반환합니다.

Parameter
name	type	required	description
className	String	Y	조사할 className

Return
type	description
Boolean	컴포넌트가 className의 class를 가지고 있는지 여부

Sample

var returnValue = componentId.hasClass("selected"); // returnValue는 true 또는 false.
selected라는 class를 가지고 있으면 true, 아니면 false를 반환한다.

hide( )

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

removeAll( isInitialize )

모든 항목을 삭제한다.
ChooseOption에 따른 초기화가 필요시 isInitialize를 true로 호출한다.
ex)removeAll(); //ChooseOption에 상관없이 모든 항목 삭제
removeAll(true); //ChooseOption에 따른 Default 항목 생성

Parameter
name	type	required	description
isInitialize	Boolean	N

Sample

selectbox1.removeAll();

removeClass( className )

컴포넌트에 className의 이름을 가진 class를 삭제합니다.

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

Sample

componentId.removeClass("selected"); // 컴포넌트에 selected 라는 class를 삭제.

setDisabled( disabled )

객체의 disabled 속성을 제어합니다. Disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력합니다.

Parameter
name	type	required	description
disabled	Boolean	Y	Disabled 속성을 활성화 시키려면 true 비활성화 시키려면 false

Sample

componentId.setDisabled(true);
입력가능한 컴포넌트의 경우 입력이 불가능한 상태가 된다.

setNodeSet( nodeset , label , value )

itemset의 Model 바인딩 ref를 셋팅합니다.

Parameter
name	type	required	description
nodeset	String	N	변경하려는 nodeset의 xpath 문자열
label	String	N	변경하려는 label의 xpath 문자열
value	String	N	변경하려는 value의 xpath 문자열

Sample

selectbox1.setNodeSet('colorNode/vector','label/@value','value/@value');

setOpacity( value )

컴포넌트의 Opacity 값을 설정합니다.

Parameter
name	type	required	description
value	Integer	Y	설정할 Opacity 값 (0과 1사이의 실수)

Sample

componentId.setOpacity(0.45);

setPosition( left , top , mode )

컴포넌트의 위치를 설정합니다.

Parameter
name	type	required	description
left	Integer	Y	left의 값
top	Integer	Y	top의 값
mode	String	N	absolute이면 x,y로 현재 값을 설정하고 delta이면 현재 값에 x,y값만큼을 더해서 설정. (기본모드는 absolute)

Sample

componentId.setPosition(100, 100, "absolute");

setReadOnly( readOnly )

객체의 readOnly 속성을 제어합니다. readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false를 입력합니다.

Parameter
name	type	required	description
readOnly	Boolean	Y	readOnly 속성을 활성화 시키려면 true 비활성화 시키려면 false

Sample

componentId.setReadOnly(true);
입력가능한 컴포넌트의 경우 입력이 불가능한 상태가 된다.

setRef( 변경할 )

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

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

setSelectedIndex( idx )

해당 인덱스에 해당하는 항목을 선택합니다.

Parameter
name	type	required	description
idx	Number	Y	선택하려는 항목의 인덱스

Return
type	description
Boolean	셋팅 결과

Sample

예 : 첫번째 항목이 선택되어 있는 경우, selectbox1.setSelectedIndex(1); 두번째 항목이 선택된다.

setSize( width , heigth )

컴포넌트의 크기를 설정합니다.

Parameter
name	type	required	description
width	Integer	Y	새로 설정할 컴포넌트의 width값
heigth	Integer	Y	새로 설정할 컴포넌트의 height값

Sample

componentId.setSize(100,100);

setStyle( propertyName , value )

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

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

Sample

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

setText( label )

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

Parameter
name	type	required	description
label	String	Y	선택하고자 하는 항목의 label

Sample

예 : 첫번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) selectbox1.getText('빨강'); 빨강이 선택된다.

setUserData( key , value )

사용자 임의의 데이터를 객체에 설정합니다.

Parameter
name	type	required	description
key	String	Y	임의 데이터의 키
value	String	Y	임의 데이터의 값

Sample

공통 API로 모든 컴포넌트에서 사용 가능하다. componentId.setUserData("data", "WebSquare");
객체에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하다. componentId.setUserData("title", "WebSquare");
!!!WARNING - [title] can't define as UserData 와 같이 로그에 경고문구가 쌓인다.

setValue( value )

컴포넌트에 인자로 넘겨진 value와 같은 값을 가진 항목을 선택하고 model에 반영합니다.

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

Return
type	description

Sample

예 : 첫번째 항목이 선택되어 있는 경우. (아이템 이름(라벨)은 색상이며, 아이템 값은 '#000000 ~ #ffffff' 으로 되어있다.) selectbox1.setValue("#000000"); 선택된 첫번째 항목에서 검정색 항목으로 선택이 변경된다.

show( displayType )

컴포넌트를 화면에 보이도록 설정합니다.

Parameter
name	type	required	description
displayType	String	N	display의 속성 값. (block, inline, none, “”)

Sample

componentId.show(); // display 속성이 "block"이 된다. componentId.show(""); // class에 적용된 display 속성 값을 다시 복구.

toggleClass( className )

컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.

Parameter
name	type	required	description
className	String	Y	조사할 className

Sample

componentId.toggleClass("selected");
selected라는 class가 존재하면 해당 class를 제거한다. selected라는 class가 존재하지 않으면 추가한다.

trigger( type , array )

컴포넌트에 등록된 특정 이벤트를 직접 발생시킵니다.

Parameter
name	type	required	description
type	String	Y	발생시킬 이벤트 이름
array	Object	N	이벤트 핸들러에 전달할 파라미터 배열

Sample

* | input1.trigger("onclick"); // input1에 onclick이벤트를 발생시킨다.
* | input1.trigger("onchange", [1,2]); // input1에 onchange이벤트를 발생시키고 핸들러 함수에 (1,2) 인자를 전달하여 호출한다.

unbind( type , function )

컴포넌트의 이벤트를 동적으로 제거합니다.

Parameter
name	type	required	description
type	String	N	제거할 이벤트의 이름. 생략할 경우 해당 컴포넌트의 모든 이벤트를 제거한다.
function	Function	N	제거할 이벤트의 핸들러 함수. 생략할 경우 해당 이벤트 type으로 등록된 모든 핸들러 함수를 제거한다.

Sample

* | input1.unbind("onclick", func1); // input1에 등록된 onclick이벤트 함수 중에 func1 이벤트 핸들러를 제거
* | input1.unbind("onchange"); // input1에 등록된 onchange이벤트 핸들러 함수를 모두 제거
* | input1.unbind(); // input1에 등록된 모든 이벤트를 제거

validate( )

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

Sample

chooseOption을 사용하면서 -선택-으로 되어 있는 경우, var returnValue = selectbox1.validate(); returnValue는 false이다. 만약 어떤 항목이 선택되어 있는 경우는 true가 된다.

visible( flag )

컴포넌트의 style 중 visibility 값을 설정합니다. flag가 참이면 "visible", 거짓이면 "hidden"을 설정합니다.

Parameter
name	type	required	description
flag	Boolean	Y	visibility 값을 설정할 값(참이면 "visible", 거짓이면 "hidden"을 설정)