WebSquare.uiplugin.submit

submit 컴포넌트를 생성하고 옵션을 통해서 다양한 기능을 지원합니다.

Type

uiplugin

Property Summary

alt: trigger의 alt 속성
centerOffImageClass: 트리거 마우스아웃시 중앙 이미지 클래스
centerOffImageClass: 트리거 마우스아웃시 중앙 이미지 클래스
centerOnImageClass: 트리거 마우스오버시 중앙 이미지 클래스
centerOnImageClass: 트리거 마우스오버시 중앙 이미지 클래스
class: submit의 class 속성
class: trigger의 class 속성
disabled: disabled 유무
disabled: disabled 유무
id: submit 컴포넌트의 id
id: trigger 컴포넌트의 id
leftOffImageClass: 트리거 마우스아웃시 왼쪽 이미지 클래스
leftOffImageClass: 트리거 마우스아웃시 왼쪽 이미지 클래스
leftOnImageClass: 트리거 마우스오버시 왼쪽 이미지 클래스
leftOnImageClass: 트리거 마우스오버시 왼쪽 이미지 클래스
localeRef: 다국어 옵션 사용시 refrence 키 값
rightOffImageClass: 트리거 마우스아웃시 오른쪽 이미지 클래스
rightOffImageClass: 트리거 마우스아웃시 오른쪽 이미지 클래스
rightOnImageClass: 트리거 마우스오버시 오른쪽 이미지 클래스
rightOnImageClass: 트리거 마우스오버시 오른쪽 이미지 클래스
submission: submission ID
submitType: 서브미션 전송 타입
syncMsg: 동기방식 전송시 메세지
tabIndex: submit의 tabIndex 속성
tabIndex: trigger의 tabIndex 속성
toolTip: toolTip 속성
toolTip: toolTip 속성
type: submit 컴포넌트 타입
type: 트리거 출력 타입

Event Summary

Method Summary

addClass( className ): 컴포넌트에 className의 이름을 가진 class를 추가합니다
bind( type , function ): 컴포넌트의 이벤트를 동적으로 할당합니다
changeClass( oldClassName , newClassName ): 컴포넌트에서 oldClassName의 이름을 가진 class를 newClassName으로 치환합니다
focus( ): 객체에 focus를 줍니다
getBackgroundImage( ): 컴포넌트의 Type이 "button" 인 경우 BackgroundImage 속성을 반환합니다
getDisabled( ): 현재 설정되어있는 disabled 속성을 반환합니다
getGeneratedComponent( id ): 동일한 index에 속한 다른 컴퍼넌트 객체를 가져옵니다
getGeneratedIndex( ): generator 반복부에서 해당 index를 반환합니다
getID( ): 웹스퀘어 컴포넌트의 id를 반환합니다
getLabel( ): 현재 버튼에 표시되어 있는 레이블을 반환합니다
getOpacity( ): 컴포넌트의 Opacity 값을 반환합니다
getPluginName( ): 웹스퀘어 컴포넌트의 pluginName을 반환합니다
getPosition( positionName ): 컴포넌트의 위치 값을 반환합니다
getReadOnly( ): 현재 설정되어있는 readOnly 속성을 반환합니다
getSize( sizeName ): 컴포넌트의 크기 값을 반환합니다
getStyle( propertyName ): 컴포넌트의 propertyName에 해당하는 style의 값을 반환합니다
getStyleValue( style ): 컴포넌트의 style중에서 입력받은 style의 값을 반환합니다
getSubmission( ): submit 컴포넌트의 submission 속성으로 지정된 submission의 실제 객체를 반환한다.
getTitle( ): component의 title 속성을 가져온다
getType( ): 컴포넌트의 현재 설정된 Type을 반환합니다
getUserData( key ): 설정된 사용자 임의의 데이터를 반환 합니다.
getValue( ): 현재 버튼에 표시되어 있는 레이블을 반환합니다
hasClass( className ): 컴포넌트가 className의 이름을 가진 class를 가지고 있는지 여부를 반환합니다
hide( ): 컴포넌트를 화면에서 보이지 않도록 숨깁니다
removeClass( className ): 컴포넌트에 className의 이름을 가진 class를 삭제합니다
setBackgroundImage( imgUrl ): 컴포넌트의 Type이 "button" 인 경우 BackgroundImage를 설정합니다
setDisabled( disabled ): 객체의 disabled 속성을 제어합니다
setLabel( lable ): 버튼에 표시될 레이블을 설정합니다
setOpacity( value ): 컴포넌트의 Opacity 값을 설정합니다
setPosition( left , top , mode ): 컴포넌트의 위치를 설정합니다
setReadOnly( readOnly ): 객체의 readOnly 속성을 제어합니다
setSize( width , heigth ): 컴포넌트의 크기를 설정합니다
setStyle( propertyName , value ): 컴포넌트의 propertyName에 해당하는 style의 값을 설정합니다
setSubmission( submission ): submit 컴포넌트의 submission을 설정한다.
setUserData( key , value ): 사용자 임의의 데이터를 객체에 설정합니다
setValue( lable ): 버튼에 표시될 레이블을 설정합니다
show( displayType ): 컴포넌트를 화면에 보이도록 설정합니다
toggleClass( className ): 컴포넌트가 className의 이름을 가진 class를 가지고 있다면 제거하고, 가지고 있지 않다면 추가한다
trigger( type , array ): 컴포넌트에 등록된 특정 이벤트를 직접 발생시킵니다
unbind( type , function ): 컴포넌트의 이벤트를 동적으로 제거합니다
visible( flag ): 컴포넌트의 style 중 visibility 값을 설정합니다

