Page History

...

Action definitions configure actions in the UI. The action has a name which is the name of the definition content node. The action is identified by this name within a certain scope, such as within a subapp. 

Action definitions are used in apps, forms and dialogs. They are configured and used in the same way throughout the UI. Dialogs and forms typically require only save and cancel actions, which are simple configurations.

Action definition properties

Each actions has an action definition class that implements the

General actions

Example: addContact action definition in Contacts app. A user can execute the action in the action bar or in the action popup. When the action is executed, the detail subapp is launched.

...

Command actions

• An action can trigger a command.
• Commands are used to perform more complicated tasks. For example, the activate command publishes content from the author instance to public instances and versions the content.
• Each command action used in the UI has its own action definition class that extends

  Javadoc resource link
  rangeHigherVersion 5.7 className info.magnolia.ui.api.action.CommandActionDefinition renderType asynchronous

   .
• If you want to implement your own command, please create your own action definition class that extends

  Javadoc resource link
  rangeHigherVersion 5.7 className info.magnolia.ui.api.action.CommandActionDefinition renderType asynchronous

   . Please also create your own action implementation class that extends

  Javadoc resource link
  rangeHigherVersion 5.7 className info.magnolia.ui.framework.action.AbstractCommandAction renderType asynchronous

   .

...

You can use these properties for command actions in addition to the general action properties.

Properties:

Asynchronous actions

Setting the asynchronous property to true allows you to run a command action asynchronously in the background. Use this feature for long-running actions that would otherwise block the user interface and prevent the user from continuing their work.

...

Publish recursively and Delete action run asynchronously by default. These actions involve versioning of content and can be time consuming.

Action definition classes

You can use these common classes in your action definition. They all implement the 

...

Reusing an action

Reuse the existing Magnolia actions in your own app. Many actions are so basic that you can just copy the action definition. Some actions have their own properties. You may need to set them for the action to work.

...

<sv:node sv:name="photo">
  <sv:property sv:name="jcr:primaryType" sv:type="Name">
    <sv:value>mgnl:resource</sv:value>
  </sv:property>
  <sv:property sv:name="jcr:uuid" sv:type="String">
    <sv:value>ed5f5ed0-26fc-4c43-8d63-21aca30ca151</sv:value>
  </sv:property>
  <sv:property sv:name="extension" sv:type="String">
    <sv:value>jpg</sv:value>
  </sv:property>
  <sv:property sv:name="fileName" sv:type="String">
    <sv:value>vangogh</sv:value>
  </sv:property>
  <sv:property sv:name="height" sv:type="Long">
    <sv:value>479</sv:value>
  </sv:property>
  <sv:property sv:name="jcr:data" sv:type="Binary">
    <sv:value>/9j/4AAQSkZJRgABAQEASABIAAD

Action availability

Action availability defines whether the action is permitted on the selected item. For example, the addCategory  action below is permitted when:

...

Action availability definition classes

Actions on multiple items

Action availability defines whether an action can be executed on multiple items. Delete, move, publish and unpublish are examples of actions that can be executed on multiple items. Actions that extend AbstractMultiItemAction can handle multiple items. By default, the delete action is available for multiple items in all content apps.

...

To do a more detailed availability check, such as to verify that all the items are on the same level or have the same parent, use action availability rules.

When you program an action that supports multiple items you are responsible for handling the items in the correct order and solving dependencies. For example, when deleting multiple nodes where one node is a child of another, delete the nodes in a correct order to avoid exceptions, or handle such exceptions. An action is also responsible for informing the user about the result, whether it has successfully processed all the items or failed on some of them.

...