Class: Editing

Extends

• FooTable.Component

Members

<private> _$buttons :null|jQuery

Caches the row button elements to help with performance.

Type:

• null | jQuery

addText :string

The text that appears in the add button. This can contain HTML.

Type:

• string

allowAdd :boolean

Whether or not to show the Add Row button.

Type:

• boolean

allowDelete :boolean

Whether or not to show the Delete Row button.

Type:

• boolean

allowEdit :boolean

Whether or not to show the Edit Row button.

Type:

• boolean

allowView :boolean

Whether or not to show the View Row button.

Type:

• boolean

alwaysShow :boolean

Whether or not the editing column and add row button are always visible.

Type:

• boolean

callbacks :object

This object is used to contain the callbacks for the add, edit and delete row buttons.

Type:

• object

Properties:

Name	Type	Description
addRow	function
editRow	function
deleteRow	function
viewRow	function

column :object

The options for the editing column. @see FooTable.EditingColumn for more info.

Type:

• object

Properties:

Name	Type	Default	Description
classes	string	"footable-editing"	A space separated string of class names to apply to all cells in the column.
name	string	"editing"	The name of the column.
title	string	""	The title displayed in the header row of the table for the column.
filterable	boolean	false	Whether or not the column should be filterable when using the filtering component.
sortable	boolean	false	Whether or not the column should be sortable when using the sorting component.

deleteText :string

The text that appears in the delete button. This can contain HTML.

Type:

• string

editText :string

The text that appears in the edit button. This can contain HTML.

Type:

• string

enabled :boolean

Whether or not this component is enabled. Disabled components only have there preinit method called allowing for this value to be overridden.

Type:

• boolean

Inherited From:

• FooTable.Component#enabled

ft :FooTable.Table

The parent FooTable.Table for the component.

Type:

• FooTable.Table

Inherited From:

• FooTable.Component#ft

hideText :string

The text that appears in the hide button. This can contain HTML.

Type:

• string

pageToNew :boolean

Whether or not to automatically page to a new row when it is added to the table.

Type:

• boolean

position :string

The position of the editing column in the table as well as the alignment of the buttons.

Type:

• string

showText :string

The text that appears in the show button. This can contain HTML.

Type:

• string

viewText :string

The text that appears in the view button. This can contain HTML.

Type:

• string

Methods

<static> draw()

Performs the drawing of the component.

<protected> $buttonAdd() → {string|HTMLElement|jQuery}

Creates the add button for the editing component.

Returns:

Type

string | HTMLElement | jQuery

<protected> $buttonDelete() → {string|HTMLElement|jQuery}

Creates the delete button for the editing component.

Returns:

Type

string | HTMLElement | jQuery

<protected> $buttonEdit() → {string|HTMLElement|jQuery}

Creates the edit button for the editing component.

Returns:

Type

string | HTMLElement | jQuery

<protected> $buttonHide() → {string|HTMLElement|jQuery}

Creates the hide button for the editing component.

Returns:

Type

string | HTMLElement | jQuery

<protected> $buttonShow() → {string|HTMLElement|jQuery}

Creates the show button for the editing component.

Returns:

Type

string | HTMLElement | jQuery

<protected> $buttonView() → {string|HTMLElement|jQuery}

Creates the view button for the editing component.

Returns:

Type

string | HTMLElement | jQuery

<protected> $create()

Creates the editing UI from the current options setting the various jQuery properties of this component.

<protected> $rowButtons() → {string|HTMLElement|jQuery}

Creates the button group for the row buttons.

Returns:

Type

string | HTMLElement | jQuery

<private> _onAddClick(e)

Handles the add button click event.

Parameters:

Name	Type	Description
e	jQuery.Event	The jQuery.Event object for the event.

Fires:

• FooTable.event:Editing"add.ft.editing"

<private> _onDeleteClick(e)

Handles the delete button click event.

Parameters:

Name	Type	Description
e	jQuery.Event	The jQuery.Event object for the event.

Fires:

• FooTable.event:Editing"delete.ft.editing"

<private> _onEditClick(e)

Handles the edit button click event.

Parameters:

Name	Type	Description
e	jQuery.Event	The jQuery.Event object for the event.

Fires:

• FooTable.event:Editing"edit.ft.editing"

<private> _onHideClick(e)

Handles the hide button click event.

Parameters:

Name	Type	Description
e	jQuery.Event	The jQuery.Event object for the event.

Fires:

• FooTable.event:Editing"show.ft.editing"

<private> _onShowClick(e)

Handles the show button click event.

Parameters:

Name	Type	Description
e	jQuery.Event	The jQuery.Event object for the event.

Fires:

• FooTable.event:Editing"show.ft.editing"

<private> _onViewClick(e)

Handles the view button click event.

Parameters:

Name	Type	Description
e	jQuery.Event	The jQuery.Event object for the event.

Fires:

• FooTable.event:Editing"view.ft.editing"

<protected> destroy()

Destroys the editing component removing any UI generated from the table.

Fires:

• FooTable.event:Editing"destroy.ft.editing"

<protected> draw()

This method is called from the FooTable.Table#draw method.

Inherited From:

• FooTable.Component#draw

<protected> init()

Initializes the editing component for the plugin using the supplied table and options.

Fires:

• FooTable.event:Editing"init.ft.editing"

<protected> postdraw()

This method is called from the FooTable.Table#draw method.

Inherited From:

• FooTable.Component#postdraw

<protected> predraw()

This method is called from the FooTable.Table#draw method.

Inherited From:

• FooTable.Component#predraw

<protected> preinit(data)

Checks the supplied data and options for the editing component.

Parameters:

Name	Type	Description
data	object	The jQuery data object from the parent table.

Fires:

• FooTable.event:Editing"preinit.ft.editing"