bda.plone.ajax

bdajax integration for Plone.

These details have been verified by PyPI

Maintainers

hpeteragitator jensens petschki rnix

These details have not been verified by PyPI

Project links

Homepage

Project description

Integration package

This is the plone integration package for bdajax.

Installation

Make egg available in your instance.
Apply extension profile.

Implement ajax action as browser view

An ajax action can be implemented as simple browser view. The easiest way is to render a template only. Create template tile_a.pt:

<div xmlns:ajax="http://namesspaces.bluedynamics.eu/ajax" tal:omit-tag="">

  <!-- the tile -->
  <div class="tile_a"
       style="background-color:#ffc261;">

    <h3>I am tile A</h3>

    <!-- perform action directly. here we render tile_b, see below -->
    <a href=""
       ajax:bind="click"
       ajax:action="bdajax_example_tile_b:.tile_a:replace"
       ajax:target=""
       tal:attributes="ajax:target context/absolute_url">alter me</a>

  </div>

</div>

Configure via ZCML:

<browser:page
  for="*"
  name="bdajax_example_tile_a"
  template="tile_a.pt"
  permission="zope2.View" />

Implement ajax action as content provider

Create a template tile_b.pt containing the markup:

<div xmlns:ajax="http://namesspaces.bluedynamics.eu/ajax" tal:omit-tag="">

  <!-- bind custom event to tile, perform action if event triggered -->
  <!-- when event gets triggered, tile_a gets rendered, see above -->
  <div class="tile_b"
       style="background-color:#61ff68;"
       ajax:bind="altertile"
       ajax:action="bdajax_example_tile_a:.tile_b:replace">

    <h3>I am tile B</h3>

    <!-- bind element to click event and trigger custom event -->
    <a href=""
       ajax:bind="click"
       ajax:event="altertile:.tile_b"
       ajax:target=""
       tal:attributes="ajax:target context/absolute_url">alter me</a>

  </div>

</div>

Create content provider in provider.py:

from Acquisition import Explicit
from zope.interface import (
    Interface,
    implementer,
)
from zope.component import adapter
from zope.publisher.interfaces.browser import (
    IBrowserRequest,
    IBrowserView,
)
from zope.contentprovider.interfaces import IContentProvider
from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
from bda.plone.ajax import ajax_message


@implementer(IContentProvider)
@adapter(Interface, IBrowserRequest, IBrowserView)
class Provider(Explicit):
    template = ViewPageTemplateFile(u'tile_b.pt')

    def __init__(self, context, request, view):
        self.__parent__ = view
        self.context = context
        self.request = request

    def update(self):
        pass

    def render(self):
        # set here continuation message. See bda.plone.ajax.__init__ for
        # details.
        ajax_message(self.request, 'Demo continuation message', flavor='info')
        return self.template(self)

Configure provider via ZCML:

<adapter
  name="bdajax_example_tile_b"
  provides="zope.contentprovider.interfaces.IContentProvider"
  factory=".provider.Provider" />

Implement a wrapper view

The two ajax action rendering snippets above each render a tile only. now we need to wrap this inside a plone view. Create template ploneview.pt:

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
      xmlns:tal="http://xml.zope.org/namespaces/tal"
      xmlns:metal="http://xml.zope.org/namespaces/metal"
      xmlns:i18n="http://xml.zope.org/namespaces/i18n"
      lang="en"
      metal:use-macro="here/main_template/macros/master">
<body>

  <metal:main fill-slot="main">
    <tal:main-macro metal:define-macro="main">

      <tal:tile replace="structure context/@@bdajax_example_tile_a" />

    </tal:main-macro>
  </metal:main>

</body>
</html>

And register via ZCML:

<browser:page
  for="*"
  name="bdajax_example_view"
  template="ploneview.pt"
  permission="zope2.View" />

Now start instance and navigate to @@bdajax_example_view. You get initially tile a rendered switching to tile b on click and vise versa. This code equates the one contained in examples folder.

Implement an ajax form

Create a view which renders a form.

Create template named ajaxform.pt. The attribute ajax:form tells bdajax to handle this form:

<form xmlns:ajax="http://namesspaces.bluedynamics.eu/ajax"
      id="example_ajaxform"
      method="post"
      enctype="multipart/form-data"
      ajax:form="True"
      tal:define="error view/error"
      tal:attributes="action view/form_action">

  <label for="field">Field</label>

  <div tal:condition="error"
       tal:content="error"
       style="font-weight:bold;color:red;">
    Error Text
  </div>

  <input type="text"
         name="field"
         tal:attributes="value view/value" />

  <input type="submit" name="submit" value="Submit" />

</form>

Create the view class:

from Products.Five import BrowserView
from bda.plone.ajax import ajax_continue
from bda.plone.ajax import ajax_form_fiddle
from bda.plone.ajax import AjaxMessage


