AppSuite:Action links - Revision history

Khgras at 09:12, 22 May 2017

2017-05-22T09:12:25Z

← Older revision		Revision as of 09:12, 22 May 2017
Line 1:		Line 1:
	~~<!-- !!! -->~~		The content on this page has moved to https://documentation.open-xchange.com/latest/ui/components/actions-and-links.html
	~~<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION~~: ~~wd/frontend~~/~~web~~/documentation -->
	~~<!-- !!! -~~->

			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.
	~~{{Stability~~-~~experimental}}~~

	~~<div class="status-disclaimer">~~
	~~'''Please note:'''~~
	~~This page~~ is ~~currently under construction. It might change any minute now.~~
	~~</div>~~

	~~<div class="title">Understanding action links</div>~~

	~~Action links can be used to apply an action to an item or even a selection~~ of ~~items. Use them~~ to ~~extend actions for existing items or create a toolbox for your custom items available in your [[Appsuite:Writing a simple application\|application]].~~

	~~= The API =~~

	~~== Action ==~~

	~~Creating~~ a new ~~action is pretty straight forward. Just create a new Action~~ and ~~give it a unique name~~ (~~internally we use slashes to indicate a module hierarchy, so names are inherently unique) and provide a few options~~.

	~~<pre class="language~~-~~javascript">~~
	~~var action = new Action('unique/name/of/my/action', {~~
	~~//some options go in here~~
	});
	~~</pre>~~

	~~=== Available options ===~~

	In the ~~options parameter you can provide~~ the ~~actual logic for the action. You can provide callbacks, requirements~~ and ~~more~~.

	* id
	** a unique identifier (String)
	* requires (optional)
	** (String) - a String containing one or more special keywords that are required for this ~~action to be active~~
	*** toplevel
	*** one
	*** some
	*** delete
	*** …
	** (Function) - a function that returns a Boolean value and gets a Baton object as parameter
	* multiple (optional)
	** (Function) - a callback function, called when the action is triggered with a list of ~~elements~~
	* action (optional)
	** (Function) - a callback function, called when the action is triggered for one element

	~~== ActionLink ==~~

	~~== ActionGroup ==~~

	~~== Link ==~~

	~~== XLink ==~~

	~~== Button ==~~

	~~== ButtonGroup ==~~

	~~== ToolbarButtons ==~~

	~~== ToolbarLinks ==~~

	~~== InlineLinks ==~~

	~~== DropdownLinks ==~~

	~~== Dropdown ==~~

	~~= Examples =~~

Frank.paczynski at 06:29, 10 February 2016

2016-02-10T06:29:37Z

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


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

Tierlieb: stability index

2013-04-25T14:25:16Z

stability index

← Older revision		Revision as of 14:25, 25 April 2013
Line 1:		Line 1:
			{{Stability-experimental}}

	<div class="status-disclaimer">		<div class="status-disclaimer">
	'''Please note:'''		'''Please note:'''

J.ohny.b at 12:39, 23 April 2013

2013-04-23T12:39:43Z

← Older revision		Revision as of 12:39, 23 April 2013
Line 1:		Line 1:
	<div class="status-disclaimer">		<div class="status-disclaimer">
	'''Please note:'''		'''Please note:'''
	This page is currently under construction.		This page is currently under construction. It might change any minute now.
	</div>		</div>

J.ohny.b at 12:39, 23 April 2013

2013-04-23T12:39:26Z

← Older revision		Revision as of 12:39, 23 April 2013
Line 1:		Line 1:
			<div class="status-disclaimer">
			'''Please note:'''
			This page is currently under construction.
			</div>

	<div class="title">Understanding action links</div>		<div class="title">Understanding action links</div>

J.ohny.b: /* The API */

2013-04-19T15:22:39Z

The API

← Older revision		Revision as of 15:22, 19 April 2013
Line 55:		Line 55:

	== Dropdown ==		== Dropdown ==

			= Examples =

J.ohny.b: add stub for this article

2013-04-19T15:02:02Z

add stub for this article

New page

<div class="title">Understanding action links</div>

Action links can be used to apply an action to an item or even a selection of items. Use them to extend actions for existing items or create a toolbox for your custom items available in your [[Appsuite:Writing a simple application|application]].

= The API =

== Action ==

Creating a new action is pretty straight forward. Just create a new Action and give it a unique name (internally we use slashes to indicate a module hierarchy, so names are inherently unique) and provide a few options.

<pre class="language-javascript">
var action = new Action('unique/name/of/my/action', {
//some options go in here
});
</pre>

=== Available options ===

In the options parameter you can provide the actual logic for the action. You can provide callbacks, requirements and more.

* id
** a unique identifier (String)
* requires (optional)
** (String) - a String containing one or more special keywords that are required for this action to be active
*** toplevel
*** one
*** some
*** delete
*** …
** (Function) - a function that returns a Boolean value and gets a Baton object as parameter
* multiple (optional)
** (Function) - a callback function, called when the action is triggered with a list of elements
* action (optional)
** (Function) - a callback function, called when the action is triggered for one element

== ActionLink ==

== ActionGroup ==

== Link ==

== XLink ==

== Button ==

== ButtonGroup ==

== ToolbarButtons ==

== ToolbarLinks ==

== InlineLinks ==

== DropdownLinks ==

== Dropdown ==