com.publiccms.views.directive.tools

类 DiyMetadataListDirective

java.lang.Object

com.publiccms.common.directive.BaseTemplateDirective

com.publiccms.common.base.AbstractTemplateDirective

com.publiccms.views.directive.tools.DiyMetadataListDirective

所有已实现的接口:

Directive, HttpDirective, freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

@Component
public class DiyMetadataListDirective
extends AbstractTemplateDirective

diyMetadataList diy元数据列表获取指令

参数列表

• itemType:元数据类型,【region,layout,module】
• region:区域id,当itemType为layout或module时有效
• showGlobal:元数据类型,【true,false】,当itemType为layout或module时有效,默认为true:

返回结果

• list: diy元数据列表region:CmsRegion,layout:CmsLayout,module:CmsModule

使用示例

<@tools.diyMetadataList itemType='region'><#list page.list as a>${a.name}<#sep>,</#list></@tools.diyMetadataList>

<script>
 $.getJSON('${site.dynamicPath}api/directive/tools/diyMetadataList?itemType=region&appToken=接口访问授权Token', function(data){    
   console.log(data.name);
 });
 </script>
 

字段概要

字段

限定符和类型	字段和说明
private DiyComponent	diyComponent

从类继承的字段 com.publiccms.common.base.AbstractTemplateDirective

ADVANCED, AUTH_TOKEN, AUTH_USER_ID, siteComponent

从类继承的字段 com.publiccms.common.directive.BaseTemplateDirective

log

从接口继承的字段 freemarker.template.TemplateModel

NOTHING

构造器概要

构造器

构造器和说明
DiyMetadataListDirective()

方法概要

限定符和类型	方法和说明
void	execute(RenderHandler handler)
boolean	needAppToken()

从类继承的方法 com.publiccms.common.base.AbstractTemplateDirective

execute, expose, getAdvanced, getApp, getSite, getUserId, needUserToken, supportAdvanced

从类继承的方法 com.publiccms.common.directive.BaseTemplateDirective

execute, getName, getNamespace, getShortName, httpEnabled, setName, setNamespace, setShortName

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

diyComponent

private DiyComponent diyComponent

构造器详细资料

DiyMetadataListDirective

public DiyMetadataListDirective()

方法详细资料

execute

public void execute(RenderHandler handler)
             throws java.io.IOException,
                    freemarker.template.TemplateException

抛出:

java.io.IOException

freemarker.template.TemplateException

needAppToken

public boolean needAppToken()

覆盖:

needAppToken 在类中 AbstractTemplateDirective

返回:

whether need the app token