PropertyEventMethod찾아보기
WebSquare.uiplugin.dataMap - 5.0_5.5283A.20250313.190345

데이터 통신 및 화면에서 사용할 데이터로 키(Key)와 값(Value)으로 이루어진 단일 객체이고 자바의 Map 객체와 비슷한 구조를 가짐
데이터컬렉션 하위에 생성되며 데이터의 구조를 정의하는 keyInfo 영역과 초기값을 정의하는 데이터 영역으로 나뉨
keyInfo 영역(source : <w2:keyInfo>)은 키(Key)의 정보가 있으며 키(Key)의 아이디 속성에 키(Key)의 이름을 정의함
데이터 영역(source : <w2:data>)은 키(Key)의 초기값을 정의하는 곳이며 데이터 사용이 체크되어있어야(source : <w2:data use="true">) 초기값이 적용됨

Type

uiplugin

Property Summary

attributeMap
데이터 타입이 XML일 경우만 적용이 되는 기능으로, rootNode에 추가 특성을 지정하고자 하는 DataMap의 이름
baseNode
[default:map] 데이터 타입이 XML일 경우만 적용되며 데이터를 XML로 변환 시 데이터의 노드로 정의할 XPath를 명시
defaultValue
키(Key)의 초기값
firstSet
[default:false, true] DataMap에 초기값을 정의하지 않았을 경우, API(setValue 등) 또는 사용자가 최초 입력한 값을 초기값으로 설정할지의 여부
firstSetSubmission
[default:false, true] DataMap에 setJSON, setXML API를 호출하거나 서브미션을 날려서 데이터가 갱신된 경우, 초기값으로 설정할지에 대한 여부
id
객체의 아이디
idAttribute
데이터 타입이 XML일 경우만 적용이 되는 기능
length
컬럼의 데이터 길이
nullYNType
key 속성이 nullYN인 key에서 공백 값에 대한 처리를 지정하는 속성
userData1
사용자 정의 데이터 속성
userData2
사용자 정의 데이터 속성
userData3
사용자 정의 데이터 속성
valueAttribute
실제 데이터를 특성에 할당할 때 사용 (데이터 타입이 XML일 경우만 적용됨)

Event Summary

onbeforemodelchange
특정 키(Key)에 대한 값 (Value)이 변경되기 직전에 발생하고 이벤트 핸들러 함수에서 false를 리턴할 경우 변경 동작이 취소됨
onkeyset
set API를 호출하는 경우 매번 발생하는 이벤트
onmodelchange
특정 키(Key)에 대한 값(Value)이 변경된 이후에 발생
onsetdata
setJSON 또는 setXML 관련 API를 통해 데이터를 설정하거나, 서브미션의 Target(받아올 데이터)과 연동되어 통신의 결과가 설정될 때 발생하는 이벤트

Method Summary

