Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • availability
    • access: Action is available if the current user has one of the listed roles.
      • roles
        • <role>: Name of the role that is permitted to execute the action.
    • nodes: Action is available if the selected item is a node.
    • nodeTypes:Action is available if the selected item is one of the node types listed.
      • <node type>: A valid node type such as mgnl:folder.
    • rules: Action is available if the selected item(s) match for every availability rule class
      • <ruleNodeName>: give the node a name which reflects the rule-class
        • implementationClass : the class name of the rule availability class; class must implement info.magnolia.ui.api.availability.AvailabilityRule (usually just extending info.magnolia.ui.api.availability.AbstractAvailabilityRule)
    • root: Action is available at the workspace root level if true.
    • properties: Action is available if the selected item is a property.
    • multiple: Boolean property that enables and disables multiselection. Default is false. Available when the action class extends 
      Javadoc
      0info.magnolia.ui.framework.action.AbstractMultiItemAction
      . 
    • writePermissionRequired: Optional. Set to true if the action requires write permission on the currently selected node. The action will be disabled if the user doesn't have write permission. Default is false

...

  • availability
    • access: Action is available if the current user has one of the listed roles.
      • roles
        • <role>: Name of the  role  that is permitted to execute the action.
    • nodes: Action is available if the selected item is a node.
    • nodeTypes:Action is available if the selected item is one of the node types listed.
      • <node type>: A valid node type such as mgnl:folder.
    • ruleClass: Class that contains custom logic to check if the action is permitted on the selected item. A common example is info.magnolia.ui.api.availability.IsNotDeletedRule which checks that the item is not marked for deletion. Your custom class must extend 
      Javadoc
      0info.magnolia.ui.api.availability.AbstractAvailabilityRule
      .
    • root: Action is available at the workspace root level if true.
    • properties: Action is available if the selected item is a property.
    • multiple: Boolean property that enables and disables multiselection. Default is false. Available when the action class extends 
      Javadoc
      0.info.magnolia.ui.framework.action.AbstractMultiItemAction
      . 

...