class RtListControl
컨트롤에 연결된 data에 포함된 데이터행들의 필드 값들을 각각 하나의 리스트 행 view에 다양한 방식으로 표시한다.
데이터행 표시 외에 데이터행을 관리하고 상태를 표시하는 등의 여러 요소로 구성된다.
컨트롤은 데이터와 뷰를 연결하고 관리하는 말 그대로 컨트롤러이다. data의 변경 사항은 즉시 컨트롤에 반영되고, 컨트롤 UI를 통해 변경된 값들은 data에 반영된다.
컨트롤은 생성자 대신 주로 모듈 함수를 호출해서 생성한다.
컨트롤은 데이터와 뷰를 연결하고 관리하는 말 그대로 컨트롤러이다. data의 변경 사항은 즉시 컨트롤에 반영되고, 컨트롤 UI를 통해 변경된 값들은 data에 반영된다.
컨트롤은 생성자 대신 주로 모듈 함수를 호출해서 생성한다.
list = RealTouch.createListControl(document, 'realgrid-touch');// 'realgrid-touch'는 div의 id.
list.setConfig(config); // 컨트롤 속성 및 옵션 설정
list.data = data; // 데이터 연결
See Also
Template Params
Events
- onAllRowsCheck: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 모든 데이터행의 checked 상태가 같은 값으로 변경된 후 발생한다. - onAllRowsDetail: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 모든 데이터행들의 자세히 보기가 같은 상태로 변경될 때 발생한다. - onAllRowsFlagChange: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 flag number in N 모든 행의 flag가 같은 상태로 변경될 때 발생한다. - onBeforeGroupCollapse: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 group RowGroup in N cancel boolean in N 그룹핑 상태일 때, 펼쳐진 그룹이 접히기 전 호출되는 콜백. false
를 명시적으로 리턴하면 그룹이 접히지 않는다. - onBeforeGroupExpand: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 group RowGroup in N 펼쳐지는 group 객체 cancel boolean out Y true
로 지정하면 펼쳐지지 않는다.그룹핑 상태일 때, 접힌 그룹이 펼쳐지기 전 호출되는 콜백. false
를 명시적으로 리턴하면 그룹이 펼쳐지지 않는다. - onBeforePageChange: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 page number in N cancel boolean in N 페이징 상태일 때, 페이지가 변경되기 전에 호출되는 콜백. false
를 명시적으로 리턴하면 페이지가 변경되지 않는다. - onButtonClick: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 button string in N row number in N 데이터행에 표시 중인 버튼을 탭(클릭)했을 때 발생한다. - onFocusedRowChange: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 data RtDataSource in N row number in N oldData RtDataSource in N oldRow number in N 포커스 데이터행의 위치가 변경됐다. - onGroupCollapse: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 group RowGroup in N 그룹핑 상태일 때, 펼쳐진 그룹이 접힌 후 호출되는 콜백. - onGroupExpand: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 group RowGroup in N 그룹핑 상태일 때, 접힌 그룹이 펼쳐진 후 호출되는 콜백. - onLastRowRevealed: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 끝까지 스크롤돼서 마지막 데이터행이 표시되게 될 때 발생한다. - onPageChange: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 page number in N 페이징 상태일 때, 페이지가 변경된 후 호출되는 콜백. - onRowCheck: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 row number in N 데이터행의 checked 상태가 변경될 때 발생한다. - onRowClick: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 row number in N 데이터행을 탭(클릭)할 때 발생한다. - onRowDetail: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 row number in N 데이터행의 자세히 보기가 표시되거나 감춰질 때 발생한다. - onRowFlagChange: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 row number in N flag number in N 행 flag가 변경될 때 발생한다. - onRowLongPress: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 row number in N 데이터행 번호 데이터행 길게 눌렀을 때 발생한다. - onRowSwipe: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 row number in N 데이터행 번호 dir RtDirection in N 제스처 진행 방향 cancel boolean in N true
로 지정하면 다은 action을 실행하지 않는다.데이터행을 좌우로 swipe할 때 발생한다. 이벤트 콜백 내에서 매개변수로 전달된 객체의 cancel 속성을 true
로 지정하면, rowSwipeAction으로 설정한 기본 동작이 무시된다. - onRowsCheck: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 rows number[] in N 여러 데이터행들의 checked 상태가 변경될 때 발생한다. - onRowsDetail: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 rows number[] in N 여러 데이터행들의 자세히 보기가 같은 상태로 변경될 때 발생한다. - onRowsFlagChange: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 rows number[] in N flag number in N 복수 행의 flag가 같은 상태로 변경될 때 발생한다. - onScroll: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 top number in N 스크롤 위치. scrollIndex prev number in N 이전 스크롤 위치 topRow number in N 데이터행 index. topRow prevRow number in N 이전 데이터행 index 데이터행들이 스크롤돼서 표시되는 시작 행이 변경됐을 때 발생한다. 드래그해서 스크롤하거나 topRow 속성을 직접 변경할 수도 있다. - onSelectionAdd: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 start number in N end number in N 데이터행이 하나 이상 선택됐을 때 발생한다. - onSelectionChange: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 newStart number in N newEnd number in N oldStart number in N oldEnd number in N 행 선택 범위가 변경될 때 발생한다. - onSelectionClear: (args:
any
) =>void
Properties of argsproperty type i/o opt description control RtListControl in N 컨트롤 객체 기존 행 선택이 제거될 때 발생한다.
Properties
- alwaysEmptyPage:
boolean
Empty 페이지는 데이터뷰의 필터링 상태와 상관없이 원본 데이터가 비었을 때만 표시되지만, 이 속성을 true
로 지정하면 필터링 후 표시할 데이터가 없는 경우에도 표시된다. - boolFormat:
string
boolean
값을 문자열로 변환하는 형식.
렌더러 등에서 별도로 지정하지 않으면 이 형식이 적용된다. booleanFormatter가 설정되면 이 속성은 무시된다.
Boolean Formtter 도음말을 참조한다. - booleanFormatter: RtBooleanFormatter
boolean
값을 문자열로 변환하는 콜백.
렌더러 등에서 별도로 지정하지 않으면 이 콜백이 적용된다. 이 속성이 설정되면 boolFormat은 무시된다. - checkedRowCount:
number
readonlycheck된 행들의 개수.
checkRow나 toggleChecked 등으로 데이터행 checked 상태를 설절할 수 있다. - commandRow:
number
readonlyRow command가 표시되는 데이터행 번호. - current: RtListOptions readonly
수평/수직 상태에 따른 현재 적용 중인 options 객체.
즉, 수평 모드이면 landscape 옵션이고, 수직 모드이면 portrait 옵션이다. - data: RtDataSource
이 리스트 컨트롤에 표시할 데이터행들이 포함된 데이터 객체.
RtListData, RtDataView, 혹은 RtDataLinkView을 설정할 수 있다. 대개 컨트롤 생성 등 초기화 시점에 연결해서 계속 사용된다. 컨트롤은 연결된 데이터의 행들을 표시한다.const data = RealTouch.createData('data'); list.data = data;
See Also
- dataAppending:
boolean
readonlytrue
로 지정하면 attached row 영역에 spinner가 표시된다. - dataLoading:
boolean
readonlytrue
로 지정하면 loading 페이지가 표시된다.
단 skeletionVisible이true
로 지정되면 loading 페이지 대신 skeleton view가 표시된다. - dateFormat:
string
Date 객체 값을 문자열로 변환하는 형식.
Date Formtter 도음말을 참조한다. - dateFormatter: RtDateFormatter
Date 객체 값을 문자열로 변환하는 콜백.
렌더러 등에서 별도로 지정하지 않으면 이 콜백이 적용된다. 이 속성이 설정되면 dataFormat은 무시된다. - description:
string
[접근성] 정보.
컨트롤 div의 aria-label 속성으로 사용된다. - fitRowWhenClick:
boolean
Defaulttrue
행 클릭 시 행이 모두 표시되게 한다. - fitRowWhenScroll:
boolean
Defaultfalse
Fliing 스크롤 시 최상위 행이 중간에 걸치지 않도록 한다. - focusedRow:
number
readonly데이터행 tap이나 setFocusedRow 호출로 focused 상태가 된 데이터행 번호. See Also
- isDataGrouped:
boolean
readonly마스터&디테일 그룹핑 상태면 true
. - isEmpty:
boolean
readonlydata가 설정되지 않거나 데이터행이 하나도 없으면 true
. - isPaging:
boolean
readonly페이징 상태면 true
. - isRowGrouped:
boolean
readonly행 그룹핑 상태면 true
. - isSingleRow:
boolean
readonlysingle row 상태면 true
. - landscape: RtListOptions readonly
landscape 상태일 때 options 객체. - lineSeparator:
string
|
string
[]<br> 태그를 줄바꿈으로 사용할 지 여부.
renderer별로 별도 지정할 수도 있다. - numberFormat:
string
숫자 값을 문자열로 변환하는 형식.
렌더러 등에서 별도로 지정하지 않으면 이 형식이 적용된다. numberFormatter가 설정되면 이 속성은 무시된다.
Number Formtter 도음말을 참조한다. - numberFormatter: RtNumberFormatter
숫자 값을 문자열로 변환하는 콜백.
렌더러 등에서 별도로 지정하지 않으면 이 콜백이 적용된다. 이 속성이 설정되면 numberFormat은 무시된다. - options: RtDefaultOptions readonly
기본 option 객체. - orientation: RtScreenOrientation readonly
컨트롤 방향.
이 속성에 따라 컨트롤의 표시 옵션들이 결정된다. - page:
number
페이징 상태일 때, 현재 페이지 인덱스.
범위(0 ~ pageCount - 1)을 벗어나게 설정하면 범위 내로 조정된다. 하지만, 페이징 상태가 아닐 때 이 속성을 설정하면 예외가 발생한다. - pageCount:
number
readonly페이징 상태일 때, 전체 페이지 개수. - pageSize:
number
readonly페이징 상태일 때, 페이지 당 데이터행 수. - portrait: RtListOptions readonly
portrait 상태일 때 options 객체. - registeredRowCommands:
string
[] readonly등록되어 있는 데이터행 커맨드 이름 목록.
라이브러리에서 미리 등록한 것들도 포함된다. - renderMode: RtRenderMode
컨트롤 생성 시 지정된 render 모드. - screenOrientation: RtScreenOrientation readonly
스크린 방향. - scrollIndex:
number
스크롤 위치. - searchOptions: IRtSearchOptions
기본 검색 옵션.
Search panel에서 사용자가 설정한 값들이 반영된다. 단일 값처럼 적용해야 한다. 즉, control.searchOptions.filtering =true
방식으로 설정해서는 안된다. contro.searchOptions = { filtering:true
} 로 설정해야 한다. - selectable:
boolean
true
면 드래그로 행들을 선택할 수 있다.
선택 영역은 하나만 존재할 수 있고, 범위를 조정할 수 있다. - skeletonVisible:
boolean
dataLoading이 true
로 지정되고, 이 속성이true
로 지정되면 skeleton view가 표시된다. - state:
object
앱에서 관리하는 상태 정보 객체.
값의 변경은 setState 속성을 호출한다. 리턴되는 객체는 원본 객체이지만 리턴된 객체 속성을 직접 변경하면 컨트롤 표시에 바로 반영되지 않는다. 값의 변경 여부는 원본 객체의 최상위 속성 비교로 판단한다. - style: CSSStyles
컨트롤에 적용되는 기본 스타일셋. - syncOrientation:
boolean
Defaulttrue
컨트롤 방향 설정 기준.
true
면 컨트롤 크기와 상관없이 기기 방향에 따르고,false
면 너비가 높이보다 클 때 landscape가 된다. - syncScreenOrientation:
boolean
syncOrientation이 true
일 때, 컨트롤 크기와 상관 없이 단말기 방향에 맞춰 orientation 속성을 자동 설정. - textFormat:
string
문자열 값을 특정 패턴의 문자열로 변환하는 형식.
렌더러 등에서 별도로 지정하지 않으면 이 형식이 적용된다. textFormatter가 설정되면 이 속성은 무시된다.
Text Formtter 도음말을 참조한다. - textFormatter: RtTextFormatter
문자열 값을 다른 패턴의 문자열로 변환하는 콜백.
렌더러 등에서 별도로 지정하지 않으면 이 콜백이 적용된다. 이 속성이 설정되면 textFormat은 무시된다. - topRow:
number
현재 표시되는 시작(최상단) 데이터행 index.
현재 표시되는 데이터행이 하나도 없다면 -1이다.
Methods
- checkAll
function checkAll(checked: boolean, force=false): boolean;
Parametersparam type opt default description checked boolean N 체크 상태 여부. force boolean Y false
true
면 checkable이false
이어도 checked 상태를 변경한다.Returnsboolean - 변경된 행이 하나라도 존재하면true
.모든 데이터행의 체크 상태를 변경한다. See Also
- checkAllRows
function checkAllRows(checked: boolean, force=false): boolean;
Parametersparam type opt default description checked boolean N 체크 상태. force boolean Y false
true
면 checkable이false
이어도 checked 상태를 변경한다.Returnsboolean - 변경된 행이 하나라도 존재하면true
.모든 데이터행의 체크 상태를 변경한다. See Also
- checkRow
function checkRow(row: number, checked: boolean, force=false): boolean;
Parametersparam type opt default description row number N 데이터행 번호 checked boolean N 체크 상태. force boolean Y false
true
면 checkable이false
이어도 checked 상태를 변경한다.Returnsboolean - 체크 상태가 변경됐으면true
.지정된 데이터행의 체크 상태를 설정한다.
현재 체크 상태를 뒤바꾸려면 toggleChecked를 호출한다. rowClickAction이 RtRowClickAction.CHECK이면 사용자가 데이터행을 탭할 때 체크 상태가 뒤바뀐다.See Also
- checkRowRange
function checkRowRange(row: number, count: number, checked: boolean, force=false): number[];
Parametersparam type opt default description row number N 시작 행 번호. count number N 행 수. checked boolean N 체크 여부. force boolean Y false
true
면 checkable이false
이어도 checked 상태를 변경한다.Returnsnumber[] - checked 상태가 변경된 행 번호 목록.지정한 범위에 포함된 행들의 checked 상태를 변경한다. - checkRows
function checkRows(rows: number[], checked: boolean, force=false): number[];
Parametersparam type opt default description rows number[] N 행 번호 목록. checked boolean N 체크 여부. force boolean Y false
true
면 checkable이false
이어도 checked 상태를 변경한다.Returnsnumber[] - 체크 상태가 변경된 행 번호 목록.지정한 행들의 체크 상태를 변경한다. - checkSearchedRows
function checkSearchedRows(clear=false, force=false): void;
Parametersparam type opt default description clear boolean Y false
true
면 기존 checked를 모두 해제한다.force boolean Y false
true
면 checkable이false
이어도 checked 상태를 변경한다.Returnsvoid현재 검색된 행들을 모두 checked 상태로 만든다. - childrenOfGroup
function childrenOfGroup(group: IRtGroupProxy): IRtGroupProxy[];
Parametersparam type opt default description group IRtGroupProxy N 그룹 정보. ReturnsIRtGroupProxy[] - 자식 그룹 정보 배열.지정한 group의 자식 그룹 정보를 리턴한다. 하나도 없으면 빈 배열을 리턴한다.
그룹핑 상태가 이니거나 존재하지 않는 아이템 위치이면null
을 리턴한다. - clearFloatings
function clearFloatings(animate=true): void;
Parametersparam type opt default description animate boolean Y true
감출 때 애니메이션 처리할 것인 지 여부. Returnsvoid표시된 모든 Floating 아이템들을 감춘다. - closeEditPage
function closeEditPage(commit: boolean, animate=true): void;
Parametersparam type opt default description commit boolean N true
면 편집을 완료하고 데이터에 반영하고,false
면 취소한다.animate boolean Y true
true
면 view를 닫을 때 애니메이션 효과가 적용된다.Returnsvoid행 편집 페이지가 표시된 상태면 닫는다.
편집 뷰 내의 버튼 등에서 호출할 수 있다. 편집 뷰는 showEditPage로 표시한다.{ renderer: { type: 'button', onClick: args => args.control.closeInfoPage(true); } }
See Also
- closeInfoPage
function closeInfoPage(animate=true): void;
Parametersparam type opt default description animate boolean Y true
true
면 view를 닫을 때 애니메이션 효과가 적용된다.Returnsvoid행 정보 페이지가 표시된 상태면 닫는다.
Info 뷰 내의 버튼 등에서 호출할 수 있다. 행 Info 뷰는 showInfoPage로 표시한다.See Also
- closeMenu
function closeMenu(animate=true): void;
Parametersparam type opt default description animate boolean Y true
true
면 메뉴를 닫을 때 애니메이션 효과가 적용된다.Returnsvoid표시된 메뉴를 닫는다. See Also
- closePanel
function closePanel(animate=true): void;
Parametersparam type opt default description animate boolean Y true
true
면 패널을 닫힐 때 애니메이션 효과가 적용된다.Returnsvoid열려 있는 패널을 닫는다. - collapseAll
function collapseAll(): void;
Returnsvoid그룹핑 상태일 때 모든 그룹을 접는다. - collapseGroup
function collapseGroup(group: IRtGroupProxy, recursive: boolean=true): boolean;
Parametersparam type opt default description group IRtGroupProxy N 그룹 정보. recursive = true N Returnsboolean - 실제 collapse 되면true
.지정한 그룹이 펼쳐진 상태라면 그룹을 접고 true
를 리턴한다.
아니면false
를 리턴한다. 그룹핑 상태가 아니거나 존재하지 않는 그룹이면 아무것도 하지 않는다. - collapseGroupByRow
function collapseGroupByRow(row: number);
Parametersparam type opt default description row number N 행 번호. Returns접은 그룹이 있으면true
행 번호로 그룹을 접는다. - dataGroupBy
function dataGroupBy(infos: {[data: string]: IDataGroupInfo}, initOptions?: IRtGroupingOptions): void;
Parametersparam type opt default description infos {[data : string] : IDataGroupInfo } N 단계별 그룹핑 정보. initOptions IRtGroupingOptions Y 그룹핑 초기 표시 방식 등에 대한 설정. Returnsvoid데이터그룹 모델을 생성 구축한다.
컨트롤에 연결된 데이터소스가 RtDataLinkView일 때만 실행할 수 있다. - expandAll
function expandAll(): void;
Returnsvoid그룹핑 상태일 때 모든 그룹을 펼친다. - expandGroup
function expandGroup(group: IRtGroupProxy, recursive: boolean=true): boolean;
Parametersparam type opt default description group IRtGroupProxy N 그룹 정보. recursive = true N Returnsboolean - 실제 expand 되면true
.지정한 그룹이 접힌 상태라면 그룹을 펼치고 true
를 리턴한다.
아니면false
를 리턴한다. 그룹핑 상태가 아니거나 존재하지 않는 그룹이면 아무것도 하지 않는다. - expandGroupByRow
function expandGroupByRow(row: number): boolean;
Parametersparam type opt default description row number N 행 번호. Returnsboolean - 펼친 그룹이 있으면true
행 번호로 그룹을 펼친다. - getCheckedRows
function getCheckedRows(checked=true): number[];
Parametersparam type opt default description checked boolean Y true
체크 여부. Returnsnumber[] - 행 번호 목록. 하나도 없으면 빈 배열을 리턴한다.지정한 체크 상태와 동일한 상태의 데이터행 번호들을 배열로 리턴한다. - getDetailedRows
function getDetailedRows(collapsed: boolean): number[];
Parametersparam type opt default description collapsed boolean N 더보기 여부. Returnsnumber[] - 행 번호 목록.지정한 더보기(접햄) 상태와 동일한 상태의 데이터행 번호들을 배열로 리턴한다. - getEditValues
function getEditValues(): RtRowValues;
ReturnsRtRowValues - 필드 값json
객체.행 편집 view가 표시된 상태일 때,
현재까지의 필드 값들을json
객체로 리턴한다.See Also
- getFlaggedRows
function getFlaggedRows(flag: number, set: boolean): number[];
Returnsnumber[] - 플래그가 지정된 데이터행 번호 배열. 행이 하나도 없으면 빈 배열.지정된 위치에 플래그가 설정된 모든 데이터행들의 번호를 리턴한다. - getSelectedRows
function getSelectedRows(): number[];
Returnsnumber[] - 행 번호 목록.선택 영역에 포함된 데이터행 번호들을 배열로 리턴한다. - groupOfRow
function groupOfRow(row: number): IRtGroupProxy;
Parametersparam type opt default description row number N 데이터행 번호. ReturnsIRtGroupProxy - 그룹 정보 객체.row 행이 포함된그룹의 정보를 리턴한다.
그룹핑 상태 또는 그룹핑 상태가 이니거나 존재하지 않는 데이터행이면null
을 리턴한다. - hideFloating
function hideFloating(item: string, animate=true): void;
Parametersparam type opt default description item string N Floating 아이템 이름. animate boolean Y true
감출 때 애니메이션 처리할 것인 지 여부. ReturnsvoidFloating 아이템을 감춘다. - isRowCheckable
function isRowCheckable(row: number): boolean;
Parametersparam type opt default description row number N 데이터행 번호. Returnsboolean - 체크 가능 여부.사용자가 체크할 수 있는 데이터행이면 true
를 리턴한다. - isRowChecked
function isRowChecked(row: number): boolean;
Parametersparam type opt default description row number N 데이터행 번호 Returnsboolean - 행이 체크됐으면true
.지정된 데이터행이 체크된 상태면 true
리턴. - isRowDetailed
function isRowDetailed(row: number): boolean;
Parametersparam type opt default description row number N 데이터행 번호. Returnsboolean - 더보기 상태true
.지정된 데이터행이 더보기(접힘) 상태면 true
리턴. - isRowFlagged
function isRowFlagged(row: number, flag: number): boolean;
Returnsboolean - 설정됐다면true
, 아니면false
나undefined
.지정된 데이터행에 flag 위치의 플래그가 설정됐다면 true
를 리턴한다.
각 데이터행별로 0에서 15 사이의 16개 다른 플래그를 설정할 수 있다. - isRowSelected
function isRowSelected(row: number): boolean;
Parametersparam type opt default description row number N 데이터행 번호 Returnsboolean - 행이 선택에 포함되면true
.지정된 데이터행이 선택 영역에 포함되면 true
. - makeRowVisible
function makeRowVisible(row: number): void;
Parametersparam type opt default description row number N 데이터행 번호 Returnsvoid지정한 데이터행이 화면에 노출되도록 스크롤한다.
현재 표시된 상태라면 아무일도 하지 않는다.See Also
- parentOfGroup
function parentOfGroup(group: IRtGroupProxy): IRtGroupProxy;
Parametersparam type opt default description group IRtGroupProxy N 그룹 정보. ReturnsIRtGroupProxy - 부모 그룹 정보 객체.지정한 group의 부모 그룹 정보를 리턴한다.
그룹핑 상태가 이니거나 존재하지 않는 그룹이면null
을 리턴한다. - registerIconSet
function registerIconSet(name: string, icons: IRtIconSet): void;
Parametersparam type opt default description name string N 아이콘셋 이름 icons IRtIconSet N 아이콘셋 정보 ReturnsvoidIListIconRenderer 등에서 사용할 수 있도록, 동일한 크기로 표시되는 관련된 이미지 아아콘들의 url을 묶어서 등록한다. - registerRowCommand
function registerRowCommand(commandName: string, config: IRtRowCommand, overwrite=false): void;
Parametersparam type opt default description commandName string N command 이름. config IRtRowCommand N overwrite boolean Y false
같은 이름의 커맨드가 이미 존재하는 경우, 이 값이 false
이면 예외가 발생한다.Returnsvoid데이터행 커맨드를 등록한다.
라이브러리 수준에서 미리 등록된 command들이 존재하므로, 이름에 고유 prefix를 붙여서 설정한다.See Also
- registerShape
function registerShape(shape: IRtShape): void;
Parametersparam type opt default description shape IRtShape N shape 정보 객체. name 속성이 '@'로 시작하면 미리 등록된(stock) shape의 svg를 변경한다. Returnsvoid데이터 행의 Row Bar 나 Action Bar 영역에 표시되는 Shape를 등록한다. list.registerShape({ name: 'people', d: 'M18.4 44 V17 Q25.3 11.3 23.8 11.3Z', width: 48, height: 48 );
See Also
- registerShapes
function registerShapes(shapes: IRtShape[]): void;
Parametersparam type opt default description shapes IRtShape[] N Shape 이름별 등록 정보가 설정된 json
객체. shape 이름이 '@'로 시작하면 미리 등록된(stock) shape의 svg를 변경한다.Returnsvoid데이터 행의 Row Bar 나 Action Bar 영역에 표시되는 여러 Shape들을 동시에 등록한다. list.registerShapes([{ name: 'man', d: 'M18.4 44V17.1q-4.75-1-7.625-4.275Q7.9 9.55 7.9 5.2h3 Q25.3 11.3 23.8 11.3Z', width: 48, height: 48 }, { name: 'woman', d: 'M21 44V33h-6l5.1-16.4q.4-1.25 1.5-1.925T24 14 Q25.5 11.3 24 11.3Z', width: 48, height: 48 }]);
- registerTemplate
function registerTemplate(template: any, name?: string, vars?: any): string;
Parametersparam type opt default description template any N 템플릿 object
.name string Y 템플릿 이름. 이 값을 지정하지 않으면 template 객체의 name이나 자동 생성되는 이름으로 저장된다. vars any Y template의 vars를 수정하거나 교체한다. template 소스를 재사용할 때 사용될 수 있다. Returnsstring - 템플릿 이름.이 컨트롤에 한정된 템플릿을 컨트롤에 등록한다.
등록된 템플릿들은 템플릿을 설정하는 여러 영영에서 템플릿 이름으로 지정될 수 있다.See Also
- registerTemplates
function registerTemplates(templates: any): void;
Parametersparam type opt default description templates any N 템플릿 object
map.Returnsvoid이 컨트롤에 한정된 하나 이상의 템플릿을 컨트롤에 등록한다.
등록된 템플릿들은 템플릿을 설정하는 여러 영영에서 템플릿 이름으로 지정될 수 있다. 이름과 템플릿 소스를 지정한다. 추가 vars 정보를 지정하고 싶은 경우 [소스, vars] 형태로 지정한다. registerTemplate을 참조한다. - resetSize
function resetSize(): void;
Returnsvoid컨테이너 div의 크기 변경 후 리스크 컨트롤의 크기가 갱신되도록 한다. #433 - rowGroupBy
function rowGroupBy(infos: (IRtRowGroupInfo|string)|(IRtRowGroupInfo|string)[], initOptions?: IRtGroupingOptions): void;
Parametersparam type opt default description infos ( IRtRowGroupInfo | string ) | ( IRtRowGroupInfo | string ) [] N 단계별 그룹핑 정보. initOptions IRtGroupingOptions Y 그룹핑 초기 표시 방식 등에 대한 설정. Returnsvoid행 그룹핑한다.
기존에 paging 상태였다면, paging을 먼저 취소한다. - scrollToEnd
function scrollToEnd(row?: number): void;
Parametersparam type opt default description row number Y 데이터행 번호. 0보다 작거나 NaN
이면 attached row가 표시되게 한다.Returnsvoid지정한 데이터행이 마지막 행으로 표시되게 스크롤한다. See Also
- search
function search(key: any, options?: IRtSearchOptions): IRtSearchField[];
Parametersparam type opt default description key any N 검색 키 값. options IRtSearchOptions Y 검색 옵션. ReturnsIRtSearchField[] - 검색 결과 목록.지정한 키값과 옵션에 따라 검색을 실행한다. - setAllRowsDetailed
function setAllRowsDetailed(collapsed: boolean): boolean;
Parametersparam type opt default description collapsed boolean N 더보기 상태 Returnsboolean - 변경된 행이 하나라도 존재하면true
.모든 데이터행의 더보기(접힘) 상태를 변경한다. - setCommandRow
function setCommandRow(row: number, animate=true);
Parametersparam type opt default description row number N 데이터행 번호 animate boolean Y true
true
면 커맨드롤 표시하거나 감출 때 animation이 진행된다.ReturnsRow command가 표시되는 데이터행을 지정한다.
지정한 행이 현재 화면에 표시되는 위치가 아니면 스크롤해서 표시한다. -1로 지정하면 기존 커맨드 표시가 감춰진다. 커맨드 행으로 지정된 행이 스크롤로 사라지게 되거나, 다른 행을 터치하면 자동으로 감춘다. 보통, 사용자가 데어터행을 swipe하거나 클릭해서 command를 표시하게 된다.See Also
- setConfig
function setConfig(config: any): RtListControl;
Parametersparam type opt default description config any N 설정 정보 객체. Returns지정한 설정 정보로 리스트 컨트롤을 초기 구성한다.
정보의 모든 항목들은 개별 속성 api를 통해 별도로 설정할 수 있지만, 하나의 설정 객체를 통해 보다 편리하게 리스트를 초기 구성할 수 있다.
크게 컨트롤 속성과 옵션 설정으로 나뉘는 데, 옵션은 주로 컨트롤 구성 요소들에 대한 것으로, 모바일 기기 상태에 따라 별도의 템플릿 설정이 필요한 것들이다.list = RealTouch.createListControl(document, 'list'); list.setConfig({ props: { numberFormat: ',', templates: { 'row': row_template, 'prow': portrait_row, 'lrow': landscape_row, 'footer': footer_template }, tables: {}, commands: [], shapes: [], icons: [], ... }, options: { // 공통 옵션 row: { template: 'row' } header: { ... }, footer: { template: 'footer', ... }, ... }, landscape: { // 기기가 가로 모드일 때 옵션 row: { template: 'prow' }, ... }, portrait: { // 기기기 세로 모드일 때 옵션 row: { template: 'lrow' }, ... } })
- setDataAppending
function setDataAppending(appending: boolean, scroll=true): boolean;
ReturnsdataAppending 상태를 변경한다. 실제 변경되면 true
를 리턴한다.
appending, scroll 모두true
이면 마지막 행 다음에, 행 추가 spinner가 표시되는 attached row가 표시되도록 마지막 행 끝까지 스크롤된다.See Also
- setDataLoading
function setDataLoading(value: boolean): boolean;
Parametersparam type opt default description value boolean N ReturnsdataLoading 상태를 변경한다. 실제 변경되면 true
를 리턴한다. - setFocusedRow
function setFocusedRow(row: number): void;
Parametersparam type opt default description row number N 데이터행 번호 Returnsvoid지정한 행을 focused 상태로 설정한다.
행 하나만 focused 상태가 될 수 있다. 현재 focused 상태의 데이터행은 focusedRow 속성으로 알 수 있다.See Also
- setLandscape
function setLandscape(config: any): RtListControl;
Parametersparam type opt default description config any N 속성 설정 값들 ReturnsRtListControl - 컨트롤 객체 자신landscape 옵션 속성들을 동시에 설정한다. - setOptions
function setOptions(config: any): RtListControl;
Parametersparam type opt default description config any N 속성 설정 값들 ReturnsRtListControl - 컨트롤 객체 자신공통 옵션 속성들을 동시에 설정한다. - setPaging
function setPaging(options: IRtPageOptions): RtListControl;
Parametersparam type opt default description options IRtPageOptions N IListPageOptions 페이징 설정 옵션. undefined
나null
이면 paiging 취소.Returns데이터행들을 페이지 단위로 표시한다. - setPortrait
function setPortrait(config: any): RtListControl;
Parametersparam type opt default description config any N 속성 설정 값들 ReturnsRtListControl - 컨트롤 객체 자신portrait 옵션 속성들을 동시에 설정한다. - setRowDetailed
function setRowDetailed(row: number, detailed: boolean, exclusive=false): void;
Parametersparam type opt default description row number N 데이터행 번호 detailed boolean N 더보기 상태. exclusive boolean Y false
Returnsvoid지정된 데이터행의 더보기(접힘) 상태를 변경한다. - setRowFlag
function setRowFlag(row: number, flag: number, set: boolean): boolean;
Parametersparam type opt default description row number N 데이터행 번호 flag number N flag 위치. 0 ~ 15 사이의 값을 가질 수 있다. set boolean N true
면 플래그 설정, 아니면 해제.Returnsboolean - 실제로 플래그 설정 상태가 변경되면true
, 아니면false
나undefined
.지정된 데이터행에 flag 위치의 플래그를 설정하거나 해제한다.
각 데이터행별로 0에서 15 사이의 16개 다른 플래그를 설정할 수 있다. - setRowFlagAll
function setRowFlagAll(flag: number, set: boolean): boolean;
Returnsboolean - 변경된 행아 하나라도 존재하면true
, 아니면false
나undefined
.모든 데이터행에 설정된 지정된 위치의 플래그를 해제한다. - setRowRangeDetailed
function setRowRangeDetailed(data: RtDataSource, row: number, count: number, collapsed: boolean): number[];
Parametersparam type opt default description data RtDataSource N row number N 시작 행 번호. count number N 행 수. collapsed boolean N 더보기 상태. Returnsnumber[] - 더보기 상태가 변경된 행 번호 목록.지정한 범위에 포함된 행들의 더보기(접힙) 상태를 변경한다. - setRowRangeFlag
function setRowRangeFlag(row: number, count: number, flag: number, set: boolean): number[];
Parametersparam type opt default description row number N 범위의 시작 행. count number N 범위의 연속된 데이터 행 수. flag number N flag 위치. 0 ~ 15 사이의 값을 가질 수 있다. set boolean N true
면 플래그 설정, 아니면 해제.Returnsnumber[] - 실제로 플래그 상태가 변경된 데이터행 번호 배열. 행이 하나도 없으면 빈 배열.연속적으로 지정된 범위의 데이터행들에 flag 위치의 플래그를 설정하거나 해제한다.
각 데이터행별로 0에서 15 사이의 16개 다른 플래그를 설정할 수 있다. - setRowsDetailed
function setRowsDetailed(data: RtDataSource, rows: number[], collapsed: boolean): number[];
Parametersparam type opt default description data RtDataSource N rows number[] N 행 번호 목록. collapsed boolean N 더보기 여부. Returnsnumber[] - 더보기 상태가 변경된 행 번호 목록.지정한 행들의 더보기(접힘) 상태를 변경한다. - setRowsFlag
function setRowsFlag(rows: number[], flag: number, set: boolean): number[];
Parametersparam type opt default description rows number[] N 데이터행 번호 목록. flag number N flag 위치. 0 ~ 15 사이의 값을 가질 수 있다. set boolean N true
면 플래그 설정, 아니면 해제.Returnsnumber[] - 실제로 플래그 상태가 변경된 데이터행 번호 배열. 행이 하나도 없으면 빈 배열.지정된 데이터행들에 flag 위치의 플래그를 설정하거나 해제한다.
각 데이터행별로 0에서 15 사이의 16개 다른 플래그를 설정할 수 있다. - setSelection
function setSelection(start: number, end: number): void;
Returnsvoid기존 선택 영역을 제거하고, 지정된 범위의 데이터행들을 선택한다.
끝 행 번호가 시작 행 번호보다 크게 지정되면 뒤바뀐 값으로 설정된다. - setState
function setState(value: object): void;
Parametersparam type opt default description value object N 변경살 상태값들을 포함한 json
객체.Returnsvoid사용자 상태 정보를 수정한다.
json
객체로 전달해서 여러 상태값을 변경할 수 있다. - showButtonPanel
function showButtonPanel(animate=true): void;
Parametersparam type opt default description animate boolean Y true
true
면 패널을 표시할 때 애니메이션 효과가 적용된다.Returnsvoid버튼 패널을 표시한다. See Also
- showEditPage
function showEditPage(row: number, model?: IRtRowView, animate=true): void;
Parametersparam type opt default description row number N 데이터행 번호. model IRtRowView Y 편집 뷰 설정 정보 모델. animate boolean Y true
true
면 view를 표시할 때 애니메이션 효과가 적용된다.Returnsvoid행 편집 페이지를 표시한다.
row가 0보다 작으면 행 추가, row가 타당한 행 번호면 행 편집 view가 표시된다. 아니면, 아무것도 실행하지 않는다. - showFilterPanel
function showFilterPanel(options: IListFilterPanel, animate=true): void;
Parametersparam type opt default description options IListFilterPanel N animate boolean Y true
true
면 패널을 표시할 때 애니메이션 효과가 적용된다.Returnsvoid검색 패널을 표시한다. See Also
- showFloating
function showFloating(item: string, animate=true): void;
Parametersparam type opt default description item string N Floating 아이템 이름. animate boolean Y true
표시할 때 애니메이션 처리할 것인 지 여부. ReturnsvoidFloating 아이템을 표시한다. - showFormPanel
function showFormPanel(animate=true): void;
Parametersparam type opt default description animate boolean Y true
true
면 패널을 표시할 때 애니메이션 효과가 적용된다.Returnsvoid폼 패널을 표시한다. See Also
- showInfoPage
function showInfoPage(row: number, model?: IRtRowView, animate=true): void;
Parametersparam type opt default description row number N 데이터행 번호 model IRtRowView Y info view 설정 정보 모델 animate boolean Y true
true
면 view를 열 때 애니메이션 효과가 적용된다.Returnsvoid행 정보 페이지를 표시한다.
row가 타당한 값이 아니면 실행되지 않는다.See Also
- showMenu
function showMenu(menu: IRtMenu|string, animate=true): void;
Parametersparam type opt default description menu IRtMenu | string N 메뉴 객체 혹은 컨트롤에 등록된 메뉴 이름. 지정하지 않으면 컨트롤 옵션에 지정한 기본 메뉴가 표시된다. animate boolean Y true
true
면 메뉴를 표시할 때 애니메이션 효과가 적용된다.Returnsvoid메뉴룰 표시한다.
menu 매개변수로 전달되는 메뉴 구성 정보 객체로부터 내부 메뉴 걕체가 생성된다. 메뉴 표시 중 check된 항목들의 상태를 유지하기 위해, 이전 호출에 사용됐던 객체라면 그 정보로 등록된 내부 메뉴가 재사용된다. - showSearchPanel
function showSearchPanel(optons?: IRtSearchOptions, animate=true): void;
Parametersparam type opt default description optons IRtSearchOptions Y animate boolean Y true
true
면 패널을 표시할 때 애니메이션 효과가 적용된다.Returnsvoid검색 패널을 표시한다. See Also
- showToast
function showToast(toast: IRtToast|string): void;
Returnsvoid토스트 메시지를 표시한다. - stopAutoScroll
function stopAutoScroll(): void;
Returnsvoid진행 중인 행 auto scroll을 중지시킨다. - stopFling
function stopFling(): boolean;
Returnsboolean - 스크롤 중이었다면true
.Swipe 제스처로 행 fling 스크롤 중이면 중지 시칸다. - toggleChecked
function toggleChecked(row: number, force=false): void;
Parametersparam type opt default description row number N 데이터행 번호 force boolean Y false
true
면 checkable이false
이어도 checked 상태를 변경한다.Returnsvoid지정된 데이터행의 체크 상태를 뒤바꾼다.
rowClickAction이 RtRowClickAction.CHECK이면 사용자가 데이터행을 탭할 때 체크 상태가 뒤바뀐다.See Also
- toggleFloating
function toggleFloating(item: string, animate=true): void;
Parametersparam type opt default description item string N Floating 아이템 이름. animate boolean Y true
표시하거나 감출 때 애니메이션 처리할 것인 지 여부. Returnsvoid표시된 Floating 아이템은 감추고, 감춰진 것은 표시한다. - unregisterRowCommands
function unregisterRowCommands(commandNames: string[]): void;
Parametersparam type opt default description commandNames string[] N 커맨드 이름 목록 Returnsvoid기존에 등록된 데이터행 커맨드들을 제거한다. See Also
- updateRowCommand
function updateRowCommand(commandName: string, config: IRtRowCommand): void;
Parametersparam type opt default description commandName string N 커맨드 이름 config IRtRowCommand N 커맨드 설정 객체 Returnsvoid기존에 등록된 행 커맨드 설정을 변경한다. See Also