bind( eventType , function )
DataMap의 이벤트를 동적으로 할당함
get( key )
KeyInfo에 정의되어있는 키(Key) 아이디에 할당된 값(Value)을 반환
getArray( )
DataMap 전체 데이터를 KeyInfo에 정의된 순서대로 배열에 담아 반환
getCount( )
DataMap에 정의된 키(Key)의 개수를 반환
getID( )
DataMap 객체의 아이디를 반환하고 객체의 아이디 속성과 동일한 값을 반환함
getIndex( keyID )
키(Key)의 아이디로 KeyInfo에 정의된 키(Key)의 인덱스를 반환함
getInfo( )
DataMap의 세부 정보를 조회
getJSON( )
DataMap 전체 데이터를 JSON으로 반환함
getKey( keyIndex )
키(Key)의 인덱스를 받아서 아이디명을 반환함
getKeyInfo( key )
DataMap의 특정 키(Key)의 세부 정보를 조회
getModifiedArray( )
DataMap의 최초 설정 값과 현재 데이터의 값이 다른 키(Key) 배열과 값(Value) 배열을 JSON으로 반환 (DataMap의 firstSet 속성과 연관)
getModifiedData( )
최초 설정 값과 현재 데이터의 값이 다른 키(Key) 배열과 값(Value) 배열을 반환 (DataMap의 firstSet 속성과 연관)
getModifiedIndex( )
DataMap의 최초 설정 값과 현재 데이터의 값이 다른 키(Key)들의 인덱스를 배열로 반환 (DataMap의 firstSet 속성과 연관)
getModifiedJSON( )
최초 설정 값과 현재 데이터의 값이 다른 키(Key)들을 JSON으로 반환
getModifiedKey( )
최초 설정 값과 현재 데이터의 값이 다른 키(Key)들을 배열로 반환
getModifiedXML( )
최초 설정 값과 현재 데이터의 값이 다른 키(Key)들을 XML로 반환
getName( keyID )
키(Key)의 아이디로 name에 정의된 값을 반환
getObjectType( )
데이터컬렉션 형식 반환
getOption( attr )
속성명으로 속성의 값을 반환
getOriginal( KeyID )
키(Key) 아이디에 할당된 초기값을 반환
getRefComponent( )
dataMap과 ref로 연동된 component id 반환
getScope( )
컴포넌트가 scope=true인 WFrame의 자식 컴포넌트일 때 해당 부모 WFrame 객체를 반환하는 함수
getScopeWindow( )
컴포넌트가 scope=true인 WFrame의 자식 컴포넌트일때 해당 부모 WFrame의 Scope객체를 반환
getType( KeyID )
KeyInfo에 정의된 키(Key)의 dataType 속성값을 반환
getXML( )
DataMap의 전체 데이터를 XML 형태로 반환
initRowStatus( )
DataMap의 상태를 모두 '변경되지 않음' 상태로 설정
keepDataType( )
데이터를 세팅할 때나 뷰를 통해 데이터를 수정하는 경우, dataType이 number인 데이터에 한해 number로 타입캐스팅하도록 하는 기능
modifyKeyStatus( key , isModified )
키(Key)에 해당하는 상태값을 '변경됨' 또는 '변경되지 않음' 상태로 조작
preserveType( )
preserveType="true" 설정시 dataType이 number/text인 데이터에 한해 number/text로 타입캐스팅)
redo( )
restore()한 값을 다시 한 단계 되돌림
reform( )
최초 설정 값을 현재의 키(Key) 값으로 바꾸고, 키(Key)의 상태를 초기 상태인 '변경되지 않음' 으로 설정
restore( )
데이터를 변경 한 단계 전으로 되돌림 (한번 수행 시마다 한 단계씩 되돌아감)
set( KeyID , KeyValue )
지정한 키(Key)에 값을 설정함
setArray( arrayData )
DataMap의 전체 데이터를 설정
setEmptyValue( )
키(Key) 값을 확인하여 빈 값으로 설정함 (컬럼에 defaultValue 속성이 설정된 경우, defaultValue 값으로 설정됨)
setJSON( jsonData )
DataMap의 전체 데이터를 JSON으로 설정
setXML( xmlData )
DataMap의 전체 데이터를 XML로 설정
trigger( eventType , paramArray )
DataMap에 등록된 특정 이벤트를 직접 발생시킴
unbind( eventType , function )
정의된 이벤트를 제거
undo( )
키(Key)와 값(Value)을 최초 설정 값으로 변경

Property Detail