class AjaxForm(BrowserView):

    @property
    def form_action(self):
        return 'ajaxform?form_name=bdajax_example_form'

    @property
    def submitted(self):
        return 'field' in self.request.form

    @property
    def error(self):
        if not self.submitted:
            return
        if not self.request.form['field']:
            return u'Field must not be empty'

    @property
    def value(self):
        return self.request.form.get('field')

    def __call__(self):
        if self.submitted and not self.error:
            ajax_continue(self.request, AjaxMessage('Success!', 'info', None))

<browser:page
  for="*"
  name="bdajax_example_form"
  class=".AjaxForm"
  template="ajaxform.pt"
  permission="zope2.View" />

Create wrapper view for form named ajaxformview.pt:

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
      xmlns:tal="http://xml.zope.org/namespaces/tal"
      xmlns:metal="http://xml.zope.org/namespaces/metal"
      xmlns:i18n="http://xml.zope.org/namespaces/i18n"
      lang="en"
      metal:use-macro="here/main_template/macros/master">
<body>

  <metal:main fill-slot="main">
    <tal:main-macro metal:define-macro="main">

      <tal:tile replace="structure context/@@bdajax_example_form" />

    </tal:main-macro>
  </metal:main>

</body>
</html>

And register via ZCML:

<browser:page
  for="*"
  name="bdajax_example_form_view"
  template="ajaxformview.pt"
  permission="zope2.View" />

Now start instance and navigate to @@bdajax_example_form_view.

Implement ajax batch

Create a batch implementation in python, i.e. examplebatch.py calculating batch vocab:

from Products.Five import BrowserView
from bda.plone.ajax.batch import Batch


RESULTLEN = 45
SLICESIZE = 10


class ExampleBatch(Batch):
    batchname = 'examplebatch'

    @property
    def vocab(self):
        ret = list()
        # len result
        count = RESULTLEN
        # entries per page
        slicesize = SLICESIZE
        # number of batch pages
        pages = count / slicesize
        if count % slicesize != 0:
            pages += 1
        # current batch page
        current = self.request.get('b_page', '0')
        for i in range(pages):
            # create query with page number
            query = 'b_page=%s' % str(i)
            # create batch target url
            url = '%s?%s' % (self.context.absolute_url(), query)
            # append batch page
            ret.append({
                'page': '%i' % (i + 1),
                'current': current == str(i),
                'visible': True,
                'url': url,
            })
        return ret

Create batched result view:

class BatchedResult(BrowserView):

    @property
    def batch(self):
        return ExampleBatch(self.context, self.request)()

    @property
    def slice(self):
        result = range(RESULTLEN)
        current = int(self.request.get('b_page', '0'))
        start = current * SLICESIZE
        end = start + SLICESIZE
        return result[start:end]

Create batched result template, i.e. batchedresult.pt:

<div xmlns="http://www.w3.org/1999/xhtml"
     xml:lang="en"
     xmlns:tal="http://xml.zope.org/namespaces/tal"
     xmlns:i18n="http://xml.zope.org/namespaces/i18n"
     i18n:domain="bda.plone.ajax"
     class="examplebatchsensitiv"
     ajax:bind="batchclicked"
     tal:attributes="ajax:target context/absolute_url;
                     ajax:action string:bdajax_example_batched_result:.examplebatchsensitiv:replace">

  <tal:listingbatch replace="structure view/batch" />

  <ul>
    <li tal:repeat="item view/slice" tal:content="item">x</li>
  </ul>

  <tal:listingbatch replace="structure view/batch" />

</div>

Create wrapper view, i.e. batchview.pt:

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
      xmlns:tal="http://xml.zope.org/namespaces/tal"
      xmlns:metal="http://xml.zope.org/namespaces/metal"
      xmlns:i18n="http://xml.zope.org/namespaces/i18n"
      lang="en"
      metal:use-macro="here/main_template/macros/master"
      i18n:domain="bda.plone.ajax">
<body>

  <metal:main fill-slot="main">
    <tal:main-macro metal:define-macro="main">

      <tal:tile replace="structure context/@@bdajax_example_batched_result" />

    </tal:main-macro>
  </metal:main>

</body>
</html>

And register views via ZCML:

<browser:page
  for="*"
  name="bdajax_example_batch"
  template="batchview.pt"
  permission="zope2.View" />

<browser:page
  for="*"
  name="bdajax_example_batched_result"
  class=".examplebatch.BatchedResult"
  template="batchedresult.pt"
  permission="zope2.View" />

Now start instance and navigate to @@bdajax_example_batch. You get an example result rendered batched. This code equates the one contained in examples folder.

Examples

This package ships with examples, as explained above. To enable examples include bda.plone.ajax.examples via ZCML.

Source Code

If you want to help with the development (improvement, update, bug-fixing, …) of bda.plone.ajax this is a great idea!

The code is located in the github collective.

You can clone it or get access to the github-collective and work directly on the project.

