Chuyển đến nội dung chính

[WIDGET] Multifield with custom xtype

When started working with CQ, one of the cool feature was the list component which allow to add new paths with the plus “+” sign. Based on my experience, it is one of the mandatory requirement to provide such flexibility, then setting a fixed number of text fields.
To achieve the same, please refer to the steps below:
Within your app project, define a folder called “clientlib”. Create a text files called “js.txt” and specify the name of the js file which holds the custom xtype definition.
Example:
#base=js
CustomPathField.js
Define your js file which extends CQ.form.CompositeField and specify attributes required for the custom type. Here is an example for the same:
/**
* @class MyClientLib.CustomPathFieldWidget
* @extends CQ.form.CompositeField
* This is a custom path field with link text and target
* @param {Object} config the config object
*/
/**
* @class Ejst.CustomWidget
* @extends CQ.form.CompositeField This is a custom widget based on
*          {@link CQ.form.CompositeField}.
* @constructor Creates a new CustomWidget.
* @param {Object}
*            config The config object
*/
MyClientLib.CustomPathFieldWidget = CQ.Ext.extend(CQ.form.CompositeField, {
   /**
    * @private
    * @type CQ.Ext.form.TextField
    */
   hiddenField: null,
   /**
    * @private
    * @type CQ.Ext.form.TextField
    */
   linkText: null,
   /**
    * @private
    * @type CQ.Ext.form.TextField
    */
   linkURL: null,
   /**
    * @private
    * @type CQ.Ext.form.CheckBox
    */
   openInNewWindow: null,
   /**
    * @private
    * @type CQ.Ext.form.FormPanel
    */
   formPanel: null,
   constructor: function(config) {
       config = config || {};
       var defaults = {“
           border”: true,
           “labelWidth”: 75,
           “layout”: “form”
               // ”columns”:6
       };
       config = CQ.Util.applyDefaults(config, defaults);
       MyClientLib.CustomPathFieldWidget.superclass.constructor.call(this, config);
   },
   // overriding CQ.Ext.Component#initComponent
   initComponent: function() {
       MyClientLib.CustomPathFieldWidget.superclass.initComponent.call(this);
       // Hidden field
       this.hiddenField = new CQ.Ext.form.Hidden({
           name: this.name
       });
       this.add(this.hiddenField);
       // Link text
       this.add(new CQ.Ext.form.Label({
           cls: “customwidget - label”,
           text: “Link Text”
       }));
       this.linkText = new CQ.Ext.form.TextField({
           cls: “customwidget - 1″,
           fieldLabel: “Link Text: “,
           maxLength: 80,
           maxLengthText: “A maximum of 80 characters is allowed
           for the Link Text.”,
           allowBlank: true,
           listeners: {
               change: {
                   scope: this,
                   fn: this.updateHidden
               }
           }
       });
       this.add(this.linkText);
       // Link URL
       this.add(new CQ.Ext.form.Label({
           cls: “customwidget - label”,
           text: “Link URL”
       }));
       this.linkURL = new CQ.form.PathField({
           cls: “customwidget - 2″,
           fieldLabel: “Link URL: “,
           allowBlank: false,
           width: 225,
           listeners: {
               change: {
                   scope: this,
                   fn: this.updateHidden
               },
               dialogclose: {
                   scope: this,
                   fn: this.updateHidden
               }
           }
       });
       this.add(this.linkURL);
       // Link openInNewWindow
       this.openInNewWindow = new CQ.Ext.form.Checkbox({
           cls: “customwidget - 3″,
           boxLabel: “New window”,
           listeners: {
               change: {
                   scope: this,
                   fn: this.updateHidden
               },
               check: {
                   scope: this,
                   fn: this.updateHidden
               }
           }
       });
       this.add(this.openInNewWindow);
   },
   processInit: function(path, record) {
       this.linkText.processInit(path, record);
       this.linkURL.processInit(path, record);
       this.openInNewWindow.processInit(path, record);
   },
   setValue: function(value) {
       var link = JSON.parse(value);
       this.linkText.setValue(link.text);
       this.linkURL.setValue(link.url);
       this.openInNewWindow.setValue(link.openInNewWindow);
       this.hiddenField.setValue(value);
   },
   getValue: function() {
       return this.getRawValue();
   },
   getRawValue: function() {
       var link = {“
           url”: this.linkURL.getValue(),
           “text”: this.linkText.getValue(),
           “openInNewWindow”: this.openInNewWindow.getValue()
       };
       return JSON.stringify(link);
   },
   updateHidden: function() {
       this.hiddenField.setValue(this.getValue());
   }
});
CQ.Ext.reg(‘mypathfield’, MyClientLib.CustomPathFieldWidget);
So, once we have defined that, its time to use in your component Here is snippet from dialog.xml from component:
<linkspanel
jcr:primaryType="cq:Panel"
border="false"
height=""
title="Links"
width="">
<items jcr:primaryType="cq:WidgetCollection">
<links
jcr:primaryType="cq:Widget"
fieldDescription="Press + to add more links"
fieldLabel="Links"
hideLabel="true"
name="./links"
width="1000"
xtype="multifield">
<fieldConfig
jcr:primaryType="cq:Widget"
xtype="mypathfield"/>
<listeners
jcr:primaryType="nt:unstructured" />
</links>
</items>
</linkspanel>
And this is how it appear !

