WebSquare.uiplugin.pageList

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

Type

uiplugin

Property Summary

buttonShowType: 페이지 이동 버튼의 타입
class: pageList의 class 속성
deliImage: 구분자의 이미지
deliImageStyle: 구분자의 style
delimiter: 구분자
deliWidth: 구분자의 width
displayButtonType: 첫페이지 또는 마지막 페이지시 페이지버튼 처리(display:항상 표시, auto:마지막 페이지시엔 표시안함, displayOver:pageCount가 pageSize보다 클때 표시(단, 작을 경우엔 display와 동일하게 동작), autoOver:pageCount가 pageSize보다 클때 표시(단, 작을 경우엔 auto와 동일하게 동작), autoHidden: 첫페이지, 마지막페이지에 보여지는 수 만큼은 표시안함 )
displayFormat: index가 표시되는 format
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: 남은 페이지만 표현
rightPageBackImage: 페이지를 왼쪽으로 한칸 바꾸는 버튼의 이미지
rightPageBackImageClass: 페이지를 오른쪽으로 pageSize단위 만큼 바꾸는 버튼의 class
rightPageImage: 페이지를 오른쪽으로 pageSize단위 만큼 바꾸는 버튼의 이미지
rightPageImageClass: 페이지를 오른쪽으로 한칸 바꾸는 버튼의 class
shiftMoveButtonWidth: 페이지를 pageSize단위 만큼 바꾸는 버튼의 width
title: pageList의 title 속성
useDelim: 구분자 사용여부 , useDelim가 true 일때만 delimeter 사용가능

Event Summary

onchange: 선택 항목 변경시 발생
onclick: 마우스로 pageList를 클릭했을 때 발생

Method Summary

addClass( className ): 컴포넌트에 className의 이름을 가진 class를 추가합니다
bind( type , function ): 컴포넌트의 이벤트를 동적으로 할당합니다
changeClass( oldClassName , newClassName ): 컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 치환합니다
focus( ): 객체에 focus를 줍니다
getCount( ): PageList의 Total page count를 반환하는 함수입니다
getDisabled( ): 현재 설정되어있는 disabled 속성을 반환합니다
getGeneratedComponent( id ): 동일한 index에 속한 다른 컴퍼넌트 객체를 가져옵니다
getGeneratedIndex( ): generator 반복부에서 해당 index를 반환합니다
getID( ): 웹스퀘어 컴포넌트의 id를 반환합니다
getLabel( idx ): idx에 해당하는 label을 반환합니다
getOpacity( ): 컴포넌트의 Opacity 값을 반환합니다
getPluginName( ): 웹스퀘어 컴포넌트의 pluginName을 반환합니다
getPosition( positionName ): 컴포넌트의 위치 값을 반환합니다
getReadOnly( ): 현재 설정되어있는 readOnly 속성을 반환합니다
getSelectedIndex( ): 선택된 index를 반환하는 함수입니다
getSize( sizeName ): 컴포넌트의 크기 값을 반환합니다
getStyle( propertyName ): 컴포넌트의 propertyName에 해당하는 style의 값을 반환합니다
getStyleValue( style ): 컴포넌트의 style중에서 입력받은 style의 값을 반환합니다
getTitle( ): component의 title 속성을 가져온다
getUserData( key ): 설정된 사용자 임의의 데이터를 반환 합니다.
hasClass( className ): 컴포넌트가 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 속성을 제어합니다
setIdxClass( idx ): setSelectedIndex와 같은 역할을 하는 함수입니다
setOpacity( value ): 컴포넌트의 Opacity 값을 설정합니다
setPosition( left , top , mode ): 컴포넌트의 위치를 설정합니다
setReadOnly( readOnly ): 객체의 readOnly 속성을 제어합니다
setSelectedIndex( idx ): page의 선택된 index를 변경하는 함수입니다
setSize( width , heigth ): 컴포넌트의 크기를 설정합니다
setStyle( propertyName , value ): 컴포넌트의 propertyName에 해당하는 style의 값을 설정합니다
setUserData( key , value ): 사용자 임의의 데이터를 객체에 설정합니다
setValue( value ): setSelectedIndex와 같은 역할을 하는 함수입니다
show( displayType ): 컴포넌트를 화면에 보이도록 설정합니다
toggleClass( className ): 컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다
trigger( type , array ): 컴포넌트에 등록된 특정 이벤트를 직접 발생시킵니다
unbind( type , function ): 컴포넌트의 이벤트를 동적으로 제거합니다
visible( flag ): 컴포넌트의 style 중 visibility 값을 설정합니다

