Image Rendition with Cropping in AEM 6.2

"DAM Update Asset" is a default workflow which is triggered whenever any asset is uploaded into the DAM. This workflow helps to limit the size and the quality of the image displayed.

Why Image Renditions are required:

1. Using different size images on the websites.
2. Images for different devices or viewPort.
3. Reducing the page load time.

Existing Workflow Scenario:

Steps to create Custom Rendition:

• Go to the "DAM update asset" workflow
• Select "Process Thumbnails" Step.

Fig-  Select and edit the Process Thumbnail Step

• Add custom renditions as per your requirements

Fig - Add the Size of Rendition in Thumbnail Multifield

Cropping:

In the existing “DAM Update Asset” workflow image renditions are getting generated for different resolutions by resizing the images, but here cropping for the assets is not happening. However the need was to crop the image uniformly(top, bottom, left, right).
To achieve this, follow below steps:

• Add Custom process(Rendition Image Cropping) step after “Process Thumbnail”.
• Edit the Rendition Image Cropping process step.
• Select the Process Tab.
• Add the WorkFlow Process (Image Rendition Cropping Workflow Process).

Fig- Add the New  Process Step and Select the
Custom Image Rendition Workflow process in the Process Tab

• In the Process tab Configure the rendition size in Arguments field.

Fig- Configure The rendition size in the Arguments Section

Arguments: The custom workflow takes the arguments as input, fetch the original image size and crop the image from top, bottom, left and right.

Example: Let’s suppose the original size of image is "2200*1200" and the required image size is "640*360" .

• Reduce the image from left and right equally ( 780px) to make the width as 640.
• Reduce the image from top and bottom equally ( 420px) to make the height as 320.

Fig- Sample Image showing the cropping concept

Check the below code for Image Rendition Process:

	package com.aem.sgaem.project.process;
	import com.adobe.granite.workflow.WorkflowSession;
	import com.adobe.granite.workflow.exec.WorkItem;
	import com.adobe.granite.workflow.exec.WorkflowProcess;
	import com.adobe.granite.workflow.metadata.MetaDataMap;
	import com.aem.sgaem.project.services.ResourceResolverUtil;
	import com.aem.sgaem.project.utils.StringUtil;
	import com.day.cq.commons.ImageHelper;
	import com.day.image.Layer;
	import java.awt.Rectangle;
	import java.util.List;
	import javax.jcr.Node;
	import org.apache.felix.scr.annotations.Component;
	import org.apache.felix.scr.annotations.Property;
	import org.apache.felix.scr.annotations.Reference;
	import org.apache.felix.scr.annotations.Service;
	import org.apache.sling.api.resource.Resource;
	import org.apache.sling.api.resource.ResourceResolver;
	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;
	@Component(immediate = true, enabled = true, metatype = true)
	@Service(value = WorkflowProcess.class)
	@Property(name = "process.label", value = "Cropping Image Rendition Process", propertyPrivate = true)
	public class ImageRenditionProcess implements WorkflowProcess {
	private static final String PROCESS_ARGS = "PROCESS_ARGS";
	private static final String EMPTY = "";
	private static final String JCR_CONTENT = "/jcr:content";
	private static final String CQ5_DAM_THUMBNAIL = "cq5dam.thumbnail.";
	private static final String JPEG_EXTENSION = ".jpeg";
	private static final String JPEG_MIME_TYPE = "image/jpeg";
	private final Logger LOGGER = LoggerFactory.getLogger(ImageRenditionProcess.class);
	@Reference
	private ResourceResolverUtil resourceResolverUtil;
	private int requiredWidth;
	private int requiredHeight;
	private int originalWidth;
	private int originalHeight;
	private int cropWidth;
	private int cropHeight;
	/* This execute method crop the images as per the workflow Arguments */
	public void execute(WorkItem workItem, WorkflowSession workflowSession, MetaDataMap metaDataMap) {
	LOGGER.debug("START OF execute METHOD");
	ResourceResolver resourceResolver = resourceResolverUtil.getResourceResolver();
	String payload = workItem.getWorkflowData().getPayload().toString();
	String processArgument = metaDataMap.get(PROCESS_ARGS, EMPTY);
	Resource dataResource = resourceResolver.getResource(payload + JCR_CONTENT);
	if (dataResource != null) {
	Resource parentOfParentRes = getExactParent(dataResource, 2);
	if (parentOfParentRes != null) {
	Node node = parentOfParentRes.adaptTo(Node.class);
	if (node != null) {
	Double quality = 90.0;
	try {
	if (!EMPTY.equals(processArgument)) {
	List<String> args = StringUtil.splitWithNewLine(processArgument);
	for (String arg : args) {
	Layer originalLayer = ImageHelper.createLayer(dataResource);
	ImageHelper.saveLayer(getLayer(originalLayer, payload, arg), JPEG_MIME_TYPE,
	quality, node, CQ5_DAM_THUMBNAIL + arg + JPEG_EXTENSION, true);
	}
	}
	} catch (Exception exception) {
	LOGGER.error(exception.getCause().toString());
	} finally {
	resourceResolverUtil.closeResourceResolver(resourceResolver);
	}
	}
	}
	}
	LOGGER.debug("END OF execute METHOD");
	}
	private Layer getLayer(Layer layer, String payload, String size) {
	LOGGER.debug("START OF getLayer METHOD");
	String[] splitSize = size.split("\\.");
	requiredWidth = (EMPTY).equals(splitSize[0]) ? 0 : Integer.parseInt(splitSize[0]);
	requiredHeight = (EMPTY).equals(splitSize[1]) ? 0 : Integer.parseInt(splitSize[1]);
	originalWidth = layer.getWidth();
	originalHeight = layer.getHeight();
	requiredWidth = originalWidth > requiredWidth ? requiredWidth : originalWidth;
	requiredHeight = originalHeight > requiredHeight ? requiredHeight : originalHeight;
	cropWidth = originalWidth > requiredWidth ? (originalWidth - requiredWidth) / 2 : 0;
	cropHeight = originalHeight > requiredHeight ? (originalHeight - requiredHeight) / 2 : 0;
	if (originalWidth > requiredWidth || originalHeight > requiredHeight) {
	layer = cropImage(layer, payload);
	}
	LOGGER.debug("END OF getLayer METHOD");
	return layer;
	}
	private Layer cropImage(Layer layer, String payload) {
	LOGGER.debug("START OF cropImage METHOD");
	String rectCSV = "0,0," + (requiredWidth + cropWidth) + "," + (requiredHeight + cropHeight);
	Rectangle rect = ImageHelper.getCropRect(rectCSV, payload);
	layer.crop(rect);
	layer.rotate(180.00);
	rectCSV = "0,0," + requiredWidth + "," + requiredHeight;
	rect = ImageHelper.getCropRect(rectCSV, payload);
	layer.crop(rect);
	layer.rotate(180.00);
	LOGGER.debug("END OF cropImage METHOD");
	return layer;
	}
	private Resource getExactParent(Resource resource, int level) {
	for (int i = 0; i < level; i++) {
	resource = resource.getParent();
	}
	return resource;
	}
	}

