Type

uiplugin

Property Summary

id

컴포넌트 id

imageLoadURL

업로드된 이미지를 조회하는 URL(servlet), 조회하는 Servlet은 "fileName"을 parameter로 받아서 처리하도록 해야한다

language

언어셋을 설정한다

menubar

editor의 toolbar의 종류

subDir

subDir="test1"라고 하면, websquare

transParentDisabled

disabled시 색이 변하지 않습니다

version

ckeditor 버전 지정 옵션 (기본값 버전은 3

Event Summary

onchange

Editor에서 포커스가 빠져나가고 내용이 변경될 때 발생

onload

editor의 load가 끝난 경우에 발생

Method Summary

addClass( className )

컴포넌트에 class를 추가한다

bind( eventType , function )

컴포넌트의 이벤트를 동적으로 할당한다

changeClass( oldClassName , newClassName )

컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 변경한다.

getDisabled( )

현재 설정되어있는 disabled 속성값을 반환한다

getDomain( )

Editor에 세팅된 domain값을 가져옵니다

getGenerator( )

generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다

getHTML( )

editor의 textarea에서 html태그를 포함하여 모두 반환합니다

getID( )

웹스퀘어 컴포넌트의 id를 반환한다

getImageLoadURL( )

imageLoadURL을 얻어옵니다

getOpacity( )

CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다

getPluginName( )

웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다

getPosition( positionName )

컴포넌트의 left 또는 top의 위치 값을 반환한다

getReadOnly( )

현재 설정되어있는 readOnly 속성값을 반환한다

getSize( sizeName )

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

getStyle( propertyName )

컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다

getStyleValue( style )

[deprecated]getStyle로 사용.

getText( )

editor의 textarea에서 html태그를 무시하고 text만 반환합니다

getTitle( )

title 속성값을 반환한다

getUserData( key )

setUserData API로 설정 된 사용자 데이터 또는 소스(화면 XML)에 사용자가 임의의 property로 정의 된 값을 반환한다

hasClass( className )

컴포넌트가 parameter로 받은 className의 class를 가지고 있는지의 여부를 반환한다

hide( )

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

removeClass( className )

컴포넌트에 className의 class를 삭제한다.

resize( editor , editor )

editor의 resize를 적용합니다

setDisabled( disabled )

editor를 disabled 처리 한다

setDomain( domain )

CrossDomain 처리를 위해 Editor에 domain을 셋팅합니다

setEventPause( evList , flag )

컴포넌트의 이벤트를 disable 또는 enable시킨다

setHTML( html )

html을 editor에 textarea에 입력합니다

setImageLoadURL( imageLoadURL )

imageLoadURL을 셋팅합니다

setOpacity( value )

컴포넌트의 CSS Opacity(불투명도)값를 설정한다

setPosition( left , top , mode )

컴포넌트의 위치(left,top)를 설정한다

setReadOnly( readOnly )

editor를 readOnly 처리 한다

setSize( width , heigth )

컴포넌트의 크기(width,height)를 설정한다

setStyle( propertyName , value )

컴포넌트의 property별 style을 설정한다

setText( value )

value를 editor에 textarea에 입력합니다

setUserData( key , value )

컴포넌트에 사용자 데이터를 설정한다

show( displayType )

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

toggleClass( className )

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

trigger( type , array )

컴포넌트에 등록 된 특정 이벤트를 발생시킨다

unbind( type , function )

컴포넌트에 등록 된 이벤트를 제거한다

visible( flag )

[deprecated]show/hide 로 사용하거나 setStyle을 통해 visible 속성을 설정한다.

id

컴포넌트 id

imageLoadURL

업로드된 이미지를 조회하는 URL(servlet), 조회하는 Servlet은 "fileName"을 parameter로 받아서 처리하도록 해야한다.

language

언어셋을 설정한다. en: 영문, ko : 국문

menubar

editor의 toolbar의 종류

subDir

subDir="test1"라고 하면, websquare.xml(//upload/imgUpload/test1/@value)에 정의되어 있는 경로 업로드 한다.

transParentDisabled

disabled시 색이 변하지 않습니다.

version

ckeditor 버전 지정 옵션 (기본값 버전은 3.6.6.1)

onchange

Editor에서 포커스가 빠져나가고 내용이 변경될 때 발생.

onload

editor의 load가 끝난 경우에 발생

addClass( className )

컴포넌트에 class를 추가한다.

Parameter

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

Sample

//input1 컴포넌트에 oddClass 라는 class를 추가 할 때 input1.addClass("oddClass");

bind( eventType , function )

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

Parameter

name	type	required	description
eventType	String	Y	할당 할 이벤트명.
function	Function	Y	동적으로 할당 할 이벤트의 핸들러 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

name	type	required	description
oldClassName	String	Y	삭제 할 class의 이름
newClassName	String	Y	추가 할 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");

getDisabled( )

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

Return

type	description
Boolean	disabled 속성값

Sample

var returnValue = componentId.getDisabled(); return 예시 ) false

getDomain( )

Editor에 세팅된 domain값을 가져옵니다.

Return

type	description
String:Y	editor에 설정된 domain값.

getGenerator( )

generator 하위의 컴포넌트에서 이 함수를 호출하여 자신을 생성한 부모 generator 객체를 가져온다.

Return

type	description
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 참조

getHTML( )

editor의 textarea에서 html태그를 포함하여 모두 반환합니다.

Return

type	description
String:Y	textarea에 입력된 html소스

Sample

var returnValue = editor1.getHTML(); returnValue는 입력된 문자열의 html 소스이다. 예) <strong><span style="color:#ff0000;">editor API<br /> 1. getHTML()<br /> 2. getText()</span></strong>