Maintainers are Robert Niederreiter and the BlueDynamics Alliance developer team. We appreciate any contribution and if a release is needed to be done on pypi, please just contact one of us: dev@bluedynamics dot com

Contributors

Robert Niederreiter (Autor)
Jens W. Klein

Changes

2.0.1 (2024-04-17)

Use Python expressions instead of TALES in batch.pt. [jensens]
Update condition for jQuery overlay resources and adjust depends for bdajax resources. [petschki]

2.0 (2019-03-10)

Drop Plone 4 support (Needs 5.1+). [agitator]
Add Python 3 support. [agitator]
Minimal custom jquerytools with overlay added, no more dependency on plone.app.jquerytools. [agitator]

1.8 (2019-02-08)

Depend on Products.CMFPlone instead of Plone to not fetch unnecessary dependencies. [thet]
Check whether child is null before searching for elements by tag name in ajax form response. [rnix]
Adopt to bdajax 1.10. [rnix]

1.7 (2017-03-10)

Add _authenticator hidden field when rendering ajax forms in order to make CSRF protection work properly. [rnix]
Plone 5 Update, registered as legacy bundle [agitator, rnix]

1.6 (2015-06-25)

give ajaxaction response explicit Content-Type: application/json [jensens, 2015-06-25]
log formerly catched and hidden exceptions with severity error to error log. [jensens, 2015-06-25]
Disable diazo theming in ajaxaction and ajaxform browser views. [rnix, 2014-12-10]
Add AjaxPath continuation. Can be used as of bdajax 1.6. [rnix, 2014-12-10]

1.5

Add ajaxform convenience browser page. [rnix, 2014-02-04]

1.4

Cleanup docs. [rnix, 2013-10-21]
Do not load examples by default. [rnix, 2013-10-21]
Add abstract batch for buidling ajax batches. [rnix, 2013-10-20]

1.3

Provide overlay configuration. [rnix, 2012-08-06]
Provide form continuation. [rnix, 2012-08-06]

1.2.2

render viewlet in IPortalTop, so it pops up centered and not at the end of the site. [jensens, 2011-12-02]
add z3c.autoinclude entry point. [jensens, 2011-12-02]

1.2.1

display bdajax.message with traceback if ajaxaction throws uncaught exception. [rnix]

1.2

add ajax continuation support and continuation helper objects and functions. [rnix]

1.1

add examples. [rnix]
add ajaxaction view. [rnix]

1.0

make it work. [rnix]

License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the BlueDynamics Alliance nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY BlueDynamics Alliance AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BlueDynamics Alliance BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Project details

These details have been verified by PyPI

Maintainers

hpeteragitator jensens petschki rnix

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

This version

2.0.1

Apr 17, 2024

2.0

Mar 10, 2019

1.8

Feb 8, 2019

1.7

Mar 10, 2017

1.6

Jun 25, 2015

1.5

Feb 4, 2014

1.4

Oct 29, 2013

1.3

Oct 7, 2012

1.2.2

Dec 2, 2011

1.2.1

Sep 21, 2011

1.2

Jun 3, 2011

1.1

Jan 14, 2011

1.0

Jul 1, 2010

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bda.plone.ajax-2.0.1.tar.gz (27.6 kB view hashes)

Uploaded Apr 17, 2024 Source

Built Distribution

bda.plone.ajax-2.0.1-py3-none-any.whl (32.3 kB view hashes)

Uploaded Apr 17, 2024 Python 3

Hashes for bda.plone.ajax-2.0.1.tar.gz

Hashes for bda.plone.ajax-2.0.1.tar.gz
Algorithm	Hash digest
SHA256	`adc2410ab3cebe93c5116529b042c44da5b19b8055f838dace71946576a682e7`
MD5	`8a26d00a281283443c04e619146b822f`
BLAKE2b-256	`9d9190a918425d2838d34d698670f59b21601a7ecfd140ca090dc28e1c86052d`

Hashes for bda.plone.ajax-2.0.1-py3-none-any.whl

Hashes for bda.plone.ajax-2.0.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`026ff8479933004aea6f998b2e1ef8a319a8ba80bf87739aa7e5361de2c774e3`
MD5	`6ea0b7129f9d26e26c3ca81d368edfc7`
BLAKE2b-256	`c21116d60a5ad47c623485a1779b2fa350aa0a3b0581bb91d99de183ad44ee35`

bda.plone.ajax 2.0.1

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

Integration package

Installation

Implement ajax action as browser view

Implement ajax action as content provider

Implement a wrapper view

Implement an ajax form

Implement ajax batch

Examples

Source Code

Contributors

Changes

2.0.1 (2024-04-17)

2.0 (2019-03-10)

1.8 (2019-02-08)

1.7 (2017-03-10)

1.6 (2015-06-25)

1.5

1.4

1.3

1.2.2

1.2.1

1.2

1.1

1.0

License

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distribution