自定义网站控制台(经典UI) customizing-the-websites-console-classic-ui
向“网站(siteadmin)”控制台添加自定义列 adding-a-custom-column-to-the-websites-siteadmin-console
可以扩展网站管理控制台以显示自定义列。 控制台基于可通过创建用于实现的OSGI服务来扩展的JSON对象而构建。 ListInfoProvider
界面。 此类服务会修改发送到客户端的JSON对象以构建控制台。
此分步教程介绍了如何通过实施 ListInfoProvider
界面。 它包含以下步骤:
- 数字资产控制台
- 社区控制台
创建OSGI服务 creating-the-osgi-service
此 ListInfoProvider
接口定义了两种方法:
updateListGlobalInfo
,更新列表的全局属性,updateListItemInfo
,以更新单个列表项。
这两种方法的参数为:
request
,关联的Sling HTTP请求对象,info
,要更新的JSON对象,即全局列表项或当前列表项,resource
,Sling资源。
实施示例如下:
-
添加 星形 属性,即
true
如果页面名称以 e、和false
否则。 -
添加 starredCount 属性,该属性对列表是全局的,包含星形列表项的数量。
要创建OSGI服务,请执行以下操作:
- 在CRXDE Lite中, 创建捆绑包.
- 在下面添加示例代码。
- 构建捆绑包。
新服务已启动并正在运行。
package com.test;
import com.day.cq.commons.ListInfoProvider;
import com.day.cq.i18n.I18n;
import com.day.cq.wcm.api.Page;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.commons.json.JSONException;
import org.apache.sling.commons.json.JSONObject;
@Component(metatype = false)
@Service(value = ListInfoProvider.class)
public class StarredListInfoProvider implements ListInfoProvider {
private int count = 0;
public void updateListGlobalInfo(SlingHttpServletRequest request, JSONObject info, Resource resource) throws JSONException {
info.put("starredCount", count);
count = 0; // reset for next execution
}
public void updateListItemInfo(SlingHttpServletRequest request, JSONObject info, Resource resource) throws JSONException {
Page page = resource.adaptTo(Page.class);
if (page != null) {
// Consider starred if page name starts with 'e'
boolean starred = page.getName().startsWith("e");
if (starred) {
count++;
}
I18n i18n = new I18n(request);
info.put("starred", starred ? i18n.get("Yes") : i18n.get("No"));
}
}
}
-
您的实施应根据提供的请求和/或资源决定是否应将信息添加到JSON对象。
-
如果您的
ListInfoProvider
实施定义响应对象中存在的属性,其值由您提供的值覆盖。您可以使用 服务排名 管理多个执行顺序
ListInfoProvider
实施。
测试新服务 testing-the-new-service
当您打开网站管理控制台并浏览您的网站时,浏览器将发出Ajax调用以获取用于构建控制台的JSON对象。 例如,当您浏览到 /content/geometrixx
文件夹内,向AEM服务器发送以下请求以构建控制台:
https://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin
要确保新服务在部署包含该服务的捆绑包后正在运行,请执行以下操作:
-
将浏览器指向以下URL:
https://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin -
响应应按以下方式显示新属性:
显示新列 displaying-the-new-column
最后一步是调整网站管理控制台的节点结构,通过叠加来显示所有Geometrixx页面的新属性 /libs/wcm/core/content/siteadmin
. 按照以下步骤操作:
-
在CRXDE Lite中,创建节点结构
/apps/wcm/core/content
具有类型节点sling:Folder
以反映结构/libs/wcm/core/content
. -
复制节点
/libs/wcm/core/content/siteadmin
并将其粘贴到下方/apps/wcm/core/content
. -
复制节点
/apps/wcm/core/content/siteadmin/grid/assets
到/apps/wcm/core/content/siteadmin/grid/geometrixx
并更改其属性:-
移除 pageText
-
设置 pathRegex 到
/content/geometrixx(/.*)?
这将使网格配置在所有Geometrixx网站中处于活动状态。 -
设置 storeproxysuffix 到
.pages.json
-
编辑 storeReaderFields 多值属性并添加
starred
值。 -
要激活MSM功能,请将以下MSM参数添加到多字符串属性中 storeReaderFields:
- msm:isSource
- msm:isInBlueprint
- msm:isLiveCopy
-
-
添加
starred
节点(属于类型) nt:unstructured)/apps/wcm/core/content/siteadmin/grid/geometrixx/columns
具有以下属性:-
数据索引:
starred
类型字符串 -
标题:
Starred
类型字符串 -
xtype:
gridcolumn
类型字符串
-
-
(可选)删除您不想在其中显示的列
/apps/wcm/core/content/siteadmin/grid/geometrixx/columns
-
/siteadmin
是一个虚名路径,默认指向/libs/wcm/core/content/siteadmin
.
要将此重定向到您在上的siteadmin版本,请执行以下操作/apps/wcm/core/content/siteadmin
,定义属性sling:vanityOrder
使其值高于在上定义的/libs/wcm/core/content/siteadmin
. 默认值为300,因此适合使用任何更高的值。 -
转到网站管理控制台并导航到Geometrixx站点:
https://localhost:4502/siteadmin#/content/geometrixx. -
新列名为 星形 可用,按如下方式显示自定义信息:
示例包 sample-package
本教程的结果可在 自定义网站管理控制台 包共享。