Example of custom xtype

Nhận xét

Đăng nhận xét

Bài đăng phổ biến từ blog này

How to custom CQ Login Module

In order to manage the login process in our project, we will use a custom CQ Login Module. We will admit the root URL of CQ instance is: http://localhost:4502/ . This value may change depending of your environment. The %CQ_HOME% variable we will mention refers to the CQ install path. It admits you have defined %CQ_HOME% as an environment variable. 1.         Update the repository definitions The login module must be referenced in the repository definitions. You have to edit the next file: %CQ_HOME%/crx-quickstart/repository/repository.xml Do a copy of repository.xml to repository.xml.original In repostiory.xml, replace  security  part of repository.xml with following: <Security appName="com.day.crx">         <SecurityManager class="com.day.crx.core.CRXSecurityManager"> <WorkspaceAccessManager class="org.apache.jackrabbit.core.security.simple.SimpleWorkspaceAccessManager"/>  ...
Đăng nhận xét
Đọc thêm

[DAM] Custom DAM management / Add 'Alt' into images

Issue: We need, for each asset to be able to edit the ‘alt’ text. The ‘alt’ text must be used on the site each time an asset is displayed. When displaying an asset, the mechanism is the following : -       Get the Locale from the request -       When getting the asset, get the associated Alt property corresponding to the locale. -       Populate the alt attribute with this value. Resolution: To achieve this, we can customize the DAM Asset Editor. The AssetEditor is the form used to input asset properties and metadata. Below is a screenshot of a customized form with four “alt” input (for four different locales). The DAM uses the following nodes to render Asset Editor forms: -       /libs/dam/content/asseteditors/formitems -       /libs/dam/content/asseteditors/images/formitems -      ...
Đăng nhận xét
Đọc thêm

[COMPONENT] What is the automatically generated div tag around a component used for / How to remove DIV tag is generated by CQ

Question: If a component is included for example by the <cq:include> tag, a div tag is added automatically around the component in the generated HTML. What is this div tag used for and is it possible to suppress the automatic creation of it? Resolution: Add the below code in to global.jsp, which you include for all the component jsp's. if (WCMMode.fromRequest(request) != WCMMode.EDIT && WCMMode.fromRequest(request) != WCMMode.DESIGN) {          IncludeOptions.getOptions(request, true).forceSameContext(Boolean.TRUE); } This will not generate any more extra <div> tags for any number of components you add. Reference: This div tag is used for the editing system of CQ5 (drawing the edit bars, rollover frames etc), the Designer system of CQ5 (set CSS class name, Designer CSS styling) and also for identifying the component in the client DOM. It's possible to suppress this generated div tag either...
Đăng nhận xét
Đọc thêm