AppSuite:Extending the UI - Revision history

Khgras at 09:47, 22 May 2017

2017-05-22T09:47:02Z

← Older revision		Revision as of 09:47, 22 May 2017
Line 1:		Line 1:
	The content on this page has moved to https://documentation.open-xchange.com/latest/ui/extension~~-points/02~~-points.html		The content on this page has moved to https://documentation.open-xchange.com/latest/ui/extension-points.html

	Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.		Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.

Khgras: Replaced content with "The content on this page has moved to https://documentation.open-xchange.com/latest/ui/extension-points/02-points.html Note: Open-Xchange is in the process of migrating a..."

2017-05-22T09:44:34Z

Replaced content with "The content on this page has moved to https://documentation.open-xchange.com/latest/ui/extension-points/02-points.html Note: Open-Xchange is in the process of migrating a..."

Show changes

Khgras at 09:41, 22 May 2017

2017-05-22T09:41:36Z

← Older revision		Revision as of 09:41, 22 May 2017
Line 7:		Line 7:
	<div class="title">Extension points:<br>General information </div>		<div class="title">Extension points:<br>General information </div>

	'''Abstract.''' Abstractly speaking extension points are an architecture for letting plugins contribute functionality to other parts of the program. They form the core of the OX App Suite plugin architecture. A less detailed hands-on introduction can be found [~~[ AppSuite~~:~~Extending_the_UI_(Hands~~-~~on_introduction) \|~~ here]]. Some basics about the extention point concept and advantages compared to inheritance.		'''Abstract.''' Abstractly speaking extension points are an architecture for letting plugins contribute functionality to other parts of the program. They form the core of the OX App Suite plugin architecture. A less detailed hands-on introduction can be found [https://documentation.open-xchange.com/latest/ui/extension-points/01-introduction.html here]. Some basics about the extention point concept and advantages compared to inheritance.
	__TOC__		__TOC__
	== Introduction ==		== Introduction ==

Frank.paczynski at 10:16, 10 February 2016

2016-02-10T10:16:59Z

← Older revision		Revision as of 10:16, 10 February 2016
Line 1:		Line 1:
			<!-- !!! -->
			<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation -->
			<!-- !!! -->

	{{Stability-experimental}}		{{Stability-experimental}}

Frank.paczynski at 10:17, 12 August 2015

2015-08-12T10:17:26Z

← Older revision		Revision as of 10:17, 12 August 2015
Line 68:		Line 68:

	=== add extension ===		=== add extension ===
	* important: existing extensions with same id will not be overwritten - use replace ~~insted~~		* important: existing extensions with same id will not be overwritten - use replace instead
	* If the id is not specified, the value 'default' is used.		* If the id is not specified, the value 'default' is used.
	* example: add extension with id 'date'		* example: add extension with id 'date'
Line 85:		Line 85:
	=== replace extension ===		=== replace extension ===
	* important: only extension properties will be replaced (jQuery extend is used internally)		* important: only extension properties will be replaced (jQuery extend is used internally)
	* hint: ''replace'' can also be executed before extension is initially created with ''extend''		* when calling replace on a not yet existing extension a new extension is created
			* hint: therefore ''replace'' can also be executed before extension is initially created with ''extend''

	'''''example'''''		'''''example'''''

Frank.paczynski: /* enabling/disabling */

2014-11-13T10:52:19Z

enabling/disabling

← Older revision		Revision as of 10:52, 13 November 2014
Line 140:		Line 140:
	=== enabling/disabling ===		=== enabling/disabling ===
	<pre class="language-javascript">		<pre class="language-javascript">
	var enabled = mypoint.isEnabled();</pre>		var enabled = mypoint.isEnabled(id);</pre>
	<pre class="language-javascript"> // chainable (returns mypoint)		<pre class="language-javascript"> // chainable (returns mypoint)
	mypoint.enable(id);</pre>		mypoint.enable(id);</pre>

Viktor.Pracht: /* add extension */

2013-10-11T14:08:37Z

add extension

← Older revision		Revision as of 14:08, 11 October 2013
Line 69:		Line 69:
	=== add extension ===		=== add extension ===
	* important: existing extensions with same id will not be overwritten - use replace insted		* important: existing extensions with same id will not be overwritten - use replace insted
			* If the id is not specified, the value 'default' is used.
	* example: add extension with id 'date'		* example: add extension with id 'date'

Frank.paczynski: /* Execution order */

2013-09-06T10:02:05Z

Execution order

← Older revision		Revision as of 10:02, 6 September 2013
Line 211:		Line 211:
	};</pre>		};</pre>

	=== ~~Execution~~ order ===		=== execution order ===

	To ensure your extension is called first or last use the index 'first' or 'last'. Keep in mind that a defined call order does not guarantees all extensions with a lower index finished already when your extension is called (for example some asynchronous code). Nevertheless for the most common use case (draw extensions that create/modify nodes with already present data) this execution order should be quite reliable to do some DOM manipulation within an custom extension indexed as 'last'. If more than one extension of a point has the index 'first' or 'last' these will be executed first/last in the order they were added.		To ensure your extension is called first or last use the index 'first' or 'last'. Keep in mind that a defined call order does not guarantees all extensions with a lower index finished already when your extension is called (for example some asynchronous code). Nevertheless for the most common use case (draw extensions that create/modify nodes with already present data) this execution order should be quite reliable to do some DOM manipulation within an custom extension indexed as 'last'. If more than one extension of a point has the index 'first' or 'last' these will be executed first/last in the order they were added.

Frank.paczynski: /* Attributes */

2013-09-06T10:01:49Z

Attributes

← Older revision		Revision as of 10:01, 6 September 2013
Line 211:		Line 211:
	};</pre>		};</pre>

			=== Execution order ===

			To ensure your extension is called first or last use the index 'first' or 'last'. Keep in mind that a defined call order does not guarantees all extensions with a lower index finished already when your extension is called (for example some asynchronous code). Nevertheless for the most common use case (draw extensions that create/modify nodes with already present data) this execution order should be quite reliable to do some DOM manipulation within an custom extension indexed as 'last'. If more than one extension of a point has the index 'first' or 'last' these will be executed first/last in the order they were added.

	=== extensions patterns ===		=== extensions patterns ===

Tierlieb at 10:02, 8 May 2013

2013-05-08T10:02:19Z

← Older revision		Revision as of 10:02, 8 May 2013
Line 362:		Line 362:
	[[Category:AppSuite]]		[[Category:AppSuite]]
	[[Category:UI]]		[[Category:UI]]
			[[Category:Extension points]]