Package com.adobe.cq.inbox.ui.column
Class Column
- java.lang.Object
-
- com.adobe.cq.inbox.ui.column.Column
-
public final class Column extends Object
A column in the inbox.Each column should be backed by aColumnProvider
-
-
Constructor Summary
Constructors Constructor Description Column(String name, String title)
Create a newColumn
Column(String name, String title, String type)
Create a newColumn
of the given typeColumn(String name, String title, String templateResourcePath, String templateName)
Create a newColumn
which is based on sightly templateColumn(String name, String title, String type, String templateResourcePath, String templateName)
Create a newColumn
based on sightly template and of given type
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
Name of the column.String
getTemplateName()
Name of the sightly template to render the column The resource attemplateResourcePath
may contain multiple sightly templates The template accepts a parameter nameditem
of typeInboxItem
Sample template<template data-sly-template.wftitle="${@ item}>"> <div> ${item.workflowTitle @ i18n, locale=request.locale} </div> </template>
String
getTemplateResourcePath()
Path of the resource containing the sightly template to render the columnString
getTitle()
The display name of the columnString
getType()
Fully qualified name of the class representing the type of the data associated with the column Used for sorting on the column e.g.
-
-
-
Constructor Detail
-
Column
public Column(@Nonnull String name, String title)
Create a newColumn
- Parameters:
name
- name of the columntitle
- title of the column
-
Column
public Column(@Nonnull String name, String title, @Nonnull String templateResourcePath, @Nonnull String templateName)
Create a newColumn
which is based on sightly template- Parameters:
name
- name of the columntitle
- title of the columntemplateResourcePath
- path of the resource containing the sightly template to render the columntemplateName
- name of the sightly template to render the column
-
Column
public Column(@Nonnull String name, String title, @Nonnull String type)
Create a newColumn
of the given type- Parameters:
name
- name of the columntitle
- title of the columntype
- fully qualified class name of the class representing the type of the data associated with the column
-
Column
public Column(@Nonnull String name, String title, @Nonnull String type, @Nonnull String templateResourcePath, @Nonnull String templateName)
Create a newColumn
based on sightly template and of given type- Parameters:
name
- name of the columntitle
- title of the columntype
- fully qualified class name of the class representing the type of the data associated with the columntemplateResourcePath
- path of the resource containing the sightly template to render the columntemplateName
- name of the sightly template to render the column
-
-
Method Detail
-
getName
public String getName()
Name of the column. Name is used to uniquely identify a column- Returns:
- column name
-
getTitle
public String getTitle()
The display name of the column- Returns:
- column title
-
getType
public String getType()
Fully qualified name of the class representing the type of the data associated with the column Used for sorting on the column e.g. java.lang.String The column will be sortable for following types java.lang.String java.lang.Boolean java.lang.Long java.lang.Double java.util.Date- Returns:
- column type
-
getTemplateResourcePath
public String getTemplateResourcePath()
Path of the resource containing the sightly template to render the column- Returns:
-
getTemplateName
public String getTemplateName()
Name of the sightly template to render the column The resource attemplateResourcePath
may contain multiple sightly templates The template accepts a parameter nameditem
of typeInboxItem
Sample template<template data-sly-template.wftitle="${@ item}>"> <div> ${item.workflowTitle @ i18n, locale=request.locale} </div> </template>
- Returns:
-
-