attributeMap
데이터 타입이 XML일 경우만 적용이 되는 기능으로, rootNode에 추가 특성을 지정하고자 하는 DataMap의 이름
본 속성에 명시된 DataMap의 키(Key)와 값(Value)이 rootNode의 특성 이름과 값(Value)으로 정의됨
baseNode
[default:map] 데이터 타입이 XML일 경우만 적용되며 데이터를 XML로 변환 시 데이터의 노드로 정의할 XPath를 명시
defaultValue
키(Key)의 초기값
firstSet
[default:false, true] DataMap에 초기값을 정의하지 않았을 경우, API(setValue 등) 또는 사용자가 최초 입력한 값을 초기값으로 설정할지의 여부 (옵션 설명) "true" : 빈 값('')이 초기값으로 설정 "false" (기본값) : API(setValue 등) 또는 사용자가 최초 입력한 값이 초기값으로 설정
firstSetSubmission
[default:false, true] DataMap에 setJSON, setXML API를 호출하거나 서브미션을 날려서 데이터가 갱신된 경우, 초기값으로 설정할지에 대한 여부 (옵션 설명) "true" : 서브미션을 날릴 때마다 해당 데이터를 초기값으로 설정 "false" (기본값) : 서브미션을 날릴 때마다 해당 데이터를 초기값으로 설정하지 않음
id
객체의 아이디
전역 객체로 할당되며 서브미션 및 각종 API 사용시 데이터를 구분하기 위한 키(Key)로 사용
idAttribute
데이터 타입이 XML일 경우만 적용이 되는 기능
아이디에 정의된 값을 아이디 특성이 아닌 다른 특성으로 정의하고자 할 경우 사용
length
컬럼의 데이터 길이
nullYNType
key 속성이 nullYN인 key에서 공백 값에 대한 처리를 지정하는 속성 (옵션 설명) default (기본 값) : data를 조회하는 API(아래 관련 함수) 호출 시 결과값이 기존과 동일하게 동작함. exclude : data를 조회하는 API 호출 시 nullYN="true"인 key에 대해 공백 값은 키에서 제외하고 값을 반환함. null : data를 조회하는 API 호출 시 nullYN="true"인 key에 대해 공백 값을 null로 변경하여 반환함. (관련 함수) $p.data.get("JSON"); dataMap1.get(); dataMap1.getModifiedJSON(); (관련 속성) dataMap key의 nullYn 속성값. 이 속성값이 true인 key에 대해서만 이 설정이 동작한다.
userData1
사용자 정의 데이터 속성
API를 통해 설정한 값을 얻어올 수 있음 (관련 함수) getUserData();
// 속성 값 얻어오기 예시 getUserData("userData1");
userData2
사용자 정의 데이터 속성
API를 통해 설정한 값을 얻어올 수 있음 (관련 함수) getUserData();
// 속성 값 얻어오기 예시 getUserData("userData2");
userData3
사용자 정의 데이터 속성
API를 통해 설정한 값을 얻어올 수 있음 (관련 함수) getUserData();
// 속성 값 얻어오기 예시 getUserData("userData3");
valueAttribute
실제 데이터를 특성에 할당할 때 사용 (데이터 타입이 XML일 경우만 적용됨)

Event Detail

