{! var classType = ""; if (data.isBuiltin()) { classType += "Built-In "; } if (data.isNamespace) { if (data.is('FUNCTION')) { classType += "Function "; } classType += "Namespace "; } else { classType += "Class "; } !} {+classType+}{+data.alias+}
Version
{+ data.version +}.
Extends
{+
data.augments
.sort()
.map(
function($) { return new Link().toSymbol($); }
)
.join(", ")
+}.
Defined in: {+ ckeditor_FileLink( data.srcFile ) +}.
Constructor Attributes | Constructor Name and Description |
---|---|
{! if (data.isPrivate) output += "<private> "; if (data.isInner) output += "<inner> "; !} |
{+ new Link().toSymbol(data.alias).inner('constructor')+}
{+resolveLinks(summarize(data.desc))+}
|
Constant Attributes | Constant Name and Description |
---|---|
{! if (member.isPrivate) output += "<private> "; if (member.isInner) output += "<inner> "; if (member.isStatic) output += "<static> "; !} |
{+resolveLinks(summarize(member.desc))+}
|
Field Attributes | Field Name and Description |
---|---|
{! if (member.isPrivate) output += "<private> "; if (member.isInner) output += "<inner> "; if (member.isStatic) output += "<static> "; if (member.isConstant) output += "<constant> "; !} |
{+resolveLinks(summarize(member.desc))+}
|
-
{!
var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias});
var contributers = [];
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
for (var i = 0, l = contributers.length; i < l; i++) {
output +=
"
- Fields borrowed from class "+new Link().toSymbol(contributers[i])+": " + "
- " + borrowedMembers .filter( function($) { return $.memberOf == contributers[i] } ) .sort(makeSortby("name")) .map( function($) { return new Link().toSymbol($.alias).withText($.name) } ) .join(", ") + " "; } !}
Method Attributes | Method Name and Description |
---|---|
{! if (member.isPrivate) output += "<private> "; if (member.isInner) output += "<inner> "; if (member.isStatic) output += "<static> "; !} |
{+resolveLinks(summarize(member.desc))+}
|
-
{!
var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias});
var contributers = [];
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
for (var i = 0, l = contributers.length; i < l; i++) {
output +=
"
- Methods borrowed from class "+new Link().toSymbol(contributers[i])+": " + "
- " + borrowedMembers .filter( function($) { return $.memberOf == contributers[i] } ) .sort(makeSortby("name")) .map( function($) { return new Link().toSymbol($.alias).withText($.name) } ) .join(", ") + " "; } !}
Event Attributes | Event Name and Description |
---|---|
{! if (member.isPrivate) output += "<private> "; if (member.isInner) output += "<inner> "; if (member.isStatic) output += "<static> "; !} |
{+resolveLinks(summarize(member.desc))+}
|
-
{!
var borrowedMembers = data.events.filter(function($) {return $.memberOf != data.alias});
var contributers = [];
borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
for (var i = 0, l = contributers.length; i < l; i++) {
output +=
"
- Events borrowed from class "+new Link().toSymbol(contributers[i])+": " + "
- " + borrowedMembers .filter( function($) { return $.memberOf == contributers[i] } ) .sort(makeSortby("name")) .map( function($) { return new Link().toSymbol($.alias).withText($.name) } ) .join(", ") + " "; } !}
{+classType+}Detail
{!
if (data.isPrivate) output += "<private> ";
if (data.isInner) output += "<inner> ";
!}
{+ data.alias +}{+ makeSignature(data.params) +}
Since:
{+ data.since +}
3.0
{+resolveLinks(data.desc)+}
Author: {+data.author+}.
Author: {+data.author+}.
{+example+}
NO EXAMPLE AVAILABLE
- Parameters:
-
{{+ new Link().toSymbol(item.type || 'Undefined') +}} {+item.name+}
Optional , Default: {+item.defaultValue+} - {+resolveLinks(item.desc)+}
- Deprecated:
- {+resolveLinks(data.deprecated)+}
- Throws:
- {{+ new Link().toSymbol(item.type || 'Undefined') +}} {+item.name+}
- {+resolveLinks(item.desc)+}
- Returns:
- {{+ new Link().toSymbol(item.type || 'Undefined') +}} {+resolveLinks(item.desc)+}
- Requires:
- {+ resolveLinks(item) +}
- See:
- {+ new Link().toSymbol(item) +}
Field Detail
{!
if (member.isPrivate) output += "<private> ";
if (member.isInner) output += "<inner> ";
if (member.isStatic) output += "<static> ";
if (member.isConstant) output += "<constant> ";
!}
{{+ new Link().toSymbol( member.type || 'Undefined') +}}
{+member.memberOf+}. {+member.name+}
Since:
{+ member.since +}
3.0
{+resolveLinks(member.desc)+}
Defined in: {+ ckeditor_FileLink( member.srcFile ) +}.
Author: {+member.author+}.
Defined in: {+ ckeditor_FileLink( member.srcFile ) +}.
Author: {+member.author+}.
{+example+}
NO EXAMPLE AVAILABLE
- Deprecated:
- {+ resolveLinks(member.deprecated) +}
- See:
- {+ new Link().toSymbol(item) +}
- Default Value:
- {+resolveLinks(member.defaultValue)+}
Method Detail
{!
if (member.isPrivate) output += "<private> ";
if (member.isInner) output += "<inner> ";
if (member.isStatic) output += "<static> ";
!}
{{+ new Link().toSymbol( member.type || 'Undefined') +}}
{+member.memberOf+}. {+member.name.replace(/\^\d+$/, '')+}{+makeSignature(member.params)+}
Since:
{+ member.since +}
3.0
{+resolveLinks(member.desc)+}
Defined in: {+ ckeditor_FileLink( member.srcFile ) +}.
Author: {+member.author+}.
Defined in: {+ ckeditor_FileLink( member.srcFile ) +}.
Author: {+member.author+}.
{+example+}
NO EXAMPLE AVAILABLE
- Parameters:
-
{{+ new Link().toSymbol(item.type || 'Undefined') +}} {+item.name+}
Optional , Default: {+item.defaultValue+} - {+resolveLinks(item.desc)+}
- Deprecated:
- {+resolveLinks(member.deprecated)+}
- Throws:
- {{+ new Link().toSymbol(item.type || 'Undefined') +}} {+item.name+}
- {+resolveLinks(item.desc)+}
- Returns:
- {{+ new Link().toSymbol(item.type || 'Undefined') +}} {+resolveLinks(item.desc)+}
- Requires:
- {+ resolveLinks(item) +}
- See:
- {+ new Link().toSymbol(item) +}
Event Detail
{!
if (member.isPrivate) output += "<private> ";
if (member.isInner) output += "<inner> ";
if (member.isStatic) output += "<static> ";
!}
{{+new Link().toSymbol(member.type)+}}
{+member.memberOf+}.
{+member.name+} : <object>.{+new Link().toSymbol('CKEDITOR.event#on').withText('on')+}( '{+member.name+}', function( e ){ ... } )
Since:
{+ member.since +}
3.0
{+resolveLinks(member.desc)+}
Defined in: {+new Link().toSrc(member.srcFile)+}.
Author: {+member.author+}.
Defined in: {+new Link().toSrc(member.srcFile)+}.
Author: {+member.author+}.
{+example+}
NO EXAMPLE AVAILABLE
- Parameters:
- {{+new Link().toSymbol('CKEDITOR.eventInfo')+}} e
- The standard event object passed to event listeners.
-
{+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}e.{+item.name+}
Optional , Default: {+item.defaultValue+} - {+ resolveLinks(item.desc) +}
- Deprecated:
- {+ resolveLinks(member.deprecated) +}
- Throws:
- {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+} {+item.name+}
- {+ resolveLinks(item.desc) +}
- Returns:
- {+((item.type)?"{"+(new Link().toSymbol(item.type))+"} " : "")+}{+resolveLinks(item.desc)+}
- Requires:
- {+ resolveLinks(item) +}
- See:
- {+ new Link().toSymbol(item) +}