.. image:: https://github.com/IMIO/collective.eeafaceted.batchactions/actions/workflows/main.yml/badge.svg?branch=master
:target: https://github.com/IMIO/collective.eeafaceted.batchactions/actions/workflows/main.yml
.. image:: https://coveralls.io/repos/IMIO/collective.eeafaceted.batchactions/badge.png?branch=master
:target: https://coveralls.io/r/IMIO/collective.eeafaceted.batchactions?branch=master
.. image:: http://img.shields.io/pypi/v/collective.eeafaceted.batchactions.svg
:alt: PyPI badge
:target: https://pypi.org/project/collective.eeafaceted.batchactions
==================================
collective.eeafaceted.batchactions
==================================
This package gives the possibility to define batch actions on elements displayed in a eea.facetednavigation dashboard
* `Source code @ GitHub <https://github.com/IMIO/collective.eeafaceted.batchactions>`_
* `Releases @ PyPI <http://pypi.python.org/pypi/collective.eeafaceted.batchactions>`_
* `Continuous Integration @ Travis-CI <http://travis-ci.org/IMIO/collective.eeafaceted.batchactions>`_
How it works
============
This will display BrowserViews registered for `collective.eeafaceted.batchactions.interfaces.IBatchActionsMarker` or
an interface subclassing it at the bottom of a eea.facetednavigation dashboard.
Using a `collective.eeafaceted.z3ctable` `CheckBoxColumn`, you will be able to select elements to tigger the batch action on.
Batch actions are overridable from a faceted navigation container to another if necessary.
Installation
============
To install `collective.eeafaceted.batchactions` you simply add ``collective.eeafaceted.batchactions``
to the list of eggs in your buildout, run buildout and restart Plone.
Then, install `collective.eeafaceted.batchactions` using the Add-ons control panel.
Changelog
=========
1.15 (2024-04-10)
-----------------
- Import `safe_encode` from `imio.pyutils` instead `imio.helpers`.
[gbastien]
- Check `available` in `update` instead in `handleApply` so form is not
displayed at all if user have not access.
[gbastien]
1.14 (2023-09-04)
-----------------
- In `BaseARUOBatchActionForm._apply`, return the elements that were actually
updated so it may be used when overriding the base view.
[gbastien]
- Avoided exception when a field value is None and we want to get a list or set
[sgeulette]
1.13 (2023-07-12)
-----------------
- Added `BaseARUOBatchActionForm`, a class factorizing the action that
`add/remove/update/overwrite` values on an attribute of an object
(originally used for the `LabelsBatchActionForm`) so it is easier to reuse
for other similar actions. `LabelsBatchActionForm` is now based on that
`BaseARUOBatchActionForm`.
[gbastien]
- Activated `delete-batch-action` for zope admin
[sgeulette]
1.12 (2023-06-27)
-----------------
- Added action to `Update WF role mappings`.
Moved `available_permission` functionality from `ContactBaseBatchActionForm`
to `BaseBatchActionForm` so it is available for any action.
Added `BaseBatchActionForm.available_for_zope_admin` that makes an action
only available to the Zope admin.
[gbastien]
- Make `UpdateWFRoleMappingsActionForm` use
`imio.helpers.workflow.update_role_mappings_for`.
[gbastien]
1.11 (2022-05-06)
-----------------
- Avoided exception when referer url contains non ascii char.
[sgeulette]
1.10 (2022-02-10)
-----------------
- Corrected UnicodeDecodeError on transition title.
[sgeulette]
1.9 (2021-12-06)
----------------
- Checked permission on context (in ContactBaseBatchActionForm).
[sgeulette]
1.8 (2021-07-16)
----------------
- Highlight message about number of elements that will be updated
by the action on the popup.
[gbastien]
1.7 (2021-07-16)
----------------
- Adapted code to be able to display several tables on same page
(and so several batchactions viewlets):
- Added possibility to define the name of the `CheckBoxColumn`
(still `select_item` by default);
- Introduce idea of section for the viewlet and the batch actions so it is
possible to display different actions on different viewlets or different
views of same context.
[gbastien]
- Added method `BaseBatchActionForm._final_update` called when every other
`update` methods have been called.
[gbastien]
- Added `BaseBatchActionForm.apply_button_title` attribute to formalize
management of `apply` button title, that will be `Apply` by default but that
may be changed to fit the current batch action.
[gbastien]
- Added `DeleteBatchActionForm` a delete elements batch action.
[gbastien]
- Require `plone.formwidget.masterselect<2.0.0` as it is only for `Plone5.2+/Py3`.
[gbastien]
1.6 (2020-12-21)
----------------
- After action applied, do not reload the entire page,
just reload the current faceted results.
[gbastien]
- Use `CheckBoxFieldWidget` instead `SelectFieldWidget` to manage labels to
(un)select in `LabelsBatchActionForm` to avoid manipulation with
`CTRL+click` for selection. Adapted and rationalized translations.
[gbastien]
- Add a `collective.fingerpointing` entry when applying action to know
which action was applied on how much elements.
[gbastien]
1.5 (2020-04-23)
----------------
- Make sure elements are treated in received `uids` order. Need to rely on
`imio.helpers` to use `content.uuidsToCatalogBrains(ordered=True)`.
[gbastien]
1.4 (2019-11-25)
----------------
- Added view to change labels. (button is not added)
[sgeulette]
- Added base view to change a collective.contact.widget field.
[sgeulette]
1.3 (2019-05-16)
----------------
- Moved method `browser.views.brains_from_uids` to `utils`, added helper method
`utils.listify_uids` that turns the data uids that is a string with each UID
separated by a comma into a real python list.
[gbastien]
- Display number of elements affected by action in the batch action form description.
[gbastien]
1.2 (2019-03-08)
----------------
- Added weight attribute on batch action forms to order them.
[sgeulette]
- Improved brains_from_uids
[sgeulette]
- Added utils method
[sgeulette]
1.1 (2018-08-31)
----------------
- Don't apply changes if form errors
[sgeulette]
1.0 (2018-06-20)
----------------
- Moved js variables to `collective.eeafaceted.z3ctable`.
[gbastien]
0.7 (2018-06-06)
----------------
- Render batch action form in overlay by default, but otherwise with form 'overlay' attribute set to False.
[sgeulette]
0.6 (2018-01-06)
----------------
- Added condition on apply button.
[sgeulette]
- Added _update_widgets method
[sgeulette]
0.5 (2018-01-05)
----------------
- Some changes to made it working with a simple z3c.table.
[sgeulette]
0.4.1 (2017-12-01)
------------------
- Fixed english po file.
[gbastien]
0.4 (2017-12-01)
----------------
- Added `collective_eeafaceted_batchactions_js_variables.js` that allows to
translate the `no_selected_items` message.
[gbastien]
0.3 (2017-11-30)
----------------
- Renamed `BatchActionForm` to `BaseBatchActionForm` to show that it is the base
form to inherit from to build new batch action. Make it inherit from
`Form` instead `EditForm`.
[gbastien]
- Refactored the way form is updated and applied : two methods are there to be
overrided : `_update` that is called in the `update` process and `_apply` that
is called by `handleApply`. This way it is easy to build an new action
without having to think about basic default behavior.
[gbastien]
- In the `TransitionBatchActionForm`, sort selectable transitions alphabetically.
[gbastien]
0.2 (2017-11-24)
----------------
- Use `getMultiAdapter` instead `restrictedTraverse` when getting the form
in the viewlet to speed up things.
[gbastien]
- Added attribute `button_with_icon` to a batch action, if set to True,
a particular CSS class is added to the button so it can be skinned
with an icon easily.
[gbastien]
- Register a `batch_actions.css` resource for basic styling.
[gbastien]
0.1 (2017-11-23)
----------------
- Initial release.
[IMIO]
Raw data
{
"_id": null,
"home_page": "https://github.com/IMIO/collective.eeafaceted.batchactions",
"name": "collective.eeafaceted.batchactions",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "faceted navigation batch actions table",
"author": "IMIO",
"author_email": "dev@imio.be",
"download_url": "https://files.pythonhosted.org/packages/37/1e/f983c921e22e578f254551d2e64b1f1e6ad89661c9d7da9e0bd86a62c127/collective.eeafaceted.batchactions-1.15.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/IMIO/collective.eeafaceted.batchactions/actions/workflows/main.yml/badge.svg?branch=master\n :target: https://github.com/IMIO/collective.eeafaceted.batchactions/actions/workflows/main.yml\n\n.. image:: https://coveralls.io/repos/IMIO/collective.eeafaceted.batchactions/badge.png?branch=master\n :target: https://coveralls.io/r/IMIO/collective.eeafaceted.batchactions?branch=master\n\n.. image:: http://img.shields.io/pypi/v/collective.eeafaceted.batchactions.svg\n :alt: PyPI badge\n :target: https://pypi.org/project/collective.eeafaceted.batchactions\n\n==================================\ncollective.eeafaceted.batchactions\n==================================\n\nThis package gives the possibility to define batch actions on elements displayed in a eea.facetednavigation dashboard\n\n* `Source code @ GitHub <https://github.com/IMIO/collective.eeafaceted.batchactions>`_\n* `Releases @ PyPI <http://pypi.python.org/pypi/collective.eeafaceted.batchactions>`_\n* `Continuous Integration @ Travis-CI <http://travis-ci.org/IMIO/collective.eeafaceted.batchactions>`_\n\nHow it works\n============\n\nThis will display BrowserViews registered for `collective.eeafaceted.batchactions.interfaces.IBatchActionsMarker` or\nan interface subclassing it at the bottom of a eea.facetednavigation dashboard.\n\nUsing a `collective.eeafaceted.z3ctable` `CheckBoxColumn`, you will be able to select elements to tigger the batch action on.\n\nBatch actions are overridable from a faceted navigation container to another if necessary.\n\n\nInstallation\n============\n\nTo install `collective.eeafaceted.batchactions` you simply add ``collective.eeafaceted.batchactions``\nto the list of eggs in your buildout, run buildout and restart Plone.\nThen, install `collective.eeafaceted.batchactions` using the Add-ons control panel.\n\n\nChangelog\n=========\n\n\n1.15 (2024-04-10)\n-----------------\n\n- Import `safe_encode` from `imio.pyutils` instead `imio.helpers`.\n [gbastien]\n- Check `available` in `update` instead in `handleApply` so form is not\n displayed at all if user have not access.\n [gbastien]\n\n1.14 (2023-09-04)\n-----------------\n\n- In `BaseARUOBatchActionForm._apply`, return the elements that were actually\n updated so it may be used when overriding the base view.\n [gbastien]\n- Avoided exception when a field value is None and we want to get a list or set\n [sgeulette]\n\n1.13 (2023-07-12)\n-----------------\n\n- Added `BaseARUOBatchActionForm`, a class factorizing the action that\n `add/remove/update/overwrite` values on an attribute of an object\n (originally used for the `LabelsBatchActionForm`) so it is easier to reuse\n for other similar actions. `LabelsBatchActionForm` is now based on that\n `BaseARUOBatchActionForm`.\n [gbastien]\n- Activated `delete-batch-action` for zope admin\n [sgeulette]\n\n1.12 (2023-06-27)\n-----------------\n\n- Added action to `Update WF role mappings`.\n Moved `available_permission` functionality from `ContactBaseBatchActionForm`\n to `BaseBatchActionForm` so it is available for any action.\n Added `BaseBatchActionForm.available_for_zope_admin` that makes an action\n only available to the Zope admin.\n [gbastien]\n- Make `UpdateWFRoleMappingsActionForm` use\n `imio.helpers.workflow.update_role_mappings_for`.\n [gbastien]\n\n1.11 (2022-05-06)\n-----------------\n\n- Avoided exception when referer url contains non ascii char.\n [sgeulette]\n\n1.10 (2022-02-10)\n-----------------\n\n- Corrected UnicodeDecodeError on transition title.\n [sgeulette]\n\n1.9 (2021-12-06)\n----------------\n\n- Checked permission on context (in ContactBaseBatchActionForm).\n [sgeulette]\n\n1.8 (2021-07-16)\n----------------\n\n- Highlight message about number of elements that will be updated\n by the action on the popup.\n [gbastien]\n\n1.7 (2021-07-16)\n----------------\n\n- Adapted code to be able to display several tables on same page\n (and so several batchactions viewlets):\n\n - Added possibility to define the name of the `CheckBoxColumn`\n (still `select_item` by default);\n - Introduce idea of section for the viewlet and the batch actions so it is\n possible to display different actions on different viewlets or different\n views of same context.\n\n [gbastien]\n- Added method `BaseBatchActionForm._final_update` called when every other\n `update` methods have been called.\n [gbastien]\n- Added `BaseBatchActionForm.apply_button_title` attribute to formalize\n management of `apply` button title, that will be `Apply` by default but that\n may be changed to fit the current batch action.\n [gbastien]\n- Added `DeleteBatchActionForm` a delete elements batch action.\n [gbastien]\n- Require `plone.formwidget.masterselect<2.0.0` as it is only for `Plone5.2+/Py3`.\n [gbastien]\n\n1.6 (2020-12-21)\n----------------\n\n- After action applied, do not reload the entire page,\n just reload the current faceted results.\n [gbastien]\n- Use `CheckBoxFieldWidget` instead `SelectFieldWidget` to manage labels to\n (un)select in `LabelsBatchActionForm` to avoid manipulation with\n `CTRL+click` for selection. Adapted and rationalized translations.\n [gbastien]\n- Add a `collective.fingerpointing` entry when applying action to know\n which action was applied on how much elements.\n [gbastien]\n\n1.5 (2020-04-23)\n----------------\n\n- Make sure elements are treated in received `uids` order. Need to rely on\n `imio.helpers` to use `content.uuidsToCatalogBrains(ordered=True)`.\n [gbastien]\n\n1.4 (2019-11-25)\n----------------\n\n- Added view to change labels. (button is not added)\n [sgeulette]\n- Added base view to change a collective.contact.widget field.\n [sgeulette]\n\n1.3 (2019-05-16)\n----------------\n\n- Moved method `browser.views.brains_from_uids` to `utils`, added helper method\n `utils.listify_uids` that turns the data uids that is a string with each UID\n separated by a comma into a real python list.\n [gbastien]\n- Display number of elements affected by action in the batch action form description.\n [gbastien]\n\n1.2 (2019-03-08)\n----------------\n\n- Added weight attribute on batch action forms to order them.\n [sgeulette]\n- Improved brains_from_uids\n [sgeulette]\n- Added utils method\n [sgeulette]\n\n1.1 (2018-08-31)\n----------------\n\n- Don't apply changes if form errors\n [sgeulette]\n\n1.0 (2018-06-20)\n----------------\n\n- Moved js variables to `collective.eeafaceted.z3ctable`.\n [gbastien]\n\n0.7 (2018-06-06)\n----------------\n\n- Render batch action form in overlay by default, but otherwise with form 'overlay' attribute set to False.\n [sgeulette]\n\n0.6 (2018-01-06)\n----------------\n\n- Added condition on apply button.\n [sgeulette]\n- Added _update_widgets method\n [sgeulette]\n\n0.5 (2018-01-05)\n----------------\n\n- Some changes to made it working with a simple z3c.table.\n [sgeulette]\n\n0.4.1 (2017-12-01)\n------------------\n\n- Fixed english po file.\n [gbastien]\n\n0.4 (2017-12-01)\n----------------\n\n- Added `collective_eeafaceted_batchactions_js_variables.js` that allows to\n translate the `no_selected_items` message.\n [gbastien]\n\n0.3 (2017-11-30)\n----------------\n\n- Renamed `BatchActionForm` to `BaseBatchActionForm` to show that it is the base\n form to inherit from to build new batch action. Make it inherit from\n `Form` instead `EditForm`.\n [gbastien]\n- Refactored the way form is updated and applied : two methods are there to be\n overrided : `_update` that is called in the `update` process and `_apply` that\n is called by `handleApply`. This way it is easy to build an new action\n without having to think about basic default behavior.\n [gbastien]\n- In the `TransitionBatchActionForm`, sort selectable transitions alphabetically.\n [gbastien]\n\n0.2 (2017-11-24)\n----------------\n\n- Use `getMultiAdapter` instead `restrictedTraverse` when getting the form\n in the viewlet to speed up things.\n [gbastien]\n- Added attribute `button_with_icon` to a batch action, if set to True,\n a particular CSS class is added to the button so it can be skinned\n with an icon easily.\n [gbastien]\n- Register a `batch_actions.css` resource for basic styling.\n [gbastien]\n\n0.1 (2017-11-23)\n----------------\n\n- Initial release.\n [IMIO]",
"bugtrack_url": null,
"license": "GPL V2",
"summary": "This package provides batch actions for eea.facetednavigation dashboard",
"version": "1.15",
"project_urls": {
"Download": "https://pypi.org/project/collective.eeafaceted.batchactions",
"Homepage": "https://github.com/IMIO/collective.eeafaceted.batchactions"
},
"split_keywords": [
"faceted",
"navigation",
"batch",
"actions",
"table"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "371ef983c921e22e578f254551d2e64b1f1e6ad89661c9d7da9e0bd86a62c127",
"md5": "a735c90891ba1d0ad9d59baf39e73401",
"sha256": "07ab1080d08c9433436d0467ed2980c27559907cd21db4a7291823ccff1bed98"
},
"downloads": -1,
"filename": "collective.eeafaceted.batchactions-1.15.tar.gz",
"has_sig": false,
"md5_digest": "a735c90891ba1d0ad9d59baf39e73401",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43147,
"upload_time": "2024-04-10T06:53:27",
"upload_time_iso_8601": "2024-04-10T06:53:27.171169Z",
"url": "https://files.pythonhosted.org/packages/37/1e/f983c921e22e578f254551d2e64b1f1e6ad89661c9d7da9e0bd86a62c127/collective.eeafaceted.batchactions-1.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 06:53:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IMIO",
"github_project": "collective.eeafaceted.batchactions",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "collective.eeafaceted.batchactions"
}
JSON
