Show:
Defined in: src/core/table.js:4

Table class utility. Provides methods for create, delete and update tables.

Constructor

CKEDITOR.Table

(
  • editor
)

Defined in src/core/table.js:4

Parameters:

  • editor Object

    The CKEditor instance.

Methods

_createElement

(
  • name
)
CKEDITOR.dom.element protected

Creates a new CKEDITOR.dom.element using the passed tag name.

Parameters:

  • name String

    The tag name from which an element should be created

Returns:

CKEDITOR.dom.element:

Instance of CKEDITOR DOM element class

create

(
  • config
)
Object

Creates a table.

Parameters:

  • config Object

    Table configuration object

Returns:

Object:

The created table

getFromSelection

() CKEDITOR.dom.element

Retrieves a table from the current selection.

Returns:

CKEDITOR.dom.element:

The retrieved table or null if not found.

getHeading

(
  • table
)
String

Returns which heading style is set for the given table.

Parameters:

  • table CKEDITOR.dom.element

    The table to gather the heading from. If null, it will be retrieved from the current selection.

Returns:

String:

The heading of the table. Expected values are CKEDITOR.Table.NONE, CKEDITOR.Table.ROW, CKEDITOR.Table.COL and CKEDITOR.Table.BOTH.

remove

(
  • table
)

Removes a table from the editor.

Parameters:

  • table CKEDITOR.dom.element

    The table element which table style should be removed.

setAttributes

(
  • table
  • attrs
)

Assigns provided attributes to a table.

Parameters:

  • table Object

    The table to which the attributes should be assigned

  • attrs Object

    The attributes which have to be assigned to the table

setHeading

(
  • table
  • heading
)

Sets the appropriate table heading style to a table.

Parameters:

  • table CKEDITOR.dom.element

    The table element to which the heading should be set. If null, it will be retrieved from the current selection.

  • heading String

    The table heading to be set. Accepted values are: CKEDITOR.Table.NONE, CKEDITOR.Table.ROW, CKEDITOR.Table.COL and CKEDITOR.Table.BOTH.