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

page를 관리하는 컴포넌트입니다. 실제 data의 paging처리를 하는게 아니라 page count설정 및 page를 선택하는 UI만 지원합니다.

Type

uiplugin

Property Summary

buttonShowType
페이지 이동 버튼 타입. (이전/다음 페이지, 이전/다음 목록, 첫/끝 페이지로 이동하는 버튼 표시 여부 결정 결정.)
class
pageList의 class 속성
deliImage
구분자의 이미지
deliImageStyle
구분자의 style
delimiter
구분자
deliWidth
구분자의 width
displayButtonType
첫페이지 또는 마지막 페이지시 페이지 버튼 처리
displayFormat
index가 표시되는 format
displaySearchbox
[default:false, true] 페이지 번호 입력란을 추가
displaySelectedIndex
[default:false, true] displaySearchbox = "true" 인 경우, 페이지 입력창에 현재 페이지 번호를 표시.
id
pageList 컴포넌트의 id
leftPageBackImage
페이지를 왼쪽으로 pageSize단위 만큼 바꾸는 버튼의 이미지
leftPageBackImageClass
페이지를 왼쪽으로 pageSize단위 만큼 바꾸는 버튼의 class
leftPageImage
페이지를 왼쪽으로 한칸 바꾸는 버튼의 이미지
leftPageImageClass
페이지를 왼쪽으로 한칸 바꾸는 버튼의 class
naviType
buttonShowType 2일 때만 가능한, 페이지 1개 이동관련 옵션 (1: 리스트자체가 이동, 2: 페이지 선택) pagingType은 무시
oneMoveButtonWidth
페이지를 한칸 바꾸는 버튼의 width
pageSize
한 페이지에 보이는 숫자의 수
pagingType
남은 페이지의 수가 pageSize보다 작을 때 보는 방식 (1: pasingSize에 맞춰서 표현, 2: 남은 페이지만 표현
renderType
렌더링되는 레이아웃 구조에 따라 "table", "list" 두 가지 renderType 속성을 지원합니다
rightPageBackImage
페이지를 왼쪽으로 한칸 바꾸는 버튼의 이미지
rightPageBackImageClass
페이지를 오른쪽으로 pageSize단위 만큼 바꾸는 버튼의 class
rightPageImage
페이지를 오른쪽으로 pageSize단위 만큼 바꾸는 버튼의 이미지
rightPageImageClass
페이지를 오른쪽으로 한칸 바꾸는 버튼의 class
shiftMoveButtonWidth
페이지를 pageSize단위 만큼 바꾸는 버튼의 width
title
pageList의 title 속성
useDelim
구분자 사용여부 , useDelim가 true 일때만 delimeter 사용가능
userData1
사용자 정의 데이터 속성
userData2
사용자 정의 데이터 속성
userData3
사용자 정의 데이터 속성

Event Summary

onchange
선택 항목 변경시 발생
onclick
마우스로 pageList를 클릭했을 때 발생
oninputblur
displaySearchbox="true"인 경우, 사용자의 페이지 번호 입력 후 포커스가 사라질 때 발생
onviewchange
마우스나 키보드 조작을 통해 페이지 번호가 변경된 경우에만 발생하는 이벤트

Method Summary

addClass( className )
컴포넌트에 class를 추가한다
bind( eventType , function )
컴포넌트의 이벤트를 동적으로 할당한다
changeClass( oldClassName , newClassName )
컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.
focus( )
컴포넌트에 focus를 준다
getCount( )
PageList의 Total page count를 반환하는 함수입니다
getDisabled( )
현재 설정되어있는 disabled 속성값을 반환한다
getGenerator( )
generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다
getID( )
웹스퀘어 컴포넌트의 id를 반환한다
getLabel( idx )
idx에 해당하는 label을 반환합니다
getOpacity( )
CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다
getPageSize( )
PageList의 pageSize를 조회하는 함수입니다
getPluginName( )
웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다
getPosition( positionName )
컴포넌트의 left 또는 top의 위치 값을 반환한다
getReadOnly( )
현재 설정되어있는 readOnly 속성값을 반환한다
getSelectedIndex( )
선택된 index를 반환하는 함수입니다
getSize( sizeName )
컴포넌트의 크기 값을 반환합니다
getStyle( propertyName )
컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다
getStyleValue( style )
[deprecated]getStyle로 사용.
getTitle( )
title 속성값을 반환한다
getUserData( key )
setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다
hasClass( className )
컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다
hide( )
컴포넌트를 화면에서 보이지 않도록 숨긴다.
moveLeft( )
선택된 index를 1 감소시킵니다
moveRight( )
선택된 index를 1 증가시킵니다
pageLeft( )
pageSize 기준으로 이전 page의 첫번째 page를 선택합니다.
pageRight( )
pageSize 기준으로 다음 page의 첫번째 page를 선택합니다.
removeClass( className )
컴포넌트에 className의 class를 삭제한다.
setCount( count , flag )
PageList의 Total page count를 새로 지정하는 함수입니다.
setDisabled( disabled )
컴포넌트의 disabled 속성을 설정한다
setEventPause( evList , flag )
컴포넌트의 이벤트를 disable 또는 enable시킨다
setIdxClass( idx )
setSelectedIndex와 같은 역할을 하는 함수입니다
setOpacity( value )
컴포넌트의 CSS Opacity(불투명도)값를 설정한다
setPosition( left , top , mode )
컴포넌트의 위치(left,top)를 설정한다
setReadOnly( readOnly )
readOnly 속성값을 설정한다
setSelectedIndex( idx )
page의 선택된 index를 변경하는 함수입니다
setSize( width , heigth )
컴포넌트의 크기(width,height)를 설정한다
setStyle( propertyName , value )
컴포넌트의 property별 style을 설정한다
setUserData( key , value )
컴포넌트에 사용자 데이터를 설정한다
setValue( value )
setSelectedIndex와 같은 역할을 하는 함수입니다
show( displayType )
컴포넌트를 화면에 보이도록 설정한다.
toggleClass( className )
컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다.
trigger( type , array )
컴포넌트에 등록 된 특정 이벤트를 발생시킨다
unbind( type , function )
컴포넌트에 등록 된 이벤트를 제거한다
visible( flag )
[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.

Property Detail

buttonShowType
페이지 이동 버튼 타입. (이전/다음 페이지, 이전/다음 목록, 첫/끝 페이지로 이동하는 버튼 표시 여부 결정 결정.)
0: 이전/다음 목록 버튼만 표시 (2개)
1 (기본 값): 이전/다음 페이지 + 이전/다음 목록 (4개)
2: 이전/다음 페이지 (2개)
3: 이전/처음 목록 + 첫/끝 페이지 (4개)
class
pageList의 class 속성
deliImage
구분자의 이미지
deliImageStyle
구분자의 style
delimiter
구분자
deliWidth
구분자의 width
displayButtonType
첫페이지 또는 마지막 페이지시 페이지 버튼 처리. (display: 항상 표시, auto: 마지막 페이지에는 표시 안 함, displayOver: pageCount가 pageSize보다 클때 표시 (단, 작을 경우엔 display와 동일하게 동작), autoOver: pageCount가 pageSize보다 클때 표시(단, 작을 경우엔 auto와 동일하게 동작), autoHidden: 첫페이지, 마지막페이지에 보여지는 수 만큼은 표시안함 )
displayFormat
index가 표시되는 format
displaySearchbox
[default:false, true] 페이지 번호 입력란을 추가. 입력한 번호에 해당하는 페이지를 화면에 출력 가능. (true: 입력란 추가, false: 입력란 추가 안 함 (기본값))
displaySelectedIndex
[default:false, true] displaySearchbox = "true" 인 경우, 페이지 입력창에 현재 페이지 번호를 표시.
true: 현재 페이지 번호를 표시
false (기본 값): 현재 페이지 번호를 표시하지 않음.
id
pageList 컴포넌트의 id
leftPageBackImage
페이지를 왼쪽으로 pageSize단위 만큼 바꾸는 버튼의 이미지
leftPageBackImageClass
페이지를 왼쪽으로 pageSize단위 만큼 바꾸는 버튼의 class
leftPageImage
페이지를 왼쪽으로 한칸 바꾸는 버튼의 이미지
leftPageImageClass
페이지를 왼쪽으로 한칸 바꾸는 버튼의 class
naviType
buttonShowType 2일 때만 가능한, 페이지 1개 이동관련 옵션 (1: 리스트자체가 이동, 2: 페이지 선택) pagingType은 무시.
oneMoveButtonWidth
페이지를 한칸 바꾸는 버튼의 width
pageSize
한 페이지에 보이는 숫자의 수
pagingType
남은 페이지의 수가 pageSize보다 작을 때 보는 방식 (1: pasingSize에 맞춰서 표현, 2: 남은 페이지만 표현. buttonShowType이 3인 경우에는 pagingType 1은 지원안함.)
renderType
렌더링되는 레이아웃 구조에 따라 "table", "list" 두 가지 renderType 속성을 지원합니다.
rightPageBackImage
페이지를 왼쪽으로 한칸 바꾸는 버튼의 이미지
rightPageBackImageClass
페이지를 오른쪽으로 pageSize단위 만큼 바꾸는 버튼의 class
rightPageImage
페이지를 오른쪽으로 pageSize단위 만큼 바꾸는 버튼의 이미지
rightPageImageClass
페이지를 오른쪽으로 한칸 바꾸는 버튼의 class
shiftMoveButtonWidth
페이지를 pageSize단위 만큼 바꾸는 버튼의 width
title
pageList의 title 속성
useDelim
구분자 사용여부 , useDelim가 true 일때만 delimeter 사용가능
userData1
사용자 정의 데이터 속성. getUserData("userData1") API를 통해 설정한 값을 얻어올 수 있다.
userData2
사용자 정의 데이터 속성. getUserData("userData2") API를 통해 설정한 값을 얻어올 수 있다.
userData3
사용자 정의 데이터 속성. getUserData("userData3") API를 통해 설정한 값을 얻어올 수 있다.

Event Detail

onchange
선택 항목 변경시 발생
Parameter
nametypedescription
currentNumberpage의 번호.
beforeNumber위치한 page의 번호.
Sample
ev:event="onchange( current , before )" 로 이벤트의 인자가 정의된 예: 2page에서 next page로 이동. output1.setValue(before +"->" + current); 2 -> 3
onclick
마우스로 pageList를 클릭했을 때 발생
Parameter
nametypedescription
idxNumberpage의 번호.
Sample
ev:event="onclick( idx )" 로 이벤트의 인자가 정의된 예: 2page 클릭. output1.setValue(idx); 2
oninputblur
displaySearchbox="true"인 경우, 사용자의 페이지 번호 입력 후 포커스가 사라질 때 발생. (페이지 번호 입력 상자에서 발생하는 blur 이벤트.)
Parameter
nametypedescription
BlurNumber발생 시 페이지 입력 상자에 입력된 값
Sample
ev:event="oninputblur( value )" output1.setValue(value +"->" + value);
onviewchange
마우스나 키보드 조작을 통해 페이지 번호가 변경된 경우에만 발생하는 이벤트. 스크립트를 통해 값이 변경된 경우에는 해당 이벤트가 발생하지 않습니다. (native onchange 이벤트와 유사합니다.)
Parameter
nametypedescription
infoObjectoldValue, newValue, oldSelectedIndex, newSelectedIndex를 포함한 오브젝트를 반환합니다. <Number> info.oldSelectedIndex : 이전 index <Number> info.newSelectedIndex : 변경된 index
Sample
<script ev:event="onviewchange( info )"><![CDATA[ var oldSelectedIndex = info.oldIndex; var newSelectedIndex = info.newIndex; ]]></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");
focus( )
컴포넌트에 focus를 준다.
getCount( )
PageList의 Total page count를 반환하는 함수입니다.
Return
typedescription
Number:YTotal page count
Sample
pageList1.getCount();
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" }
getLabel( idx )
idx에 해당하는 label을 반환합니다.
Parameter
nametyperequireddescription
idxNumberYpage의 index값
Return
typedescription
Stringidx에 해당하는 label
Sample
var returnValue = pageList1.getLabel(1); returnValue는 1이다.
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"
getPageSize( )
PageList의 pageSize를 조회하는 함수입니다.
Sample
pageList1.getPageSize();
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( )
선택된 index를 반환하는 함수입니다.
Return
typedescription
Number현재 선택된 index.
Sample
5번째 페이지가 선택된 경우, var returnValue = pageList1.getSelectedIndex(); returnValue는 5이다.
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로 반환)
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"
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();
moveLeft( )
선택된 index를 1 감소시킵니다.
Sample
현재 페이지가 3페이지인 경우, pageList1.moveLeft(); 2페이지로 이동한다.
moveRight( )
선택된 index를 1 증가시킵니다.
Sample
현재 페이지가 3페이지인 경우, pageList1.moveRight(); 4페이지로 이동한다.
pageLeft( )
pageSize 기준으로 이전 page의 첫번째 page를 선택합니다.
pageSize=10이고 현재 23일때, pageLeft를 하면 11로 이동합니다.
Sample
pageSize=10이고 현재 23페이지일 때, pageList1.pageLeft(); 11페이지로 이동한다.
pageRight( )
pageSize 기준으로 다음 page의 첫번째 page를 선택합니다.
pageSize=10이고 현재 23일때, pageRight하면 31로 이동합니다.
Sample
pageSize=10이고 현재 23페이지일 때, pageList1.pageRight(); 31페이지로 이동한다.
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");
setCount( count , flag )
PageList의 Total page count를 새로 지정하는 함수입니다.
변경된 total page count값으로 pageList가 갱신됩니다.
API 호출시 페이지가 첫페이지로 초기화 됩니다.
Parameter
nametyperequireddescription
countNumberY변경할 PageList의 Total Page Count
flagBooleanN이전 출력 형태 유지 유무, true : 유지, false 또는 미설정시 1페이지로 갱신.
Sample
pageList1.setCount(100);
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 한다.
setIdxClass( idx )
setSelectedIndex와 같은 역할을 하는 함수입니다.
Parameter
nametyperequireddescription
idxNumberY선택하고자 하는 index
Sample
pageList1.setIdxClass(5); 5번째 페이지를 선택한다.
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);
setSelectedIndex( idx )
page의 선택된 index를 변경하는 함수입니다.
Parameter
nametyperequireddescription
idxNumberY선택하고자 하는 index
Sample
pageList1.setSelectedIndex(5); 5번째 페이지를 선택한다.
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");
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 )
setSelectedIndex와 같은 역할을 하는 함수입니다.
Parameter
nametyperequireddescription
valueStringY선택하고자 하는 index
Sample
pageList1.setValue(5); 5번째 페이지를 선택한다.
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);
visible( flag )
[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.
컴포넌트의 style 중 visibility 값을 설정한다. true이면 "visible", false이면 "hidden"을 설정.
Parameter
nametyperequireddescription
flagBooleanYvisibility 값을 설정할 값(true이면 "visible", false이면 "hidden"을 설정)