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

Class ResponsiveColumn

java.lang.Object

org.apache.sling.api.adapter.SlingAdaptable

org.apache.sling.api.resource.AbstractResource

com.day.cq.wcm.foundation.model.responsivegrid.ResponsiveColumn

All Implemented Interfaces:

ComponentExporter, ResponsiveColumnExporter, Adaptable, Resource

@ProviderType
public class ResponsiveColumn
extends AbstractResource
implements ResponsiveColumnExporter

Represents a column of a responsive grid. A responsive grid's column is basically a virtual wrapper of a component that is part of the grid.

Field Summary

Fields inherited from interface org.apache.sling.api.resource.Resource

RESOURCE_TYPE_NON_EXISTING

Constructor Summary

Constructors

Constructor and Description
ResponsiveColumn(Resource resource, Map<String,Breakpoint> gridBreakpoints, String classNamePrefix)
ResponsiveColumn(Resource resource, Map<String,Breakpoint> gridBreakpoints, String classNamePrefix, SlingHttpServletRequest slingRequest, ModelFactory modelFactory)

Method Summary

Modifier and Type	Method and Description
Map<String,Breakpoint>	getBreakpoints()
String	getColumnClassNames()
Integer	getColumnCount(String breakpointName) Deprecated.
String	getCssClass() Deprecated. Use getColumnClassNames()
ComponentExporter	getExportedComponent()
String	getExportedType() Returns the type of the resource for which the export is performed.
Set<String>	getMissingBreakpointNames() Deprecated. Use getBreakpoints()
String	getPath() Returns the absolute path of this resource in the resource tree.
ValueMap	getProperties() Deprecated.
Resource	getResource()
ResourceMetadata	getResourceMetadata() Deprecated.
ResourceResolver	getResourceResolver() Deprecated.
String	getResourceSuperType() Deprecated.
String	getResourceType() Deprecated.

Methods inherited from class org.apache.sling.api.resource.AbstractResource

getChild, getChildren, getName, getParent, getValueMap, hasChildren, isResourceType, listChildren

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable

adaptTo, setAdapterManager, unsetAdapterManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Constructor Detail

ResponsiveColumn

public ResponsiveColumn(Resource resource,
                        Map<String,Breakpoint> gridBreakpoints,
                        String classNamePrefix)

ResponsiveColumn

public ResponsiveColumn(Resource resource,
                        Map<String,Breakpoint> gridBreakpoints,
                        String classNamePrefix,
                        SlingHttpServletRequest slingRequest,
                        ModelFactory modelFactory)

Method Detail

getBreakpoints

public Map<String,Breakpoint> getBreakpoints()

Specified by:

getBreakpoints in interface ResponsiveColumnExporter

Returns:

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

getColumnClassNames

public String getColumnClassNames()

Specified by:

getColumnClassNames in interface ResponsiveColumnExporter

Returns:

The CSS class names associated with the column.

getCssClass

public String getCssClass()

Deprecated. Use getColumnClassNames()

getMissingBreakpointNames

public Set<String> getMissingBreakpointNames()

Deprecated. Use getBreakpoints()

getColumnCount

public Integer getColumnCount(String breakpointName)

Deprecated.

Returns the number of columns for the given breakpoint name

Parameters:

breakpointName - The name of the breakpoint

Returns:

The number of columns for given breakpoint name.

getExportedComponent

@Nonnull
public ComponentExporter getExportedComponent()

Specified by:

getExportedComponent in interface ResponsiveColumnExporter

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
public String getExportedType()

Description copied from interface: ResponsiveColumnExporter

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

Specified by:

getExportedType in interface ResponsiveColumnExporter

Returns:

the type of the component

getResource

@Nonnull
public Resource getResource()

Returns:

The wrapped Resource associated with the column.

getPath

@Nonnull
public String getPath()

Description copied from interface: Resource

Returns the absolute path of this resource in the resource tree.

Specified by:

getPath in interface Resource

Returns:

The path of the wrapped Resource associated with the column.

getResourceType

@Nonnull
public String getResourceType()

Deprecated.

Description copied from interface: Resource

The resource type is meant to point to rendering/processing scripts, editing dialogs, etc. It is usually a path in the repository, where scripts and other tools definitions are found, but the ResourceResolver is free to set this to any suitable value such as the primary node type of the JCR node from which the resource is created.

If the resource instance represents a resource which is not actually existing, this method returns Resource.RESOURCE_TYPE_NON_EXISTING.

Specified by:

getResourceType in interface Resource

Returns:

The resource type

getResourceSuperType

public String getResourceSuperType()

Deprecated.

Description copied from interface: Resource

Returns the super type of the resource if the resource defines its own super type. Otherwise null is returned. A resource might return a resource super type to overwrite the resource type hierarchy. If a client is interested in the effective resource super type of a resource, it should call ResourceResolver.getParentResourceType(Resource).

Specified by:

getResourceSuperType in interface Resource

Returns:

The super type of the resource or null.

getResourceMetadata

@Nonnull
public ResourceMetadata getResourceMetadata()

Deprecated.

Description copied from interface: Resource

Returns the meta data of this resource. The concrete data contained in the ResourceMetadata object returned is implementation specific except for the ResourceMetadata.RESOLUTION_PATH property which is required to be set to the part of the request URI used to resolve the resource.

Specified by:

getResourceMetadata in interface Resource

Returns:

The resource meta data

See Also:

ResourceMetadata

getResourceResolver

@Nonnull
public ResourceResolver getResourceResolver()

Deprecated.

Description copied from interface: Resource

Returns the ResourceResolver from which this resource has been retrieved.

Specified by:

getResourceResolver in interface Resource

Returns:

The resource resolver

getProperties

public ValueMap getProperties()

Deprecated.