view raw ImageRenditionProcess.java hosted with ❤ by GitHub

You can see all the renditions like this:

Fig - Renditions Created Under Dam Hierarchy

Demo Video:

        

You can install the package directly from here.
find the Git Repository

Mail us at sgaem.blog02@gmail.comg for any query or suggestion.

Hope it will help you guys !!👍

Thanks and Happy Learning 😊

Granite UI Jquery Validations in AEM 6.2

As a developer, I want AEM components to be author friendly, So that  authors can fill the dialog with proper validations and check.

To achieve this  in touch UI dialog, Jquery Validation plugins are the most preferable and widely used.

Use Case: I was having a dialog in which i was enabling two fields Contact Us Message and Time only when author enters the mobile Number.

If author don’t enter anything in mobile no. field then both the fields will remain disabled.

How to achieve it:

1.Add a property validation in mobile,  contact us message and time widget. This property will be use as a selector in jquery.

Fig- Adding the validation property in the widget

2.Now with the help of selector  ,the plugin is getting registered. Registering custom validators is done by calling the jQuery based $.validator.register method.

$.validator.register({
   selector: "form [data-validation='cq-dialog-mobileNo']",
   clear: function(el) {
       var mobileMessage = $("form [data-validation='cq-dialog-mobileMessage']");
       var time = $("form [data-validation='cq-dialog-time']");
       if (el.val() != "") {
           mobileMessage.attr('disabled', false);
           time.attr('disabled', false);
       } else {
           mobileMessage.attr('disabled', true);
           time.attr('disabled', true);
       }
   }
});

Through this validator, when author enters  mobile Number, it enables or disable rest of the fields.

Now there is also a problem that when content loaded, it is not showing the appropriate behaviour , because the above validation only works when there are some changes on mobileNumber field.

For Solving this issue, there is a need of calling clear() method when content is getting loaded.

/* call mobile tab validators on content loaded */

