Generally we used to copy and paste the dialog and doesn’t understand the meaning of these attributes.
Here I am going to explain some of the page properties of dialog which are very useful.
So I am going to walk you through with each and every property in a detailed manner.
1.cq:showOnCreate :
As classic UI is soon going to be deprecated from AEM, and we have started using touch UI for page Creation.
When author create a page from sites, this needs to be notice that only two tabs are visible in the page properties dialog here.
Fig - Page Properties Dialog at the time page creation
Now the question comes that why only two tabs visible here while in the page properties dialog there are many tabs.The tabs/widgets are not visible in the dialog right now ,because if you see in the page properties dialog these tabs are having the property cq:showOnCreate as false.
So this property cq:showOnCreate plays a very important roles to show tabs or widgets at the time of page creation. That’s why if you want to author some fields at the time of page creation only, Just add this property with the value true in the tab /widget node.The default value of cq:showOnCreate is true.
Fig - showOnCreate property added in tab node of the dialog
2.cq:hideOnEdit: While editing the page, if you want to hide any property from the page properties dialog ,set this value of cq:hideOnEdit as true.
The default value of cq:hideOnEdit is false.
Fig - hideOnEdit property added in widget node of the dialog
Note: If you want to show any widget/tab at the time of page creation and at the time of edit you want to hide it, you can use a combination of cq:showOnCreate(as true) and cq:hideOnEdit(true).
3.allowBulkEdit : Sometimes many pages want to share same value of a widget(field).So there is no need to go to each and every page individually and change the property. Let suppose author want some tags to be shared across multiple pages. You can select more than one pages from the sites console and edit the property at all pages. This property enables the fields for bulk editing.
You can only bulk edit the pages:
Share the same resourceType
Are on part of live copy
Fig - allowBulkEdit property added in widget node of the dialog
4.cq-msm-lockable: One of the features built into AEM MSM is the ability to determine which properties of a page are inherited (“rolled out” in AEM terms) from the master site to its child sites (live copies).
Fig - cq-msm-lockable property added in widget node of the dialog
Fig - cq:LiveConfig node added under the live copy
How this property works:
1. This property will create the chain link in the dialog which indicates that these values will be fetched from the master copy.
Note: If the value is not present in the master copy, it will pick its own value.
2. This can be edited if inheritance from the master copy has been cancelled.
When cq-msm-lockable has been defined, breaking/closing the chain will interact with MSM in the following way:
The value of cq-msm-lockable can be relative and absolute.
a)Relative (e.g. myProperty or ./myProperty)
It will add and remove the property from cq:propertyInheritanceCancelled.
MSM does not operate with deep properties (e.g. ./image/fileReference), even though the dialog’s logic does. If the chain is opened a rollout of the page will overwrite ./image/fileReference, as the rollout of the image node will not "walk" up to the parent node to check cq:propertyInheritanceCancelled.
Fig - Properties in case of relative path when inheritance cancelled
Breaking the chain will cancel inheritance by adding the cq:LiveSyncCancelled mixin to ./myProperty and setting cq:isCancelledForChildren to true.
Closing the chain will revert inheritance.
Fig - Properties in case of absolute path when inheritance cancelled
NOTE : When you re-enable inheritance, the live copy page property is not automatically synchronized with the source property. You can manually request a synchronization (rollout configuration) if this is required.
Demonstration Video On Properties of Page Properties Dialog:
If you have any query or suggestion then kindly comment or mail us at sgaem.blog02@gmail.com
SlingQuery is a sling resource tree traversal tool inspired by thejQueryJavaScript API.
Sling Query is a bundle which is not a part of AEM Felix console till now, but after knowing the bright side of this particular bundle,I am surprised that why it is not the part of AEM. But not to worry, we can do it by ourselves and take the advantages of it.
We can directly upload this bundle in the Felix console and add the dependency in pom.xml
2).children() : fetch all the child resources of a resource.
$(resource).listChildren();
3) .children(String filter): To iterate the children of a resource of particular resource type(here cq:Page) or any other filter condition.
$(resource).children(“cq:Page”);
$(resource).children(“cq:Page[jcr:title=test]”);
4) .closest(String selector): The closest applies on the ancestors of the resource with all the conditions.First it will check the parent of the resource ,than its parents and it will keep on going.
$(resource).closest(“cq:Page”)
5).eq(int index): Sling Query returns a iterator. If there is a need of getting the resource on the basis of index, this function is important.
$(resource).listChildren(“cq:Page”).eq(0);
6).filter(String selector): Filter given collection based on some selector.
final Calendar someTimeAgo = Calendar.getInstance(); someTimeAgo.add(Calendar.HOUR, -5); // get children pages modified in the last 5 hours SlingQuery query = $(resource).children("cq:Page").filter(new Predicate<Resource>() {@Override public boolean accepts(Resource resource) { return resource.adaptTo(Page.class).getLastModified().after(someTimeAgo); }});
7) .has(String selector): If the collection has the particular resource based on the selector.
// If the resource fetch all its children having a property value as foundation/components/redirect”
10).find():search through the matched elements’ child, grandchild, great-grandchild…any levels down.For each resource in collection return all its descendants using selected strategy. Please notice that invoking this method on a resource being a root of a large subtree may and will cause performance problems.
//the resource finds all the richtext resources which can be find in the children,sub-children of the resource
$(resource).find(foundation/components/richtext);
11).next():
// If a resource is having child1, child2 and child3,child2 will be returned.
$(resource).children().first().next();
12).nextAll():
// If a resource is having child1, child2, child3 and child4, child2, child3 and child4 will be returned.
$(resource).children().first().nextAll();
13).nextUntil():Return all following siblings for each resource in the collection up to, but not including, resource matched by a selector.
// let's assume that resource have 4 children: child1, child2, child3 and child4 additionaly, child4 has property jcr:title=Page
15).parents:For each element in the collection find all of its ancestors, optionally filtering them by a selector.
//create page breadcrumbs for the given resource
$(resource).parents(“cq:Page”);
16) .parentsUntil():For each element in the collection find all of its ancestors until a resource matching the selector is found.
// It will not include that resource which satisfies the condition of cq:page.
$(resource).parentsUntil(“cq:Page”);
17).prev():Return the previous sibling for each resource in the collection and optionally filter it by a selector. If the selector is given, but the sibling doesn't match it, empty collection will be returned.
// let's assume that resource have 3 children: child1, child2 and child3
18).prevAll():Return all preceding siblings for each resource in the collection, optionally filtering them by a selector.
// let's assume that resource have 3 children: child1, child2 and child3 $(resource).children().last().prevAll(); // return child1 and child2
19).prevUntil():Return all preceding siblings for each resource in the collection up to, but not including, resource matched by a selector.
// let's assume that resource have 4 children: child1, child2, child3 and child4 // additionally, child1 has property jcr:title=Page $(resource).children().last().prevUntil("[jcr:title=Page]"); // return child2 and child3
20).siblings():Return siblings for the given resources, optionally filtered by a selector.
$(resource).closest("cq:Page").siblings("cq:Page"); // return all sibling pages
$(resource).children("cq:Page").first().siblings();// return all sibling of first child page
21).slice():Reduce the collection to a sub-collection specified by a given range. Both from and to are inclusive and 0-based indices. If the to parameter is not specified, the whole sub-collection starting with from will be returned.
// let's assume that resource have 4 children: child1, child2, child3 and child4 $(resource).children().slice(1, 2); // return child1 and child2
22).searchStrategy():Select new search strategy, which will be used in following find() and has() function invocations. There 3 options:
SearchStrategy.QUERY - use JCR SQL2 query (default since 1.4.0)
DFS and BFS iterate through descendants using appropriate algorithm. QUERY strategy tries to transform SlingQuery selector into a SQL2 query and invokes it. Because there are SlingQuery operations that can't be translated (eg. :has() modifier), the SQL2 query result is treated as an initial collection that needs further processing.
23).first():Filter resource collection to the first element. Equivalent to .eq(0) or .slice(0, 0).
$(resource).siblings().first();// get the first sibling of the current resource
24).last():Filter resource collection to the last element.
$(resource).siblings().last(); // get the last sibling of the current resource
25).not():Reduce the set of matched elements to those which doesn't match the selector. The selector may contain other modifiers as well, however in this case the function will be evaluated eagerly:
$(resource).children().not("cq:Page"); // remove all cq:Pages from the collection
$(resource).children().not(":first").not(":last"); // remove the first and the last element of the collection
Sling Query Modifiers
Sling Query object is immutable.
$(resource).listChildren().first();
Here three objects gets created ,because slingQuery object is immutable.
$(resource)
$(resource).listChildren()
$(resource).listChildren().first();
Instead of creating many objects, modifiers helps to create less number of objects.
:eq(index) : resource at a particular index can be fetch using eq(index) modifier.
:not(selector) :Reduce the set of matched elements to those which doesn't match the selector. The selector may contain other modifiers as well, however in this case the function will be evaluated eagerly:
