Package com.day.cq.wcm.foundation.model.responsivegrid.export

Interface ResponsiveColumnExporter

All Superinterfaces:

ComponentExporter

All Known Implementing Classes:

ResponsiveColumn

@ProviderType
public interface ResponsiveColumnExporter
extends ComponentExporter

Describes the export behavior of a ResponsiveColumn.

Method Summary

Modifier and Type	Method	Description
Map<String,Breakpoint>	getBreakpoints()
String	getColumnClassNames()
ComponentExporter	getExportedComponent()
String	getExportedType()	Returns the type of the resource for which the export is performed.

Method Details

getBreakpoints

@Nullable
Map<String,Breakpoint> getBreakpoints()

Returns:

A map of Breakpoints associated with the column. The keys of the map are the breakpoint names.

getColumnClassNames

@Nullable
String getColumnClassNames()

Returns:

The CSS class names associated with the column.

getExportedComponent

@Nonnull
ComponentExporter getExportedComponent()

Returns:

Returns the actual component model that is wrapped inside of the responsive column. This is useful when performing a JSON export of the responsive grid; in such case, responsive child columns act as wrappers for the actual components that are part of the grid.

getExportedType

@Nonnull
String getExportedType()

Returns the type of the resource for which the export is performed.

NOTE: methods whose JSON serialization would lead to the same JSON property name (":type") will not be serialized.

Specified by:

getExportedType in interface ComponentExporter

Returns:

the type of the component