com.day.cq.wcm.foundation

Class Download

java.lang.Object

org.apache.sling.api.resource.ResourceWrapper

com.day.cq.commons.DownloadResource

com.day.cq.wcm.foundation.Download

All Implemented Interfaces:

Adaptable, Resource

public class Download
extends DownloadResource

Provides convenience methods for rendering download paragraphs.

Field Summary

Fields inherited from class com.day.cq.commons.DownloadResource

attrs, NN_FILE, node, PN_DESCRIPTION, PN_FILE_NAME, PN_REFERENCE, PN_TITLE, properties

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

RESOURCE_TYPE_NON_EXISTING

Constructor Summary

Constructors

Constructor and Description
Download(Resource resource) Creates a new download based on the given resource.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getIconPath() Deprecated. since 5.4 please use css classes for the icon, like "icon_xls.gif"
protected Resource	getReferencedResource(java.lang.String path) Returns the resource that is referenced by path.

Methods inherited from class com.day.cq.commons.DownloadResource

addAttribute, addCssClass, addQueryParam, draw, get, get, getAttributes, getData, getDescription, getDescription, getExtension, getFileName, getFileNodePath, getFileReference, getHref, getIconType, getInnerHtml, getItemName, getLastModified, getMimeType, getQuery, getSelector, getString, getSuffix, getTitle, getTitle, hasContent, init, set, setDescription, setExtension, setFileName, setFileNodePath, setFileReference, setHref, setInnerHtml, setItemName, setQuery, setSelector, setSuffix, setTitle

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

adaptTo, getChild, getChildren, getName, getParent, getPath, getResource, getResourceMetadata, getResourceResolver, getResourceSuperType, getResourceType, isResourceType, listChildren, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Download

public Download(Resource resource)

Creates a new download based on the given resource. the file properties are considered to be 'on' the given resource.

Parameters:

resource - resource of the image

Throws:

java.lang.IllegalArgumentException - if the given resource is not adaptable to node.

Method Detail

getIconPath

@Deprecated
public java.lang.String getIconPath()

Deprecated. since 5.4 please use css classes for the icon, like "icon_xls.gif"

Returns a path to an icon representing the file. Checks if the component of the resource provides an icon for the respective type.

Overrides:

getIconPath in class DownloadResource

Returns:

a path to an icon or null.

getReferencedResource

protected Resource getReferencedResource(java.lang.String path)

Returns the resource that is referenced by path. Subclasses can provide further semantics. Checks if the resource is an asset and returns the correct rendition.

Overrides:

getReferencedResource in class DownloadResource

Parameters:

path - path to the resource

Returns:

the resource or null.