Property Detail

buttonShowType: 페이지 이동 버튼의 타입
class: pageList의 class 속성
deliImage: 구분자의 이미지
deliImageStyle: 구분자의 style
delimiter: 구분자
deliWidth: 구분자의 width
displayButtonType: 첫페이지 또는 마지막 페이지시 페이지버튼 처리(display:항상 표시, auto:마지막 페이지시엔 표시안함, displayOver:pageCount가 pageSize보다 클때 표시(단, 작을 경우엔 display와 동일하게 동작), autoOver:pageCount가 pageSize보다 클때 표시(단, 작을 경우엔 auto와 동일하게 동작), autoHidden: 첫페이지, 마지막페이지에 보여지는 수 만큼은 표시안함 )
displayFormat: index가 표시되는 format
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은 지원안함.)
rightPageBackImage: 페이지를 왼쪽으로 한칸 바꾸는 버튼의 이미지
rightPageBackImageClass: 페이지를 오른쪽으로 pageSize단위 만큼 바꾸는 버튼의 class
rightPageImage: 페이지를 오른쪽으로 pageSize단위 만큼 바꾸는 버튼의 이미지
rightPageImageClass: 페이지를 오른쪽으로 한칸 바꾸는 버튼의 class
shiftMoveButtonWidth: 페이지를 pageSize단위 만큼 바꾸는 버튼의 width
title: pageList의 title 속성
useDelim: 구분자 사용여부 , useDelim가 true 일때만 delimeter 사용가능

Event Detail

onchange

선택 항목 변경시 발생

Parameter
name	type	description
current	Number	page의 번호.
before	Number	위치한 page의 번호.

Sample

ev:event="onchange( current , before )" 로 이벤트의 인자가 정의된 예: 2page에서 next page로 이동. output1.setValue(before +"->" + current); 2 -> 3

onclick

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

Parameter
name	type	description
idx	Number	page의 번호.

Sample

ev:event="onclick( idx )" 로 이벤트의 인자가 정의된 예: 2page 클릭. output1.setValue(idx); 2

Method Detail

addClass( className )

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

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

Sample

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

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로 변경.

focus( )

객체에 focus를 줍니다.

getCount( )

PageList의 Total page count를 반환하는 함수입니다.

Return
type	description
Number:Y	Total page count

Sample

pageList1.getCount();

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)이다.

getLabel( idx )

idx에 해당하는 label을 반환합니다.

Parameter
name	type	required	description
idx	Number	Y	page의 index값

Return
type	description
String	idx에 해당하는 label

Sample

var returnValue = pageList1.getLabel(1); returnValue는 1이다.

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

5번째 페이지가 선택된 경우, var returnValue = pageList1.getSelectedIndex(); returnValue는 5이다.

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로 반환)

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이다.

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

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

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를 삭제합니다.

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

Sample

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

setCount( count , flag )

PageList의 Total page count를 새로 지정하는 함수입니다.
변경된 total page count값으로 pageList가 갱신됩니다.
API 호출시 페이지가 첫페이지로 초기화 됩니다.

Parameter
name	type	required	description
count	Number	Y	변경할 PageList의 Total Page Count
flag	Boolean	N	이전 출력 형태 유지 유무, true : 유지, false 또는 미설정시 1페이지로 갱신.

Sample

pageList1.setCount(100);

setDisabled( disabled )

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

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

Sample

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

setIdxClass( idx )

setSelectedIndex와 같은 역할을 하는 함수입니다.

Parameter
name	type	required	description
idx	Number	Y	선택하고자 하는 index

Sample

pageList1.setIdxClass(5); 5번째 페이지를 선택한다.

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);
입력가능한 컴포넌트의 경우 입력이 불가능한 상태가 된다.

setSelectedIndex( idx )

page의 선택된 index를 변경하는 함수입니다.

Parameter
name	type	required	description
idx	Number	Y	선택하고자 하는 index

Sample

pageList1.setSelectedIndex(5); 5번째 페이지를 선택한다.

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%"); 로 명시하여 준다.

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 )

setSelectedIndex와 같은 역할을 하는 함수입니다.

Parameter
name	type	required	description
value	String	Y	선택하고자 하는 index

Sample

pageList1.setValue(5); 5번째 페이지를 선택한다.

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에 등록된 모든 이벤트를 제거

visible( flag )

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

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