Property Detail

alt: trigger의 alt 속성
centerOffImageClass: 트리거 마우스아웃시 중앙 이미지 클래스
centerOffImageClass: 트리거 마우스아웃시 중앙 이미지 클래스
centerOnImageClass: 트리거 마우스오버시 중앙 이미지 클래스
centerOnImageClass: 트리거 마우스오버시 중앙 이미지 클래스
class: submit의 class 속성
class: trigger의 class 속성
disabled: disabled 유무
disabled: disabled 유무
id: submit 컴포넌트의 id
id: trigger 컴포넌트의 id
leftOffImageClass: 트리거 마우스아웃시 왼쪽 이미지 클래스
leftOffImageClass: 트리거 마우스아웃시 왼쪽 이미지 클래스
leftOnImageClass: 트리거 마우스오버시 왼쪽 이미지 클래스
leftOnImageClass: 트리거 마우스오버시 왼쪽 이미지 클래스
localeRef: 다국어 옵션 사용시 refrence 키 값
rightOffImageClass: 트리거 마우스아웃시 오른쪽 이미지 클래스
rightOffImageClass: 트리거 마우스아웃시 오른쪽 이미지 클래스
rightOnImageClass: 트리거 마우스오버시 오른쪽 이미지 클래스
rightOnImageClass: 트리거 마우스오버시 오른쪽 이미지 클래스
submission: submission ID
submitType: 서브미션 전송 타입
syncMsg: 동기방식 전송시 메세지
tabIndex: submit의 tabIndex 속성
tabIndex: trigger의 tabIndex 속성
toolTip: toolTip 속성
toolTip: toolTip 속성
type: submit 컴포넌트 타입
type: 트리거 출력 타입

Event Detail

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를 줍니다.

getBackgroundImage( )

컴포넌트의 Type이 "button" 인 경우 BackgroundImage 속성을 반환합니다. 반환되는 값은 url()로 감싸진 String 형태입니다.

Return
type	description
String	현재 설정되어있는 backgroundImage 속성값

Sample

var returnValue = trigger1.getBackgroundImage(); returnValue는 url(/images/btn_atcmp_down_on.gif)이다.

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

현재 버튼에 표시되어 있는 레이블을 반환합니다.

Return
type	description
String	label값

Sample

trigger의 표시되는 텍스트가 '보기'인 경우, var returnValue = trigger1.getLabel(); returnValue는 '보기'이다.

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

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

getSubmission( )

submit 컴포넌트의 submission 속성으로 지정된 submission의 실제 객체를 반환한다.
예를 들어 xml파일 model부분에 submission1이라는 ID의 submission객체가 존재하고,
submit 객체의 submission 속성값으로 submission1이라는 값이 set되어 있으면, getSubmission()
method의 반환값은 아이디가 submission1인 submission 태그를 파싱하여 만든 내부 객체가 된다.

Return
type	description
Object	submit 컴포넌트의 submission객체

getTitle( )

component의 title 속성을 가져온다.

Return
type	description
String	component의 title 속성값.

Sample

var title = componentId.getTitle();

getType( )

컴포넌트의 현재 설정된 Type을 반환합니다.

Return
type	description
String	현재 설정되어 있는 type 속성값

Sample

trigger의 속성 type이 button인 경우, trigger1.getType()은 button이다. image인 경우, trigger1.getType()은 image이다.

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

getValue( )

현재 버튼에 표시되어 있는 레이블을 반환합니다. getLabel과 같은 동작을 합니다.

Return
type	description
String	label값

Sample

trigger의 표시되는 텍스트가 '보기'인 경우, var returnValue = trigger1.getValue(); returnValue는 '보기'이다.

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

removeClass( className )

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

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

Sample

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

setBackgroundImage( imgUrl )

컴포넌트의 Type이 "button" 인 경우 BackgroundImage를 설정합니다.

Parameter
name	type	required	description
imgUrl	String	Y	BackgroundImage의 URL

Sample

trigger1.setBackgroundImage('/images/btn_atcmp_down_on.gif');

setDisabled( disabled )

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

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

Sample

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

setLabel( lable )

버튼에 표시될 레이블을 설정합니다.

Parameter
name	type	required	description
lable	String	Y	설정하려는 label 값

Sample

trigger1.setLabel('display'); trigger의 표시되는 텍스트는 display이다.

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

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

setSubmission( submission )

submit 컴포넌트의 submission을 설정한다.
submission의 id를 인자로 넘겨주면, 파싱한 모델 내에서 ID에 맞는 submission 객체를 찾아서 submit 내부에 set하여 준다

Parameter
name	type	required	description
submission	String	Y	submit 객체의 submission의 id

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

버튼에 표시될 레이블을 설정합니다. setLabel과 같은 동작을 합니다.

Parameter
name	type	required	description
lable	String	Y	설정하려는 label 값

Sample

trigger1.setValue('display'); trigger의 표시되는 텍스트는 display이다.

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"을 설정)