com.adobe.cq.inbox.ui.column

Class Column

java.lang.Object

com.adobe.cq.inbox.ui.column.Column

public final class Column
extends java.lang.Object

A column in the inbox.Each column should be backed by a ColumnProvider

Constructor Summary

Constructors

Constructor and Description
Column(java.lang.String name, java.lang.String title) Create a new Column
Column(java.lang.String name, java.lang.String title, java.lang.String type) Create a new Column of the given type
Column(java.lang.String name, java.lang.String title, java.lang.String templateResourcePath, java.lang.String templateName) Create a new Column which is based on sightly template
Column(java.lang.String name, java.lang.String title, java.lang.String type, java.lang.String templateResourcePath, java.lang.String templateName) Create a new Column based on sightly template and of given type

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Name of the column.
java.lang.String	getTemplateName() Name of the sightly template to render the column The resource at templateResourcePath may contain multiple sightly templates The template accepts a parameter named item of type InboxItem Sample template <template data-sly-template.wftitle="${@ item}>"> <div> ${item.workflowTitle @ i18n, locale=request.locale} </div> </template>
java.lang.String	getTemplateResourcePath() Path of the resource containing the sightly template to render the column
java.lang.String	getTitle() The display name of the column
java.lang.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Column

public Column(@Nonnull
              java.lang.String name,
              java.lang.String title)

Create a new Column

Parameters:

name - name of the column

title - title of the column

Column

public Column(@Nonnull
              java.lang.String name,
              java.lang.String title,
              @Nonnull
              java.lang.String templateResourcePath,
              @Nonnull
              java.lang.String templateName)

Create a new Column which is based on sightly template

Parameters:

name - name of the column

title - title of the column

templateResourcePath - path of the resource containing the sightly template to render the column

templateName - name of the sightly template to render the column

Column

public Column(@Nonnull
              java.lang.String name,
              java.lang.String title,
              @Nonnull
              java.lang.String type)

Create a new Column of the given type

Parameters:

name - name of the column

title - title of the column

type - fully qualified class name of the class representing the type of the data associated with the column

Column

public Column(@Nonnull
              java.lang.String name,
              java.lang.String title,
              @Nonnull
              java.lang.String type,
              @Nonnull
              java.lang.String templateResourcePath,
              @Nonnull
              java.lang.String templateName)

Create a new Column based on sightly template and of given type

Parameters:

name - name of the column

title - title of the column

type - fully qualified class name of the class representing the type of the data associated with the column

templateResourcePath - path of the resource containing the sightly template to render the column

templateName - name of the sightly template to render the column

Method Detail

getName

public java.lang.String getName()

Name of the column. Name is used to uniquely identify a column

Returns:

column name

getTitle

public java.lang.String getTitle()

The display name of the column

Returns:

column title

getType

public java.lang.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 java.lang.String getTemplateResourcePath()

Path of the resource containing the sightly template to render the column

Returns:

getTemplateName

public java.lang.String getTemplateName()

Name of the sightly template to render the column The resource at templateResourcePath may contain multiple sightly templates The template accepts a parameter named item of type InboxItem Sample template <template data-sly-template.wftitle="${@ item}>"> <div> ${item.workflowTitle @ i18n, locale=request.locale} </div> </template>

Returns: