com.citytechinc.cq.component.annotations.widgets

Annotation Type Html5SmartFile

@Retention(value=CLASS)
 @Target(value={FIELD,METHOD})
public @interface Html5SmartFile

Represents a Widget of type CQ.html5.form.SmartFile in Classic UI

Represents a Widget of type granite/ui/components/foundation/form/fileupload in Touch UI

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	fileNameParameter Name of the form field used for posting the file name.
String	fileReferenceParameter Name of the form field used for posting the file reference.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowFileNameEditing Used for Classic UI only
boolean	allowFileReference Used for Classic UI only
boolean	allowUpload Used for Classic UI only
boolean	async Used for Touch UI Coral3 Only
boolean	autoStart Used for Touch UI Only
String	ddAccept Used for Classic UI only
String[]	ddGroups Used for Classic UI only
String	dropZone Used for Touch UI Only
boolean	hideText Used for Touch UI Coral3 Only
String	icon Used for Touch UI Only
String	iconSize Used for Touch UI Coral3 Only
String	mimeTypes Used for Classic UI only
String	mimeTypesDescription Used for Classic UI only
boolean	multiple Used for Touch UI Only
String	name Used for Classic UI only
String	size Used for Touch UI Coral3 Only
int	sizeLimit Maximum size of a file to be uploaded in Megabytes
String	text Used for Touch UI Only
String	title Used for Touch UI Only
String[]	touchUIMimeTypes Used for Touch UI only
String	uploadUrl Used for Touch UI Only
String	uploadUrlBuilder Used for Touch UI Only
boolean	useHtml5 Used for Touch UI Only

Element Detail

fileNameParameter

public abstract String fileNameParameter

Name of the form field used for posting the file name. Be aware that you will have to specify a suitable value here, as there is no sensible default value available. Suitable values are dependant on their serverside counterpart and must be "./fileName" for CQ foundation's image and download components; use "./image/fileName" for the textimage component.

Returns:

String

fileReferenceParameter

public abstract String fileReferenceParameter

Name of the form field used for posting the file reference. Be aware that you will have to specify a suitable value here, as there is no sensible default value available. Suitable values are dependant on their serverside counterpart and must be "./fileReference" for CQ foundation's image and download components; use "./image/fileReference" for the textimage component.

Returns:

String

name

public abstract String name

Used for Classic UI only

The field's HTML name attribute

Returns:

String

Default:

""

allowFileNameEditing

public abstract boolean allowFileNameEditing

Used for Classic UI only

True if the name of an uploaded file is editable

Returns:

boolean

Default:

true

allowFileReference

public abstract boolean allowFileReference

Used for Classic UI only

Flag if referencing a file is allowed

Returns:

boolean

Default:

true

allowUpload

public abstract boolean allowUpload

Used for Classic UI only

Flag if uploading a file is allowed

Returns:

boolean

Default:

true

ddAccept

public abstract String ddAccept

Used for Classic UI only

MIME type definition of files that are allowed for referencing using drag & drop

Returns:

String

Default:

"*"

ddGroups

public abstract String[] ddGroups

Used for Classic UI only

Groups involved in drag & drop

Returns:

String[]

Default:

{}

mimeTypes

public abstract String mimeTypes

Used for Classic UI only

MIME types allowed for uploading (each separated by a semicolon; wildcard * is allowed; for example: "*.*" or "*.jpg;*.gif;*.png" (defaults to "*.*".) Also support MIME type syntax; for example (image/jpg or image/*)

Returns:

String

Default:

"*.*"

touchUIMimeTypes

public abstract String[] touchUIMimeTypes

Used for Touch UI only

The list of mime types allowed for upload. This must be defined uniquely for Touch UI as the ExtJS allows different extension and wild card semantics than the Touch UI variant.

Returns:

String[]

Default:

{}

mimeTypesDescription

public abstract String mimeTypesDescription

Used for Classic UI only

A String that describes the allowed MIME types

Returns:

String

Default:

"All files"

sizeLimit

public abstract int sizeLimit

Maximum size of a file to be uploaded in Megabytes

Returns:

int

Default:

0

multiple

public abstract boolean multiple

Used for Touch UI Only

Indicates that multiple files may be uploaded

Returns:

boolean

Default:

false

uploadUrl

public abstract String uploadUrl

Used for Touch UI Only

URL where to upload the file, you can use ${suffix.path}

Returns:

String

Default:

"${suffix.path}"

uploadUrlBuilder

public abstract String uploadUrlBuilder

Used for Touch UI Only

The AEM documentation indicates that this should be an upload URL builder

Returns:

String

Default:

""

autoStart

public abstract boolean autoStart

Used for Touch UI Only

If true, upload starts automatically once the file is selected

Returns:

boolean

Default:

false

useHtml5

public abstract boolean useHtml5

Used for Touch UI Only

Prefer HTML5 to upload files (if browser allows it)

Returns:

boolean

Default:

true

dropZone

public abstract String dropZone

Used for Touch UI Only

Drop zone selector to upload files from file system directly (if browser allows it)

Returns:

String

Default:

""

title

public abstract String title

Used for Touch UI Only

The title associated with the upload button

Returns:

String

Default:

""

text

public abstract String text

Used for Touch UI Only

The text of the button

Returns:

String

Default:

""

icon

public abstract String icon

Used for Touch UI Only

The icon of the button

Returns:

String

Default:

""

async

public abstract boolean async

Used for Touch UI Coral3 Only

Set true to upload the files asynchronously

Returns:

boolean

Default:

false

hideText

public abstract boolean hideText

Used for Touch UI Coral3 Only

Visually hide the text. It is RECOMMENDED that every button has a text for a11y purpose. Use this property to hide it visually, while still making it available for a11y.

Returns:

boolean

Default:

false

iconSize

public abstract String iconSize

Used for Touch UI Coral3 Only

The size of the icon - XS, S, M, L

Returns:

String

Default:

"S"

size

public abstract String size

Used for Touch UI Coral3 Only

The size of the button - M, L

Returns:

String

Default:

"M"