getID( )

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

Return

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

Sample

//동적으로 웹스퀘어 컴포넌트를 파라메터로 받았을 경우 아래와 같이 사용 할 수 있다. function fn_validCheck(tmpObj){ //tmpObj가 input1 이라는 ID를 가지고 있는 경우 var compID = tmpObj.getID(); //return 예시 ) "input1" }

getImageLoadURL( )

imageLoadURL을 얻어옵니다.

Return

type	description
String:Y	editor에 설정된 imageLoadURL

getOpacity( )

CSS로 정의 된 컴포넌트의 Opacity(불투명도) 값을 반환한다.

Return

type	description
Integer	Opacity 값

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"

getPluginName( )

웹스퀘어 컴포넌트의 pluginName(컴포넌트명)을 반환한다.

Return

type	description
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

name	type	required	description
positionName	String	Y	[left,top]위치 종류

Return

type	description
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

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

Sample

var returnValue = componentId.getReadOnly(); //return 예시 ) false

getSize( sizeName )

컴포넌트의 크기 값을 반환합니다.%로 설정된 경우, 픽셀로 변환하여 반환한다.

Parameter

name	type	required	description
sizeName	String	Y	[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

type	description
Number	컴포넌트의 크기 값

Sample

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

getStyle( propertyName )

컴포넌트에 적용 된 CSS의 propertyName에 해당하는 값을 반환한다.

Parameter

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

Return

type	description
String	style의 속성값

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

name	type	required	description
style	String	Y	정의 된 style에서 사용자가 반환 받고자하는 속성명.

Return

type	description
String	style 속성에 정의 된 값(색을 반환하는 경우에는 색HexCode로 반환)

getText( )

editor의 textarea에서 html태그를 무시하고 text만 반환합니다.

Return

type	description
String:Y	textarea의 text부분

Sample

var returnValue = editor1.getText(); returnValue는 에디터에 입력된 문자열이다.

getTitle( )

title 속성값을 반환한다.

Return

type	description
String	title 속성값.

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

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

Return

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

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

name	type	required	description
className	String	Y	검색 할 className

Return

type	description
Boolean	class를 가지고 있는지의 여부

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

removeClass( className )

컴포넌트에 className의 class를 삭제한다.
기본 설정은 addClass API를 통해 추가 된 class만 적용되며 컴포넌트의 class 속성에 직접 정의 된 class를 삭제해야하는 경우는 config.xml파일의 설정을 아래와 같이 적용해야한다.
<style><removeDefaultClass value="true" /></style>

Parameter

name	type	required	description
className	String	Y	삭제 할 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");

resize( editor , editor )

editor의 resize를 적용합니다.

Parameter

name	type	required	description
editor	Number	Y	width 값
editor	Number	Y	height 값

setDisabled( disabled )

editor를 disabled 처리 한다.

Parameter

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

setDomain( domain )

CrossDomain 처리를 위해 Editor에 domain을 셋팅합니다.

Parameter

name	type	required	description
domain	String	N	domain 값이 없으면 WebSquare.util.setDomain으로 셋팅된 domain이 셋팅됩니다.

setEventPause( evList , flag )

컴포넌트의 이벤트를 disable 또는 enable시킨다.

Parameter

name	type	required	description
evList	String	N	대상 이벤트 목록. 해당 인자가 주어지지 않을 경우 해당 컴포넌트의 모든 사용자 이벤트가 대상이 된다. (null을 지정하면 된다.)
flag	Boolean	Y	true인 경우 pause시키며, false인 경우 pause를 해제한다.

Sample

input1.setEventPause("onclick", true); //onclick이벤트를 동적으로 pause 한다. input1.setEventPause("onfocus,onblur", false); //onfocus이벤트와 onblur이벤트의 pause를 해제한다. input1.setEventPause(null, true); //input에 등록된 모든 사용자 이벤트를 pause 한다.

setHTML( html )

html을 editor에 textarea에 입력합니다.(html태그를 해석하여 입력합니다.)

Parameter

name	type	required	description
html	String	Y	editor에 입력하려는 html소스

Sample

editor1.setHTML('<em><span style="font-size:14px;">editor setHTML(html) API.</span></em>'); 폰트크기가 14px이고 이탤릭체로 "editor setHTML(html) API" 문자열이 표시된다.

setImageLoadURL( imageLoadURL )

imageLoadURL을 셋팅합니다.

Parameter

name	type	required	description
imageLoadURL	String	N	imageLoadURL

setOpacity( value )

컴포넌트의 CSS Opacity(불투명도)값를 설정한다.

Parameter

name	type	required	description
value	Number	Y	Opacity 값 (0과 1사이의 실수)

Sample

componentId.setOpacity(0.45);

setPosition( left , top , mode )

컴포넌트의 위치(left,top)를 설정한다.

Parameter

name	type	required	description
left	Number	Y	left의 값 또는 null.
top	Number	Y	top의 값 또는 null.
mode	String	N	[defulat:absolute, delta]absolute이면 x,y로 현재 값을 설정하고 delta이면 현재 값에 x,y값만큼을 더해서 설정.

Sample

//컴포넌트의 top만 100px로 설정. componentId.setPosition(null, 100);

setReadOnly( readOnly )

editor를 readOnly 처리 한다.

Parameter

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

setSize( width , heigth )

컴포넌트의 크기(width,height)를 설정한다.

Parameter

name	type	required	description
width	Number	Y	새로 설정할 컴포넌트의 width값 또는 null
heigth	Number	Y	새로 설정할 컴포넌트의 height값 또는 null

Sample

//컴포넌트의 height만 100px로 설정. componentId.setSize(null,100);

setStyle( propertyName , value )

컴포넌트의 property별 style을 설정한다.

Parameter

name	type	required	description
propertyName	String	Y	style 속성 이름
value	String	Y	적용 할 style의 값

Sample

//컴포넌트의 width를 200px로 설정 할 경우 componentId.setStyle("width", "200px"); //배경색을 olive로 변경 할 경우 componentId.setStyle("background-color","olive");

setText( value )

value를 editor에 textarea에 입력합니다.(html태그를 text로 입력합니다.)

Parameter

name	type	required	description
value	String	Y	editor에 입력하려는 값

Sample

editor1.setText("editor\n setText(value) API."); editor setText(value) API. 위와 같이 에디터에 표시된다.

setUserData( key , value )

컴포넌트에 사용자 데이터를 설정한다. 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하며 log에 관련 내용이 출력 된다.

Parameter

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

Sample

//컴포넌트에 'data'라는 key로 'WebSquare'라는 값을 설정 할 경우 componentId.setUserData("data", "WebSquare"); //아래와 같이 컴포넌트에 설정이 가능한 key가 아닌 경우, key 설정이 불가능하다. componentId.setUserData("title", "WebSquare"); //log 표현 예시 ) !!!WARNING - [title] can't define as UserData

show( displayType )

컴포넌트를 화면에 보이도록 설정한다.
엔진 내부적으로는 CSS를 display속성과 visibility:show;으로 처리한다.

Parameter

name	type	required	description
displayType	String	N	[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

name	type	required	description
className	String	Y	설정 할 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

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

Sample

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

unbind( type , function )

컴포넌트에 등록 된 이벤트를 제거한다.

Parameter

name	type	required	description
type	String	N	제거할 이벤트 이름. 생략할 경우 해당 컴포넌트의 모든 이벤트를 제거한다.
function	Function	N	제거할 이벤트의 핸들러 함수. 생략할 경우 해당 이벤트 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

name	type	required	description
flag	Boolean	Y	visibility 값을 설정할 값(true이면 "visible", false이면 "hidden"을 설정)