archetypes.clippingimage 2.0

Image field and/or patch with clipping support for Plone/Archetypes.

Introduction

Image field for Archetypes with different behavior at time of scaling.

Archtypes default ImageField scales down the image until the whole image fits into the given scale. It keeps it aspect ratio. I.e. scaling down a 400x300 image to a 200x200 scale result in a 200x150 image.

Same with ClippingImageField results in a 200x200 image! It centers the image horizontal or vertical and tries to keep as much as possible from the original.

Tested with Plone 3.3.x and Plone 4.

Usage:

Field

Specify the sizes as documented for the classic Archetypes ImageField. If you want specific scales to get clipped, add a field-property crop_scales=['image_large','other_scale']. It expects a list of scale names to include into clipping.

Patch

By including patch.zcml in your package archetypes.clippingimage will patch Products.Archetypes.Field.ImageField so it is able to generate cropped scales.

You can define which scales shall be cropped by adding a property crop_scales to your ImageField:

ImageField('image',
    sizes= {'large'   : (768, 768),
            'preview' : (400, 400),
            'listing' :  (16, 16),
            },
    crop_scales = ['listing'],
    ...

Note that if you want to use clipped images within ATCTImage and have plone.app.imaging installed you need to set a property crop_scales at plone.app.blob.subtypes.image.SchemaExtender.fields[0].

Blob

In case of using the patch everythings fine. No further action needed. If you use the field, you need to include the blob.zcml to make the fields scales blobs.

Copyright

written by Jens W. Klein, BlueDynamics Alliance, Klein & Partner KG, Austria http://bluedynamics.com

Contributions Harald Friessnegger and Peter Holzer.

Changelog

2.0

• make plone.app.imaging and plone.app.blob aware. Works now with Plone 4. [jensens]

• sizes can be a callable or a dictionary (instance method not supported)

  background: plone.app.imaging uses the sizes defined in imaging_properties in case sizes is a dictionary. so you need to define sizes via a callable to make your custom sizes take effect. [fRiSi]

• added monkeypatch for ImageField.scale to add croppingsupport to any ImageField [jensens, fRiSi]

License

Copyright (c) 2008-2009, 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.