Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel2

...

이벤트 종류

이벤트 이름버전설명

initialized

Status
title릴리즈 2.1.0 이상

에디터가 초기화되었을 때 발생합니다

beforeUploadImage

Status
title릴리즈 2.2.0 이상

이미지를 업로드 하기 전에 발생합니다
afterUploadImage

Status
title릴리즈 2.2.0 이상

이미지를
이미지 업로드
가 완료된 후 발생합니다
beforeUploadVideo

Status
title릴리즈 2.2.0 이상

비디오를 업로드 하기 전에 발생합니다
afterUploadVideo

Status
title릴리즈 2.2.0 이상

비디오를 업로드 한
비디오 업로드가 완료된 후 발생합니다
beforeUploadFile

Status
title릴리즈 2.2.0 이상

파일을 업로드 하기 전에 발생합니다
afterUploadFile

Status
title릴리즈 2.2.0 이상

파일을 업로드 한 후 발생합니다
파일 업로드가 완료된 후 발생합니다
beforeOpenDocument

Status
title릴리즈 2.3.0 이상

문서를 열기 전(임포트 전) 발생합니다
afterOpenDocument

Status
title릴리즈 2.3.0 이상

문서가 열린 후(임포트 이후) 발생합니다.
beforeNewDocument

Status
title릴리즈 2.4.1 이상

새문서를 하기 전 발생합니다.
afterNewDocument

Status
title릴리즈 2.4.1 이상

새문서를 한 이후 발생합니다.
onSelection

Status
title릴리즈 2.6.0 이상

캐럿 이동 및 셀렉션 확장 등의 셀렉션 동작을 할 때 발생합니다. 
beforeCopy

Status
colourGrey
title릴리즈 2.11.0 이상

에디터편집영역에서복사를했을복사하기전에발생합니다. 이벤트를통해복사된 HTML내용을확인하거나, 복사될 HTML설정할있습니다.

beforePaste

Status
colourGrey
title릴리즈 2.10.0 이상

붙여넣기 전에 발생합니다.
afterPaste

Status
colourGrey
title릴리즈 2.10.0 이상

붙여넣기 후 발생합니다.
afterEdit

Status
colourGrey
title릴리즈 2.10.0 이상

문서를 편집한 이후 발생합니다.


이벤트 등록 

API 사용

editor.setEventListener()

이벤트를 등록 할 때 사용하는 API입니다. 

Code Block
languagejs
editor.setEventListener('이벤트이름', function(evente) {
});


에디터 초기화시 등록

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
    '이벤트이름': function (e) {
    }
};

new SynapEditor(editorId, editorConfig, html, eventListeners);


함수방식 사용

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';

function SynapEditor이벤트이름(e) {
    // 이벤트 이름은 첫자가 대문자
    // ex: initialized => SynapEditorInitialized
    // ex: beforeUploadImage => SynapEditorBeforeUploadImage
}

new SynapEditor(editorId, editorConfig, html);

이벤트 해제

API 사용

editor.removeEventListener()

등록한 이벤트를 제거 할 때 사용하는 API 입니다.

Code Block
languagejs
editor.removeEventListener('이벤트이름');


함수로 전달되는 객체 형태

Code Block
languagejs
{
	editor: {에디터 객체}, // 에디터
	eventType: 'initialized', // 이벤트 이름
	cancelable: false, // 이벤트 취소 가능 여부
	returnValue: null, // 반환이벤트 취소 여부
	....  

}
  • editor: 이벤트가 발생한 에디터입니다.
  • eventType: 이벤트 이름입니다.
  • cancelable: 이벤트 취소 가능 여부입니다.returValue: 반환 값입니다
  • returnValue: 이벤트 취소가 가능한 이벤트의 경우 (cancelable: true) , false를 전달하여 이벤트 진행을 취소할 수 있습니다.


이벤트 진행 취소

cancelable이 true인 경우, returnValue를 false로 설정하면 이벤트 진행을 취소할 수 있습니다.

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
    'beforeUploadImage': function (e) {
		e.returnValue = false; // 업로드가 더이상 진행되지 않습니다
    }
};

new SynapEditor(editorId, editorConfig, html, eventListeners);

이벤트 설명

1. initialized

Status
title릴리즈 2.1.0 이상

에디터가 초기화 되었을 때 발생합니다.

이벤트 등록: 함수방식

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';

function SynapEditorInitialized(e) {
    // editor 초기화 완료시 실행 (async)
    var editor = e.editor;
}

function SynapEditorInitializedSync(e) {
    // editor 초기화 완료시 실행 (sync)
    var editor = e.editor;
}

new SynapEditor(editorId, editorConfig, html);

이벤트 등록: 에디터 초기화시 등록

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
    initialized: function (e) {
        var editor = e.editor;
    },
    initializedSync: function (e) {
        var editor = e.editor;
    }
};

new SynapEditor(editorId, editorConfig, html, eventListeners);

함수로 전달되는 객체 형태

함수로 전달되는 파라미터 e의 형식

