위젯 API 가이드
이 문서는 위젯/가젯 상의 gadgets로 시작하는 javascript API 사용에 대한 참조자료입니다.
-
- 1. MiniMessage
-
MiniMessage 클래스는 미니메시지를 생성할 때 사용되고 다음과 같이 사용됩니다.
- 프로모션 : 위젯/가젯 안에 프로모션 메시지를 표시
- 상태 : 많은 위젯/가젯들은 백단에서 데이터를 불러와야 하는 경우 "로딩 중 .. "과 같은 상태 표시에 사용
- 디버그/에러 : 위젯/가젯이 에러를 발생시킬 때 아무 반응 없이 있지 않고 사용자에게 에러 상태를 표시
-
- 1.1 생성자
-
gadgets.MiniMessage
-
gadgets.MiniMessage(opt_moduleId, opt_container)
- 미니메시지를 생성합니다.
-
파라미터
- String opt_moduleId : 미니메시지의 id로 지정할 값
- HTMLElement opt_container : 미니메시지가 나타날 요소
-
- 1.2 메소드
-
createDismissibleMessage
-
HTMLElement createDismissibleMessage(message, opt_callback)
- [x] 버튼이 있는 사용자가 사라지게 할수 있는 메시지를 생성합니다.
-
파라미터
- String, Object message : 메시지로 사용할 문자열이나 DOM 요소
- Function opt_callback : 메시지가 사라질때 불려지는 함수
-
리턴값
- HTMLElement : 메시지가 담긴 HTML 요소
-
createStaticMessage
-
HTMLElement createStaticMessage(message)
- 사용자가 지우지 못하고, 프로그램적으로만 사라지게 할수 있는 메시지를 생성합니다.
-
파라미터
- String, Object message : 메시지로 사용할 문자열이나 DOM 요소
-
리턴값
- HTMLElement : 메시지가 담긴 HTML 요소
-
createTimerMessage
-
HTMLElement createTimerMessage(message, seconds, opt_callback)
- 일정시간이 지나면 자동으로 사라지는 메시지를 생성합니다.
-
파라미터
- String, Object message : 메시지로 사용할 문자열이나 DOM 요소
- number seconds : 메시지가 사라질 시간(초 단위)
- Function opt_callback : 메시지가 사라질때 불려지는 함수
-
리턴값
- HTMLElement : 메시지가 담긴 HTML 요소
-
dismissMessage
-
dismissMessage(message)
- 메시지를 사라지게 합니다. 정적 메시지를 안보이게 할 때 사용합니다.
-
파라미터
- HTMLElement message : 사라지게 할 메시지 요소
-
- 2. Prefs
-
사용자 설정이나 메시지를 접근할 수 있도록 해줍니다.
-
var prefs = new gadgets.Prefs();
var name = prefs.getString("name");
var lang = prefs.getLang();
-
- 2.1 생성자
-
Prefs
-
gadgets.Prefs(opt_moduleId)
- Prefs 객체를 생성합니다.
-
파라미터
- String, Number opt_moduleId : 객체의 고유 ID로 사용할 값
-
- 2.2 메소드
-
getArray
-
Array. getArray(key)
- 배열 형태의 값을 받아옴니다. 사용자 설정 중 List 형태에 사용할 수 있습니다.
-
파라미터
- String key : 배열을 받아올 객체의 키값
-
리턴값
- Array. : 받아 온 배열, javascript에서 배열형태로 사용 가능
-
getBool
-
Boolean getBool(key)
- Bool 형태의 값을 받아옴니다. 사용자 설정 중 bool 형태에 사용할 수 있습니다.
-
파라미터
- String key : Bool 값을 받아올 객체의 키값
-
리턴값
- Boolean : 받아 온 Bool 값. 값이 없을 경우 fals 리턴
-
getFloat
-
Number getFloat(key)
- 실수 형태의 값을 받아옴니다.
-
파라미터
- String key : 실수 값을 받아올 객체의 키값
-
리턴값
- Number : 받아 온 실수 값. 값이 없을 경우 0 리턴
-
getInt
-
Number getInt(key)
- 정수 형태의 값을 받아옴니다.
-
파라미터
- String key : 정수 값을 받아올 객체의 키값
-
리턴값
- Number : 받아 온 정수 값. 받아 온 값이 실수일 경우 소숫점 이하 자리는 버리고, 값이 없을 경우는 0 리턴
-
getString
-
String getString(key)
- 문자열 형태의 값을 받아옴니다.
-
파라미터
- String key : 문자열을 값을 받아올 객체의 키값
-
리턴값
- String : 받아 온 문자열. 값이 없을 경우 빈 문자열 리턴
-
- 3. Tab
-
TabSet의 addTab()메소드로 생성한 개별 탭을 핸들링하는데 사용합니다. TabSet객체의 getSelectedTab()이나 getTabs() 함수로 Tab객체를 리턴받을 수 있습니다.
-
- 3.1 메소드
-
getCallback
-
Function getCallback()
- 해당 탭이 선택될 때 실행되는 콜백함수를 리턴합니다.
-
리턴값
-
getContentContainer
-
HTMLElement getContentContainer()
- 해당 탭의 내용 부분 HTML 요소를 반환합니다.
-
리턴값
- HTMLElement : 컨테이너 HTML 요소
-
getIndex
-
Number getIndex()
- 해당 탭의 index 번호를 반환합니다.
-
리턴값
-
getName
-
String getName()
- 해당 탭의 이름을 반환합니다.
-
리턴값
-
getNameContainer
-
HTMLElement getNameContainer()
- 해당 탭 영역의 HTML 요소를 반환합니다.
-
리턴값
- HTMLElement : 탭의 HTML 요소(보통 <td>)
-
- 4. TabSet
-
탭을 생성하는데 사용됩니다.
-
- 4.1 생성자
-
TabSet
-
gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)
- 탭을 생성합니다.
-
파라미터
- String opt_moduleId : 탭에 사용될 고유 ID
- String opt_defaultTab : 탭셋 생성시 기본적으로 생성할 탭
- HTMLElement opt_container : 탭의 내용에 사용될 내용이 있는 HTML 요소
-
- 4.2 메소드
-
addTab
-
String addTab(tabName, opt_params)
- 탭셋에 탭을 추가합니다.
-
파라미터
- String tabName : 탭에 표시될 탭 이름
- Object opt_params : 추가적인 옵션 파라미터
- opt_params[contentContainer] : 탭의 내용에 사용될 내용이 있는 HTML 요소
- opt_params[callback] : 탭이 선택될 때 실행될 콜백 함수
- opt_params[tooltip] : 탭 위에 마우스 커서가 올라갔을 때 표시될 툴팁
- opt_params[index] : 탭이 삽입될 위치. 0이 가장 앞이고, 생략할 경우 가장 뒤에 삽입
-
리턴값
-
alignTabs
-
alignTabs(align, opt_offset)
- 탭의 정렬 방향을 정의합니다.
-
파라미터
- String align : 탭의 정렬방향. left, center, right로 지정할 수 있으며, 기본은 가운데 정렬
- Number opt_offset : 정렬방향으로 부터 간격을 둘 거리(픽셀단위)
-
displayTabs
-
displayTabs(display)
- 기본적으로 탭 생성시 탭은 노출이 되지만 탭을 숨길 수도 있습니다.
-
파라미터
- Boolean display : 탭의 노출여부. true이면 노출, false이면 숨김
-
getHeaderContainer
-
HTMLElement getHeaderContainer()
- 탭셋의 탭부분에 해당하는 HTML 요소를 반환합니다.
-
리턴값
- HTMLElement : 탭의 헤더 HTML 요소
-
getSelectedTab
-
gadgets.Tab getSelectedTab()
- 선택되어 있는 탭 객체를 반환합니다. 반환된 객체로 위(3. Tab)의 API를 사용할 수 있습니다.
-
리턴값
-
getTabs
-
Array. getTabs()
- 탭셋에 포함되어 있는 탭을 배열형태로 반환합니다.
-
리턴값
-
removeTab
-
removeTab(tabIndex)
- 탭의 index번호를 사용하여 특정 탭을 지울 수도 있습니다.
-
파라미터
- Number tabIndex : 지울 탭의 index 번호
-
setSelectedTab
-
setSelectedTab(tabIndex)
- 탭을 클릭하지 않고 이 함수를 호출하여 특정 탭을 선택상태로 변경할 수 있습니다.
-
파라미터
- Number tabIndex : 선택상태로 변경할 탭의 index 번호
-
swapTabs
-
swapTabs(tabIndex1, tabIndex2)
- 두 탭의 순서를 서로 바꿉니다.
-
파라미터
- Number tabIndex1 : 순서를 바꿀 탭의 index 번호
- Number tabIndex2 : 순서를 바꿀 탭의 index 번호
-
- 5. flash
-
위젯/가젯에 플래시를 삽이할 때 사용합니다.
-
- 5.1 메소드
-
embedFlash
-
<static> Boolean embedFlash(swfUrl, swfContainer, swfVersion, opt_params)
- DOM 트리에 플래시 파일을 삽입합니다.
-
파라미터
- String swfUrl : swf URL
- String, Object swfContainer : 플래시가 위치할 HTML 컨테이너
- Number swfVersion : 최소한으로 요구되는 플래시 플레이어의 버전
- Object opt_params : 플래시 파일을 삽입하기 위한 옵션 파라미터. 속성들은 플래시 무비 삽입시 입력하는 속성과 동일
-
리턴값
- Boolean : 성공적으로 삽입된 경우 true를 반환합니다.
-
getMajorVersion
-
<static> Number getMajorVersion()
- 설치되있는 플래시 플레이어 버전을 반환합니다.
-
리턴값
- Number : 플래시 플레이어 버전. 설치되어 있지 않은 경우 0
-
- 6. window
-
위젯/가젯에 플래시를 삽이할 때 사용합니다.
-
- 6.1 메소드
-
adjustHeight
-
<static> adjustHeight(opt_height)
- 위젯/가젯의 높이를 조절합니다.
-
파라미터
- Number opt_height : 조절될 위젯의 높이. 빈값이 들어갈경우 위젯 크기에 맞게 자동으로 조절됩니다.
-
getViewportDimensions
-
<static> Object getViewportDimensions()
- 현재 보여지고 있는 위젯의 크기를 반환합니다.
-
리턴값
- Object : 위젯의 크기 (Object['height'] - 높이, Object['width'] - 너비)
-
- 7. util
-
유용한 기능 몇 가지를 제공합니다.
-
- 7.1 메소드
-
escapeString
-
<static> String escapeString(str)
- HTML 문자를 이스케이프 시켜줍니다.
-
파라미터
-
리턴값
-
이스케이프 문자
- 새 줄 (\n, 유니코드 코드 포인트 10)
- 캐리지 리턴 (\r, 유니코드 13)
- 큰따옴표 (", 유니코드 34)
- 앰퍼샌드 (&, 유니코드 38)
- 작은따옴표 (', 유니코드 39)
- 가랑이표 (<, 유니코드 60)
- 거꿀가랑이표 (>, 유니코드 62)
- 역슬래시 (\, 유니코드 92)
- 줄 바꿈 (유니코드 8232)
- 단락 바꿈(유니코드 8233)
-
hasFeature
-
<static> Boolean hasFeature(feature)
- 해당 기능을 사용할 수 있는지 확인합니다.
-
파라미터
- String feature : 사용할 수 있는지 확인할 기능
-
리턴값
- Boolean : 기능이 포함되어 있으면 true, 없으면 false
-
registerOnLoadHandler
-
<static> registerOnLoadHandler(callback)
- 위젯/가젯이 로드될 때 실행되야하는 함수를 호출합니다.
-
파라미터
- Function callback : 실행될 함수
-
unescapeString
-
<static> String unescapeString(str)
- 이스케이프 된 문자를 원래 문자로 되돌립니다.
-
파라미터
-
리턴값
Google 가젯 API