onbeforemodelchange
특정 키(Key)에 대한 값 (Value)이 변경되기 직전에 발생하고 이벤트 핸들러 함수에서 false를 리턴할 경우 변경 동작이 취소됨
Parameter
nametypedescription
infoObjectkey, oldValue, newValue를 포함한 오브젝트를 반환
Sample
// DataMap 예시 <w2:dataMap id="dma_dataMap1" baseNode="map" ev:onbeforemodelchange="scwin.dma_dataMap1_onbeforemodelchange"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> // DataMap과 ref로 연동된 input 예시 <xf:input id="input1" ref="data:dma_dataMap1.key1"></xf:input> // 이벤트 핸들러 함수 예시. input1의 값에 숫자나 영문자가 아닌 다른 값이 입력된 경우 input1을 이전 값으로 되돌림 scwin.dma_dataMap1_onbeforemodelchange = function(info) { if (info.newValue.match(/[^A-Za-z0-9]/g)) { return false; } else { return true; } };
onkeyset
set API를 호출하는 경우 매번 발생하는 이벤트 (관련 함수) set(KeyID , KeyValue); setEmptyValue();
Parameter
nametypedescription
infoJSON데이터 변화 정보를 담은 객체 <Number> info.key 데이터가 변한 키(Key) <Number> info.oldValue 변하기 전 값 <Number> info.newValue 변한 후 값
Sample
<w2:dataMap id="dma_dataMap1" ev:onkeyset="scwin.dma_dataMap1_onkeyset"> ... </w2:dataMap> scwin.dma_dataMap1_onkeyset = function(info) { var key = info.key; var oldValue = info.oldValue; var newValue = info.newValue; }
onmodelchange
특정 키(Key)에 대한 값(Value)이 변경된 이후에 발생
Parameter
nametypedescription
infoObject키(Key), 이전 값(oldValue), 변경된 값(newValue)을 포함한 객체를 반환
Sample
// DataMap 예시 <w2:dataMap id="dma_dataMap1" baseNode="map" ev:onmodelchange="scwin.dma_dataMap1_onmodelchange"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> // DataMap과 속성 ref로 연동된 input 예시 <xf:input adjustMaxLength="false" id="input1" style="width:249px;height:47px;" ref="data:dma_dataMap1.key1"></xf:input> // 이벤트 핸들러 함수 예시 (input1의 값이 변경될 때마다 scwin.dma_dataMap1_onmodelchange 함수가 실행됨) scwin.dma_dataMap1_onmodelchange = function(info) { console.log(JSON.stringify(info)); };
onsetdata
setJSON 또는 setXML 관련 API를 통해 데이터를 설정하거나, 서브미션의 Target(받아올 데이터)과 연동되어 통신의 결과가 설정될 때 발생하는 이벤트
컴포넌트와 바인딩(Binding) 되어있는 경우 컴포넌트에 값이 설정되기 전에 발생

Method Detail