$(document).on("foundation-contentloaded", function(e) {

/* updateErrorUI is used to called clean method of validator */
   $("form [data-validation='cq-dialog-mobileNo']").updateErrorUI();
}

Fig- Before enter the mobile number all field disabled

After entering the mobile number all field become enabled

Fig- After enter the mobile number all field become enable

In this example,one more tab E-Mail exists, in which email-id is disabled when email message is given.

You can find code for the same also while downloading the package.
Demo Package Install

If you have any query or suggestion then kindly comment or mail us at sgaem.blog02@gmail.com.

Hope it will help you guys !!👍

Thanks and Happy Learning 😊

Custom Color Picker with Drop Down Menu in AEM 6.2

Hi All,

Dropdown widget having loads of color options which can be selected… it was really a mess to remember those names.

As a developer, I was wondering why author just can’t select the name and configure it…..

Color-picker is definitely not a solution as we wanted to show the restricted number of colors…

Fig- Drop-down with color name options

Finally, we got a better solution for this and gave the background color for drop-down menu option and it resolved the complexity…

Let's see how to achieve this:

1.Add a class "bgColor" on highlighted node of drop-down.

Fig-  Add the class "bgColor" on selected node

2. Create node /apps/aem-learning/components/content/colorPicker/colorPickerClientLib of type cq:ClientLibraryFolder and add a String property categories with value cq.authoring.dialog.

3.Create file (nt:file) /apps/aem-learning/components/content/colorPicker/colorPickerClientLib/js.txt  and add the following js files:

• drop-down.js
• colorPicker.js

drop-down.js

 $(document).on("click", ".bgColor ul", function(e) {  
   touchDialog.colorDropDown();  
 });  
 $(document).on("foundation-contentloaded", function(e) {  
   touchDialog.colorDropDown();  
 });  

colorPicker.js

 var touchDialog = {  
   colorDropDown : function() {  
     var dropdown = $('.bgColor ul');  
     var button = $('.bgColor button');  
     var childlist = dropdown.children();  
     if (childlist.length > 1) {  
       for (i = 0; i < childlist.length; i++) {  
         var attr = childlist[i].getAttribute("data-value");  
         if (attr) {   
           $(childlist[i]).css("background-color", attr);  
           $(childlist[i]).css("border-style", "solid");  
         }  
         if($(childlist[i]).hasClass("is-highlighted")&& attr){  
           $(button).css("background-color", attr);  
         }  
         if(!attr)  
           $(button).css("background-color", "transparent");  
       }  
     }  
   }  
 };  

Fig- Drop-down with background-color on Values

Demo Package Install

If you have any query or suggestion then kindly comment or mail us at sgaem.blog02@gmail.com.

Hope it will help you guys !!👍

Thanks and Happy Learning 😊

Override/Overlay Dam Asset Metadata in AEM 6.2

Use Case: Recently I have gone through a scenario. In which i want to change the dam asset properties and want to add a new widget as well.

This image depicts the default touch ui dialog available for dam asset properties. Now I want to change/add a rootPath for tags so that i can select tags from specific hierarchy only.

This Default dialog comes from “/libs/dam/content/schemaeditors/forms/default”. But According  to the AEM Best Practice we never do any change in /libs hierarchy.

Fig: DAM Asset Property Dialog

Now I thought about below concepts:

• I have tried to do that using Resource Merger, but it didn’t work.
  

• After that I have tried same using Overlay the complete hierarchy in /apps but it also didn’t work.

Solution:

In AEM 6.2 the correct way to do this is through  "metadata schema".To add/change the properties for a dam asset properties, use a custom metadata schema form or modify an existing form. So I decided to go for modifying an existing form.

Below Steps we need to follow:

Step 1: Go to Projects.html  .

Step 2: Click on Adobe Experience Manager

Step 3: Go to Tools and click on Assets.

Step 4: Click on Metadata Schema

Step 5:  Select Default and go to edit.

Step 6: In this Edit Form, you can see all the fields available in metadata dialog.

Fig: Modifying Existing Form
Step 7: In the url query parameter , you can see "formpath=/conf/global/settings/dam/adminui-extension/metadataschema"

Now just change some title in dialog suppose test title and check it in the same path.

Fig: Add/Change Properties inConf Hierarchy in CRX

Now i just add the property rootPath in my tags node and when i go for any image /asset metadata.

I am able to see the title to Test Title.

Fig: Updated Dialog After Modification

And when i  click on tags ,I can find tags  available under /etc/tags/forum.

Fig: Updated the root path for Tag widget

So This was the solution of above problem.

If you have any query or suggestion then kindly comment or mail us at sgaem.blog02@gmail.com.

Hope it will help you guys !!👍

Thanks and Happy Learning 😊

.