Code Block
languagejs
titlee
{
	editor: {에디터 객체},
	eventType: 'initialized',
	cancelable: false,
	returnValue: null
}

2. beforeUploadImage

Status
title릴리즈 2.2.0 이상

...

이벤트 등록: 함수방식

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';

function SynapEditorBeforeUploadImage(e) {
}

new SynapEditor(editorId, editorConfig, html);

이벤트 등록: 에디터 초기화시 등록

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
    beforeUploadImage: function (e) {
    }
};

new SynapEditor(editorId, editorConfig, html, eventListeners);

함수로 전달되는 객체 형태

함수로 전달되는 파라미터 e의 형식

Code Block
languagejs
titlee
{
	editor: SynapEditor,
	eventType:  "beforeUploadImage",
	cancelable: true,
	returnValue: null,
	fileName: "filename.png",
	isBackground: false
}

3. afterUploadImage

Status
title릴리즈 2.2.0 이상

이미지를 업로드한 후 발생합니다.

이벤트 등록: 함수방식

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';

function SynapEditorAfterUploadImage(e) {
}

new SynapEditor(editorId, editorConfig, html);

이벤트 등록: 에디터 초기화시 등록

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
    afterUploadImage: function (e) {
    }
};

new SynapEditor(editorId, editorConfig, html, eventListeners);

함수로 전달되는 객체 형태

함수로 전달되는 파라미터 e의 형식

Code Block
languagejs
titlee
{
	editor: SynapEditor,
	eventType:  "afterUploadImage",
	cancelable: false,
	returnValue: null,
	path: "/upload/path/filename.png",
	elementId: "se-123456-abcdefg-7890",
	isBackground: false
}

4. beforeUploadVideo

Status
title릴리즈 2.2.0 이상

비디오를 업로드 하기 전에 발생합니다. 이벤트 진행 취소가 가능합니다.

이벤트 등록: 함수방식

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';

function SynapEditorBeforeUploadVideo(e) {
}

new SynapEditor(editorId, editorConfig, html);

이벤트 등록: 에디터 초기화시 등록

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
    beforeUploadVideo: function (e) {
    }
};

new SynapEditor(editorId, editorConfig, html, eventListeners);

함수로 전달되는 객체 형태

함수로 전달되는 파라미터 e의 형식

Code Block
languagejs
titlee
{
	editor: SynapEditor,
	eventType:  "beforeUploadVideo",
	cancelable: true,
	returnValue: null,


	fileName: "filename.mp4"
}

5. afterUploadVideo

Status
title릴리즈 2.2.0 이상

비디오를 업로드한 후 발생합니다.

이벤트 등록: 함수방식

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';

function SynapEditorAfterUploadVideo(e) {
}

new SynapEditor(editorId, editorConfig, html);

이벤트 등록: 에디터 초기화시 등록

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
    afterUploadVideo: function (e) {
    }
};

new SynapEditor(editorId, editorConfig, html, eventListeners);

함수로 전달되는 객체 형태

함수로 전달되는 파라미터 e의 형식

Code Block
languagejs
titlee
{
	editor: SynapEditor,
	eventType:  "afterUploadVideo",
	cancelable: false,
	returnValue: null,


	path: "/upload/path/filename.mp4",
	elementId: "se-123456-abcdefg-7890"
}

6. beforeUploadFile

Status
title릴리즈 2.2.0 이상

파일을 업로드 하기 전에 발생합니다. 이벤트 진행 취소가 가능합니다.

이벤트 등록: 함수방식

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';

function SynapEditorBeforeUploadFile(e) {
}

new SynapEditor(editorId, editorConfig, html);

이벤트 등록: 에디터 초기화시 등록

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
    beforeUploadFile: function (e) {
    }
};

new SynapEditor(editorId, editorConfig, html, eventListeners);

함수로 전달되는 객체 형태

함수로 전달되는 파라미터 e의 형식

Code Block
languagejs
titlee
{
	editor: SynapEditor,
	eventType:  "beforeUploadFile",
	cancelable: true,
	returnValue: null,


	fileName: "filename.zip"
}

7. afterUploadFile

Status
title릴리즈 2.2.0 이상

파일을 업로드한 후 발생합니다.

이벤트 등록: 함수방식

Code Block
languagejs
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';

function SynapEditorAfterUploadFile(e) {
}

new SynapEditor(editorId, editorConfig, html);

이벤트 등록: 에디터 초기화시 등록

Code Block
languagejs
var editorId
= 'synapEditor'; var editorConfig = {};
var html = '';
var eventListeners = {
    afterUploadFile: function (e) {
    }
};

new SynapEditor(editorId, editorConfig, html, eventListeners);

함수로 전달되는 객체 형태

함수로 전달되는 파라미터 e의 형식

Code Block
languagejs
titlee
{
	editor: SynapEditor,
	eventType:  "afterUploadFile",
	cancelable: false,
	returnValue: null,


	path: "/upload/path/filename.zip"
}