bind( eventType , function )
DataMap의 이벤트를 동적으로 할당함
Parameter
nametyperequireddescription
eventTypeStringY동적으로 할당할 이벤트의 이름
functionFunctionY동적으로 할당할 이벤트의 핸들러 함수
Sample
//DataMap의 아이디가 dma_dataMap1인 경우 dma_dataMap1.bind("onsetdata", function(e){ alert("date setting");}); //이벤트 함수를 commObj.fn_dcDataSet으로 정의한 경우 dma_dataMap1.bind("onsetdata", commObj.fn_dcDataSet);
get( key )
KeyInfo에 정의되어있는 키(Key) 아이디에 할당된 값(Value)을 반환
값(Value)의 초기값은 ""(공백)
Parameter
nametyperequireddescription
keyStringY키(Key) 아이디
Return
typedescription
ObjectKey 아이디에 할당된 값(Value) (return type은 일반적으로 String이 대부분이며 초기 설정한 데이터의 type 형태로 반환됨)
getArray( )
DataMap 전체 데이터를 KeyInfo에 정의된 순서대로 배열에 담아 반환
Return
typedescription
ArrayDataMap 전체 데이터가 담긴 1차원 배열
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> <addr></addr> </w2:data> </w2:dataMap> var tmpArr = dma_dataMap1.getArray(); //반환 값 예시 ) ["웹스퀘어", ""]
getCount( )
DataMap에 정의된 키(Key)의 개수를 반환
Return
typedescription
NumberDataMap에 정의된 키(Key)의 개수
getID( )
DataMap 객체의 아이디를 반환하고 객체의 아이디 속성과 동일한 값을 반환함
Return
typedescription
StringDataMap 객체의 아이디
getIndex( keyID )
키(Key)의 아이디로 KeyInfo에 정의된 키(Key)의 인덱스를 반환함
Parameter
nametyperequireddescription
keyIDStringYKeyInfo에 정의된 아이디
Return
typedescription
NumberkeyID의 인덱스
getInfo( )
DataMap의 세부 정보를 조회
Return
typedescription
JSON{dataMapInfo : DataMap의 특성값, keyInfo : 각 키(Key)의 특성들을 모아둔 객체} 형태의 JSON 객체
Sample
dma_dataMap1.getInfo();
getJSON( )
DataMap 전체 데이터를 JSON으로 반환함
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> <addr></addr> </w2:data> </w2:dataMap> var tmpJSON = dma_dataMap1.getJSON(); //반환 값 예시 - String으로 변환시 ) {name: "웹스퀘어", addr: "" }
getKey( keyIndex )
키(Key)의 인덱스를 받아서 아이디명을 반환함
Parameter
nametyperequireddescription
keyIndexNumberYKeyInfo에 정의된 키(Key)의 인덱스
Return
typedescription
String키(Key)의 아이디
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> <addr></addr> </w2:data> </w2:dataMap> var tmpKeyNm = dma_dataMap1.getKey(0); //반환 값 예시 ) "name"
getKeyInfo( key )
DataMap의 특정 키(Key)의 세부 정보를 조회
Parameter
nametyperequireddescription
keyStringY조회하고자 하는 키(Key)
Return
typedescription
JSON해당 키(Key)의 속성을 표현한 JSON 객체
Sample
dma_dataMap1.getKeyInfo("key1");
getModifiedArray( )
DataMap의 최초 설정 값과 현재 데이터의 값이 다른 키(Key) 배열과 값(Value) 배열을 JSON으로 반환 (DataMap의 firstSet 속성과 연관) (참고 사항) 최초 설정 값: setJSON, setXML 등과 같은 API들을 통해 설정된 데이터
Return
typedescription
JSON최초 설정 값과 현재 데이터의 값이 다른 키(Key) 배열과 값(Value) 배열이 담긴 JSON
Sample
//name과 addr이 정의 되어있는 DataMap에서 name의 value를 "인스웨이브"로 수정한 경우 var modJsonArray = dma_dataMap1.getModifiedArray(); //반환 값 예시 - String으로 변환시 ) { key : ["name"] , value : ["인스웨이브"] }
getModifiedData( )
최초 설정 값과 현재 데이터의 값이 다른 키(Key) 배열과 값(Value) 배열을 반환 (DataMap의 firstSet 속성과 연관) (참고 사항) 최초 설정 값: setJSON, setXML 등과 같은 API들을 통해 설정된 데이터
Return
typedescription
Array최초 설정 값과 현재 데이터의 값이 다른 키(Key) 배열과 값(Value) 배열
Sample
//name과 addr이 정의되어 있는 DataMap에서 name의 value를 "인스웨이브"로 수정한 경우 var modArray = dma_dataMap1.getModifiedData(); //반환 값 예시 ) [ "인스웨이브" ]
getModifiedIndex( )
DataMap의 최초 설정 값과 현재 데이터의 값이 다른 키(Key)들의 인덱스를 배열로 반환 (DataMap의 firstSet 속성과 연관) (참고 사항) 최초 설정 값: setJSON, setXML 등과 같은 API들을 통해 설정된 데이터
Return
typedescription
Array최초 설정 값과 현재 데이터의 값이 다른 키(Key)들의 인덱스가 담긴 배열
Sample
//name과 addr이 정의되어 있는 DataMap에서 name의 value를 "인스웨이브"로 수정한 경우 var modArray = dma_dataMap1.getModifiedIndex(); //반환 값 예시 ) [0]
getModifiedJSON( )
최초 설정 값과 현재 데이터의 값이 다른 키(Key)들을 JSON으로 반환 (참고 사항) 최초 설정 값: setJSON, setXML 등과 같은 API들을 통해 설정된 데이터
Return
typedescription
JSON최초 설정 값과 현재 데이터의 값이 다른 키(Key)와 값(Value)가 담긴 JSON
Sample
//name과 addr이 정의 되어있는 DataMap에서 name의 value를 "인스웨이브"로 수정한 경우 var modJSON = dma_dataMap1.getModifiedJSON(); //반환 값 예시 - String으로 변환시 ) { name: "인스웨이브" }
getModifiedKey( )
최초 설정 값과 현재 데이터의 값이 다른 키(Key)들을 배열로 반환 (참고 사항) 최초 설정 값: setJSON, setXML 등과 같은 API들을 통해 설정된 데이터
Return
typedescription
Array최초 설정 값과 현재 데이터의 값이 다른 키(Key)가 담긴 배열
Sample
//name과 addr이 정의 되어있는 DataMap에서 name의 value를 "인스웨이브"로 수정한 경우 var modKeyArr = dma_dataMap1.getModifiedKey(); //반환 값 예시 ) ["name"]
getModifiedXML( )
최초 설정 값과 현재 데이터의 값이 다른 키(Key)들을 XML로 반환 (참고 사항) 최초 설정 값: setJSON, setXML 등과 같은 API들을 통해 설정된 데이터
Return
typedescription
XML최초 설정 값과 현재 데이터의 값이 다른 키(Key)와 값(Value)들이 담긴 XML
Sample
//name과 addr이 정의 되어있는 DataMap에서 name의 value를 "인스웨이브"로 수정한 경우 var modXML = dma_dataMap1.getModifiedXML(); //반환 값 예시 - String으로 변환시 ) <map> <name>인스웨이브</name> </map>
getName( keyID )
키(Key)의 아이디로 name에 정의된 값을 반환
Parameter
nametyperequireddescription
keyIDStringYname을 조회할 키(Key)의 아이디
Return
typedescription
StringKeyInfo에 정의된 키(Key)의 name
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> var keyName = dma_dataMap1.getName("name"); //반환 값 예시 ) "이름"
getObjectType( )
데이터컬렉션 형식 반환
Return
typedescription
String[dataMap, dataList, linkedDataList] 데이터컬렉션의 타입을 반환
Sample
var dataCollectionType = dma_dataMap1.getObjectType(); //dma_dataMap1의 형식인 dataMap를 반환 //반환 값 예시 ) "dataMap"
getOption( attr )
속성명으로 속성의 값을 반환
Parameter
nametyperequireddescription
attrStringY속성명
Return
typedescription
String속성의 값
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1" baseNode="map"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> var tmpAttr = dma_dataMap1.getOption("baseNode"); //반환 값 예시 ) "map"
getOriginal( KeyID )
키(Key) 아이디에 할당된 초기값을 반환
Parameter
nametyperequireddescription
KeyIDStringY키(Key) 아이디
Return
typedescription
ObjectKey 아이디에 할당한 초기값 (return type은 일반적으로 String이 대부분이며 초기 설정한 데이터의 type 형태로 반환됨)
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> </w2:data> </w2:dataMap> //name의 value set dma_dataMap1.set("name","inswave"); //name의 value get //var tmpData = dma_dataMap1.get("name"); //반환 값 예시 ) "inswave" //name의 초기값 get var tmpOrgData = dma_dataMap1.getOriginal("name"); //반환 값 예시 ) "웹스퀘어"
getRefComponent( )
dataMap과 ref로 연동된 component id 반환
Return
typedescription
Arrayid, originalID를 포함하는 오브젝트 배열을 반환합니다.
Sample
// dataMap과 ref로 연동된 component의 ID가 input1, input2인 경우 var refArray = dma_dataMap1.getRefComponent(); //return 예시 ) [ {"id": "input1", "originalID": "mf_input1"}, {"id": "input2", "originalID": "mf_input2"}]
getScope( )
컴포넌트가 scope=true인 WFrame의 자식 컴포넌트일 때 해당 부모 WFrame 객체를 반환하는 함수 scope=true인 WFrame의 자식 컴포넌트가 아닐 경우 null을 반환
Return
typedescription
ObjectWFrame 객체 또는 null
Sample
//wfm_wframe1이 있고 wfm_wframe1안에 wfm_wframe11이 있고 그 안에 dma_dataMap1이 있는 경우 dma_dataMap1.getScope(); // wfm_wframe11 객체를 반환
getScopeWindow( )
컴포넌트가 scope=true인 WFrame의 자식 컴포넌트일때 해당 부모 WFrame의 Scope객체를 반환 scope=true인 WFrame의 자식 컴포넌트가 아닐 경우 전역 Window 객체를 반환
Return
typedescription
ObjectWFrame 객체의 Scope 객체 또는 전역 Window 객체
Sample
//wfm_wframe1이 있고 wfm_wframe1안에 wfm_wframe11이 있고 그 안에 dma_dataMap1이 있는 경우 dma_dataMap1.getScopeWindow(); // wfm_wframe11 객체의 Scope 객체 반환
getType( KeyID )
KeyInfo에 정의된 키(Key)의 dataType 속성값을 반환
Parameter
nametyperequireddescription
KeyIDStringY키(Key)의 아이디
Return
typedescription
String키(Key)의 dataType 속성값
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> var keyType = dma_dataMap1.getType(); //반환 값 예시 ) "text"
getXML( )
DataMap의 전체 데이터를 XML 형태로 반환
Return
typedescription
XMLXML 타입의 전체 데이터
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> <w2:data use="true"> <name>웹스퀘어</name> <addr></addr> </w2:data> </w2:dataMap> var tmpXML = dma_dataMap1.getXML(); //반환 값 예시 ) //<map id="dma_dataMap1"> // <name>웹스퀘어</name> // <addr></addr> //</map>
initRowStatus( )
DataMap의 상태를 모두 '변경되지 않음' 상태로 설정
Sample
dma_dataMap1.initRowStatus(); // dma_dataMap1의 상태가 모두 '변경되지 않음' 상태로 설정됨 (이후 dma_dataMap1.getModifiedJSON() 호출시 빈 객체가 반환)
keepDataType( )
데이터를 세팅할 때나 뷰를 통해 데이터를 수정하는 경우, dataType이 number인 데이터에 한해 number로 타입캐스팅하도록 하는 기능
modifyKeyStatus( key , isModified )
키(Key)에 해당하는 상태값을 '변경됨' 또는 '변경되지 않음' 상태로 조작
Parameter
nametyperequireddescription
keyStringY상태를 변경할 키(Key)의 아이디
isModifiedBooleanY설정할 상태값 (true : 변경됨, false : 변경되지 않음)
Sample
dma_dataMap1.modifyKeyStatus("key1", false); // "key1"의 상태를 '변경되지 않음'으로 설정 (이후 dma_dataMap1.getModifiedJSON() 호출시 "key1"이 제외됨) dma_dataMap1.modifyKeyStatus("key1", true); // "key1"의 상태를 '변경됨'으로 설정 (이후 dma_dataMap1.getModifiedJSON() 호출시 "key1"이 포함됨)
preserveType( )
preserveType="true" 설정시 dataType이 number/text인 데이터에 한해 number/text로 타입캐스팅).
redo( )
restore()한 값을 다시 한 단계 되돌림 (관련 함수) restore();
Sample
dma_dataMap1.redo();
reform( )
최초 설정 값을 현재의 키(Key) 값으로 바꾸고, 키(Key)의 상태를 초기 상태인 '변경되지 않음' 으로 설정 (참고 사항) 최초 설정 값: setJSON, setXML 등과 같은 API들을 통해 설정된 데이터 키(Key)의 상태가 '변경되지 않음'일 경우 getModifiedJSON() API 호출 시 빈 값 반환 키(Key)의 상태가 '변경됨'일 경우 getModifiedJSON() API 호출 시 데이터 확인 가능
Sample
dma_dataMap1.reform();
restore( )
데이터를 변경 한 단계 전으로 되돌림 (한번 수행 시마다 한 단계씩 되돌아감)
Sample
dma_dataMap1.restore();
set( KeyID , KeyValue )
지정한 키(Key)에 값을 설정함
Parameter
nametyperequireddescription
KeyIDStringY키(Key)의 아이디
KeyValueStringY키(Key)에 할당할 값(Value)
Sample
//DataMap 예시 <w2:dataMap id="dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> dma_dataMap1.set("name","웹스퀘어");
setArray( arrayData )
DataMap의 전체 데이터를 설정
배열의 값은 DataMap에 정의된 키(Key)의 순서와 동일해야 함
Parameter
nametyperequireddescription
arrayDataArrayY에 정의된 키(Key)와 순서/개수가 동일하고, 설정할 값만 담긴 배열
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="version" name="버전" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> dma_dataMap1.setArray( ["웹스퀘어","5.0"] ); //정상 동작 dma_dataMap1.setArray( ["웹스퀘어"] ); //오류 발생
setEmptyValue( )
키(Key) 값을 확인하여 빈 값으로 설정함 (컬럼에 defaultValue 속성이 설정된 경우, defaultValue 값으로 설정됨) (참고 사항) 최초 설정 값과 현재 데이터 모두 빈 값으로 설정됨 최초 설정 값: setJSON, setXML 등과 같은 API들을 통해 설정된 데이터
Sample
dma_dataMap1.setEmptyValue();
setJSON( jsonData )
DataMap의 전체 데이터를 JSON으로 설정 (참고 사항) 전체 키(Key)가 있을 필요는 없으며 DataMap에 정의된 키(Key)만 설정됨
Parameter
nametyperequireddescription
jsonDataJSONYJSON 형태의 DataMap의 전체 데이터
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> var tmpData = { "name" : "웹스퀘어" }; dma_dataMap1.setJSON( tmpData );
setXML( xmlData )
DataMap의 전체 데이터를 XML로 설정 (참고 사항) 전체 키(Key)가 있을 필요는 없으며 DataMap에 정의된 키(Key)만 설정됨
Parameter
nametyperequireddescription
xmlDataXMLYXML 형태의 DataMap의 전체 데이터
Sample
//DataMap 예시 <w2:dataMap id="dma_dataMap1"> <w2:keyInfo> <w2:key id="name" name="이름" dataType="text"></w2:key> <w2:key id="addr" name="주소" dataType="text"></w2:key> </w2:keyInfo> </w2:dataMap> var tmpStr = "<map><name>웹스퀘어</name></map>"; //XML String var tmpXML = WebSquare.xml.parse(tmpStr); //XML 변환 dma_dataMap1.setXML( tmpXML );
trigger( eventType , paramArray )
DataMap에 등록된 특정 이벤트를 직접 발생시킴
Parameter
nametyperequireddescription
eventTypeStringY발생시킬 이벤트 이름
paramArrayArrayN이벤트 핸들러에 전달할 파라미터 배열
Sample
// dma_dataMap1에 onmodelchange 이벤트를 발생시키고 핸들러 함수에 {key: "name", oldValue: "WebSquare", newValue: "Inswave"} 인자를 전달하여 호출 dma_dataMap1.trigger( "onmodelchange" , [ {key: "name", oldValue: "WebSquare", newValue: "Inswave"} ] );
unbind( eventType , function )
정의된 이벤트를 제거
Parameter
nametyperequireddescription
eventTypeStringN제거할 이벤트의 이름 (생략할 경우 모든 이벤트를 제거)
functionFunctionN동적으로 이벤트에 함수를 할당한 경우 제거할 이벤트 핸들러 함수 (생략할 경우 해당 이벤트 형식으로 등록된 모든 핸들러 함수를 제거)
Sample
// dma_dataMap1에 등록된 onmodelchange 이벤트 제거 dma_dataMap1.unbind("onmodelchange"); // dma_dataMap1.bind("onmodelchange", fn_dataMapChage)와 같이 동적으로 이벤트와 이벤트 핸들러를 등록한 경우 아래와 같이 제거가 가능 (이벤트에 바인드된 이벤트 핸들러 제거) dma_dataMap1.unbind("onmodelchange", fn_dataMapChage); // dma_dataMap1에 등록된 onmodelchange 이벤트의 이벤트 핸들러 함수 중에 fn_dataMapChage를 제거
undo( )
키(Key)와 값(Value)을 최초 설정 값으로 변경 (참고 사항) 최초 설정 값: setJSON, setXML 등과 같은 API들을 통해 설정된 데이터