jquery.dynatree.js integration for Plone
Project description
Dynamic Tree-Widget for Plone
collective.dynatree provides the basic integration of the jQuery plugin jquery.dynatree.js (at google-code).
Optional it also provides a full-featured Archetypes Widget with full ATVocabularyManager support, including hierachical VDEX-vocabularies.
Installation
Just depend in your buildout on the egg collective.dynatree. ZCML is loaded automagically if z3c.autoinclude is available (default since Plone >=3.3).
Install it as an addon in Plone control-panel or portal_setup.
Usage
Plain Dynatree
This package only provides and registers the javascript in the site. Addon developers can use it then in their own templates. Please refer to the original documentation for usage of jquery.dynatree.js.
Archetypes Widget
The widget is meant to be used on a StringField (single selection) or on a LinesField (multi selection).
Example
StringField('single_leafs',
required=0,
vocabulary=NamedVocabulary('some_atvm_tree_vocabulary'),
widget=DynatreeWidget(
description="Select one option of tree. Only leafs allowed",
leafsOnly=True,
selectMode=1),
),
LinesField('multiple_all',
required=0,
vocabulary=NamedVocabulary('another_atvm_tree_vocabulary'),
widget=DynatreeWidget(
description="""Select multiple options of the tree. All selectable.
Starts with 2 levels expanded.""",
selectMode=3,
minExpandLevel=2),
),
Widget Parameters
(additional to the usal suspects of TypesWidget)
- selectMode
1=single, 2=multiple
- minExpandLevel
Number of levels which are not allowed to collapse; default=0.
- rootVisible
Wether a root node should be showed or not; default=False.
- autoCollapse
Automatically collapse all siblings, when a node is expanded; default=False.
- leafsOnly
Wether to select only leafs or allow also to select nodes with leafs; default=False.
- showKey
To show the terms key in front of the terms value set this to a format string like "%s: %s"; default=None.
Example-ContentType
An example ContentType is provided, but disabled by default. To enable it add collective.dynatree[example] to both, the eggs and zcml section in your buildout. Rerun buildout, restart Plone and install the jquery.dynatree EXAMPLE Content Types as an add-on product.
Source Code and Contributions
If you want to help with the development (improvement, update, bug-fixing, …) of collective.dynatree 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 of collective.dynatree are Jens Klein and Peter Holzer. We appreciate any contribution and if a release is needed to be done on pypi, please just contact one of us.
Contributors
Jens W. Klein <jens@bluedynamics.com>
Peter Holzer <hpeter@agitator.com>
Patrick Gerken provided initial idea+code with his package slc.treecategories
Changes
1.3.1 (2011-03-08)
css-registry merges css, so paths to skin were no longer relative. Adding the resource part helps here. jensens 2011-03-08
1.3 (2011-01-19)
upgraded jquery.dynatree from upstream to version 1.0.3. jensens 2011-01-19
added showKey property to at-widget to show terms key in front of the value. hpeter, jensens, 2011-01-18
1.2.1 (2010-12-03)
fighting with MANIFEST.in, to much was excluded and egg release broken. should now be better. jensens 2010-12-03
1.2 (2010-12-02)
after submit and validation error keep the previous selected values. jensens, 2010-12-02
1.1 (2010-11-29)
add MANIFEST.in, so *.rst gets included in the egg. jensens, 2010-11-29
make dict2dynatree more robust after report by Rigel Di Scala, jensens, 2010-11-29
1.0 (2010-11-22)
Make it work (jensens, hpeter)
License
Copyright (c) 2010, BlueDynamics Alliance, Austria All rights reserved.
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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
