Skip to main content

A reference browser widget (Maintainer Timon Tschanz)

Project description

ftw.referencewidget

This Widget provides a Referencebrowser and a searchfield, which allows users to select references.

The basequery is all types which are not in the types_not_searched property all modification to the allowed types are relative to this query.

Traversal or Selectability can be changed for all widgets with the IReferenceSettings registry interface or per widget with the widget parameters.

The widget takes the following parameters:
  • allow_traversal: List of Types which are added as traversable. Will act as complete configuration if override is set to True.
  • block_traversal: List of Types which are added as not traversable. Will be ignored if override is set to True.
  • selectable: List of Types which are added to the as selectable. Will act as complete configuration if override is set to True
  • nonselectable: List of Types which are added as not selectable. Will be ignored if override is set to True.
  • start: The path first opened. Can either be a callable or a path. Additionaly the strings “parent”, “navroot”, “ploneroot” can be used.
  • allow_nonsearched_types: If this is set to true all the types will be traversable and selectable.
  • override: Drops all global config and the base query if a list is passed to the widget. If this is set to true, selectable & allow_traversal are not additive but act as the complete configuration instead. nonselectable & block_traversal will be ignored.
  • traversal_query: Updates the query used vor traversing by the given dict. The dict passed will be updated after everything is allready done. So make sure not to override sort_on/sort_order attributes.

ContextSourceBinder

With a RelationeChoice or RelationList of RelationChoice a source can be configured along with the field. The ContextSourceBinder makes sure that only valid content can be selected.

By default, the source binder only checks for a valid portal_type when selecting content.

The default_filter implementation therefore looks like this:

def default_filter(source, value):
    """"
    Return ``True`` when the object is selectable, ``False``
    when it is not selectable.

    """"
    return value.portal_type in get_selectable_types_by_source(source)

Feel free to add your own filter method as source parameter in your field. Example:

from ftw.referencewidget.filter import DefaultSelectable

class CustomClass(DefaultSelectable):
    def is_selectable(self):
        return bool(..)
...

directives.widget(realtionchoice_restricted_title=ReferenceWidgetFactory)
realtionchoice_restricted_title = RelationChoice(
    title=_(u'Related Choice Restricted Title'),
    source=ReferenceObjSourceBinder(
        selectable_class=CustomClass),
    default=None,
    required=False,
)

The filter takes two parameter the actual source object and a value, which is the content object.

Only ReferenceObjSourceBinder are supported. The SourceBinder takes the following parameters:

  • selectable: Adds these types as selectable. Will act as complete configuration if override is set to True
  • nonselectable: Adds these Types are not selectable. Will be ignored if override is set to True.
  • allow_nonsearched_types: If this is set to true all the types will be traversable and selectable.
  • override: Drops all global config and the base query if a list is passed to the widget. If this is set to true, selectable is not additive but acts as the complete configuration instead. nonselectable will be ignored.
  • selectable_class: Custom ISelectable Class to determine if a content is selectable or not.

The parameters are same as for the widget (Backwards compatibility with 1.x releases).

Fields combinations (Registered converter)

The following combinations are supported:

  • RelationList with value_type Relation –> Stores a List of RelationValues
  • RelationList with value_type RelationChoice –> Stores a List of RelationValues
  • Relation –> Stores a RelationValue
  • List of RelationChoice –> Stores a list of absolute paths, without the portal root part
  • TextLine –> Stores a absolute path as string, without the portal root part

Changelog

1.5.4 (2018-01-26)

  • Fix UnicodeDecodeError. [mbaechtold]

1.5.3 (2017-11-24)

  • No longer use “plone.directives.form”. [mbaechtold]
  • Fix an issue when loading a page with GridDataField turns out in a error [Nachtalb]

1.5.2 (2017-10-23)

  • Fix display issue with search current path only in old chrome browsers. [mathias.leimgruber]

1.5.1 (2017-10-23)

  • Fix searching for current path only. [mathias.leimgruber]
  • Fix UniCodeDecodeError while displaying the news date. [mathias.leimgruber]

1.5.0 (2017-10-23)

  • Add option to search in current path. [Nachtalb]
  • Show localized news date in title for all news items [Nachtalb]

1.4.2 (2017-08-29)

  • Bugfix for DataGridField support if Plone Site is inside a mount point. [mbaechtold]

1.4.1 (2017-08-08)

  • Add support for “collective.z3cform.datagridfield”. [mbaechtold]

1.4.0 (2017-07-07)

  • Implement display mode for the reference widget. [mathias.leimgruber]
  • Change name of sample content buildour registry entry to avoid conflicts. [mathias.leimgruber]
  • Implement path restriction option. [mathias.leimgruber]
  • Render hidden input elements for given references, instead of render them only by Javascript. This way the widget behaves more like all other plone widgets. [mathias.leimgruber]
  • Implement a additional traversal_query parameter for the widget. [mathias.leimgruber]
  • Implement ReferenceObjPathSource for IRelationChoice fields. [mathias.leimgruber]

1.3.0 (2016-11-09)

  • Implement some sort options. [mathias.leimgruber]
  • Use plone.app.redirector to follow renamed and moved content. Also do not fail if the content has been removed. [mathias.leimgruber]

1.2.3 (2016-10-18)

  • Fix edge case (mainly for tests) if the value passed to the IList/Widget converter is not a list, but a string. [raphael-s]

1.2.2 (2016-10-18)

  • Implement testbrowser widget. [raphael-s]

1.2.1 (2016-10-17)

  • Respect missing_value set by the field. [tschanzt]
  • Implement support for ITextLine only with ReferenceWidget. [mathias.leimgruber]

1.2.0 (2016-10-04)

  • Show absolute path starting at the plone root for the selected value. [mathias.leimgruber]
  • Remove the list style type and the obsolete spacing for the selected elements. [mathias.leimgruber]
  • Implement support for IList of IRelationChoice explicitly. Check Readme for more informations [mathias.leimgruber]

1.1.0 (2016-09-27)

  • Ignore empty value for multiple value field. [mathias.leimgruber]
  • Support chameleon by not rendering handlebar templates. [jone]

1.0.4 (2016-09-19)

  • Make it possible to remove an given internal reference (radio button). [mathias.leimgruber]
  • Ignore empty value for single value field. [mathias.leimgruber]
  • Fix search by pressing the “enter” button. [mathias.leimgruber]
  • Always unbind the click event before binding a new one on the ref button. [mathias.leimgruber]

1.0.3 (2016-09-14)

  • Same as 1.0.2 but uploaded to PyPI. [mbaechtold]

1.0.2 (2016-09-14)

  • Reload Items when overlay is reloaded. [tschanzt]
  • Respect Type constraints on search. [tschanzt]

1.0.1 (2016-09-09)

  • Ignore empty strings in converter. [tschanzt]
  • Improve overlay behavior (close on click outside the overlay + close on ESC). [mathias.leimgruber]
  • Get Widget name on overlay creation. [tschanzt]

1.0.0 (2016-09-07)

  • Initial release [tschanzt]

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
ftw.referencewidget-1.5.4.tar.gz (611.8 kB) Copy SHA256 hash SHA256 Source None Jan 26, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page