com.citytechinc.cq.component.annotations.widgets

Annotation Type Html5SmartImage

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

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

The Smart Image is not supported in Touch UI and will render as a granite/ui/components/foundation/form/fileupload Widget

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowCrop Used for Classic UI only
boolean	allowMap Used for Classic UI only
boolean	allowRotate Used for Classic UI only
boolean	allowUpload Used for Classic UI only
boolean	autoStart Used for Touch UI Only
AspectRatio[]	cropAspectRatios Used for Classic UI only
String[]	ddGroups Used for Classic UI only
boolean	disableFlush Used for Classic UI only
boolean	disableInfo Used for Classic UI only
boolean	disableZoom Used for Classic UI only
String	dropZone Used for Touch UI Only
int	height Used for Classic UI only
String	icon Used for Touch UI Only
boolean	isSelf Indicates that this component represents the image itself and as such the image properties and file assets should be stored on the component's resource instead of a child resource
boolean	multiple Used for Touch UI Only
int	sizeLimit Used for Touch UI Only
boolean	tab Used for Classic UI only
String	text Used for Touch UI Only
String	title Used for Touch UI Only
String	touchUIUploadUrl Used for Touch UI Only
String	uploadUrl Path to which files will be uploaded.
String	uploadUrlBuilder Used for Touch UI Only
boolean	useHtml5 Used for Touch UI Only

Element Detail

disableFlush

public abstract boolean disableFlush

Used for Classic UI only

True to not render the flush button.

Returns:

boolean

Default:

false

disableInfo

public abstract boolean disableInfo

Used for Classic UI only

True to hide the "information" tool

Returns:

boolean

Default:

false

disableZoom

public abstract boolean disableZoom

Used for Classic UI only

True to not render the zoom slider

Returns:

boolean

Default:

false

isSelf

public abstract boolean isSelf

Indicates that this component represents the image itself and as such the image properties and file assets should be stored on the component's resource instead of a child resource

Default:

false

uploadUrl

public abstract String uploadUrl

Path to which files will be uploaded.

Returns:

String

Default:

"/tmp/upload/*"

ddGroups

public abstract String[] ddGroups

Used for Classic UI only

Groups involved in drag & drop

Returns:

String[]

Default:

"media"

tab

public abstract boolean tab

Used for Classic UI only

Indication of whether the HTML5 Smart Image Widget should be rendered as a stand alone tab.

Returns:

boolean

Default:

true

height

public abstract int height

Used for Classic UI only

Height of the SmartImage component. Note: You must explicitly specify height if you intend to render the HTML5 Smart Image Widget outside the context of its own tab.

Returns:

int

Default:

0

allowUpload

public abstract boolean allowUpload

Used for Classic UI only

Flag if uploading a file is allowed

Returns:

boolean

Default:

true

cropAspectRatios

public abstract AspectRatio[] cropAspectRatios

Used for Classic UI only

Crop Config Aspect Ratios

Returns:

AspectRatio[]

Default:

{}

allowCrop

public abstract boolean allowCrop

Used for Classic UI only

Method to turn on cropping and automatically set the cropParameter; this simplifies #cropParameter()

Returns:

boolean

Default:

false

allowRotate

public abstract boolean allowRotate

Used for Classic UI only

Method to turn on rotating and automatically set the rotateParameter; this simplifies #rotateParameter()

Returns:

boolean

Default:

false

allowMap

public abstract boolean allowMap

Used for Classic UI only

Method to turn on mapping and automatically set the mapParameter; this simplifies #mapParameter()

Returns:

boolean

Default:

false

multiple

public abstract boolean multiple

Used for Touch UI Only

Indicates that multiple files may be uploaded

Returns:

boolean

Default:

false

touchUIUploadUrl

public abstract String touchUIUploadUrl

Used for Touch UI Only

URL where to upload the file, you can use ${suffix.path}. Upload semantics are different between the legacy ExtJS API and the new Touch UI API.

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:

""

sizeLimit

public abstract int sizeLimit

Used for Touch UI Only

Maximum size of a file to be uploaded in Megabytes

Returns:

int

Default:

0