org.hippoecm.frontend.plugins.yui.upload

Class FileUploadWidgetSettings

java.lang.Object

org.hippoecm.frontend.plugins.yui.upload.FileUploadWidgetSettings

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable

public class FileUploadWidgetSettings
extends Object
implements org.apache.wicket.IClusterable

Settings for file uploads. Currently allowed configurable settings are:

• fileupload.flashEnabled = true for flash or false for javascript upload
• fileupload.maxItems = maximum allowed file uploads at the same time
• fileupload.allowedExtensions = allowed upload file extensions
• fileupload.autoUpload = if true the plugin will automatically upload the files
• fileupload.buttonWidth = defines the width of the upload button
• fileupload.buttonHeight = defines the height of the upload button
• fileupload.clearAfterUpload = if true the dialog is cleared after all files are uploaded
• fileupload.clearTimeout = defines the timeout before clearing the dialog after the upload
• fileupload.hideBrowseDuringUpload = if true the browse button will be hidden during the upload

Backwards compatibility:

• file.extensions = allowed upload file extensions

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_EXTENSIONS_SETTING
static String	FILEUPLOAD_ALLOWED_EXTENSIONS_SETTING
static String	FILEUPLOAD_AUTOUPLOAD_SETTING
static String	FILEUPLOAD_BUTTON_HEIGHT
static String	FILEUPLOAD_BUTTON_WIDTH
static String	FILEUPLOAD_CLEAR_AFTER_UPLOAD
static String	FILEUPLOAD_CLEAR_TIMEOUT
static String	FILEUPLOAD_FLASH_ENABLED_SETTING
static String	FILEUPLOAD_HIDE_BROWSE_DURING_UPLOAD
static String	FILEUPLOAD_MAX_ITEMS_SETTING

Constructor Summary

Constructors

Constructor and Description
FileUploadWidgetSettings()
FileUploadWidgetSettings(IPluginConfig pluginConfig)

Method Summary

Methods

Modifier and Type	Method and Description
String	getButtonHeight()
String	getButtonWidth()
int	getClearTimeout()
String[]	getFileExtensions()
int	getMaxNumberOfFiles()
boolean	isAutoUpload()
boolean	isClearAfterUpload()
boolean	isFlashUploadEnabled() Indicates if the upload widget should use Flash.
boolean	isHideBrowseDuringUpload()
void	setAutoUpload(boolean set)
void	setButtonHeight(String buttonHeight)
void	setButtonWidth(String buttonWidth)
void	setClearAfterUpload(boolean clear)
void	setClearTimeout(int clearTimeout)
void	setFileExtensions(String[] fileExtensions)
void	setFlashUploadEnabled(boolean flashUploadEnabled) If set to true (default) the upload plugin will use flash for file uploads, otherwise it will use a plain Javascript upload.
void	setHideBrowseDuringUpload(boolean hideBrowseDuringUpload)
void	setMaxNumberOfFiles(int nr)

Methods inherited from class java.lang.Object

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

Field Detail

FILEUPLOAD_FLASH_ENABLED_SETTING

public static final String FILEUPLOAD_FLASH_ENABLED_SETTING

See Also:

Constant Field Values

FILEUPLOAD_MAX_ITEMS_SETTING

public static final String FILEUPLOAD_MAX_ITEMS_SETTING

See Also:

Constant Field Values

FILEUPLOAD_AUTOUPLOAD_SETTING

public static final String FILEUPLOAD_AUTOUPLOAD_SETTING

See Also:

Constant Field Values

FILEUPLOAD_ALLOWED_EXTENSIONS_SETTING

public static final String FILEUPLOAD_ALLOWED_EXTENSIONS_SETTING

See Also:

Constant Field Values

FILEUPLOAD_BUTTON_WIDTH

public static final String FILEUPLOAD_BUTTON_WIDTH

See Also:

Constant Field Values

FILEUPLOAD_BUTTON_HEIGHT

public static final String FILEUPLOAD_BUTTON_HEIGHT

See Also:

Constant Field Values

FILEUPLOAD_CLEAR_AFTER_UPLOAD

public static final String FILEUPLOAD_CLEAR_AFTER_UPLOAD

See Also:

Constant Field Values

FILEUPLOAD_CLEAR_TIMEOUT

public static final String FILEUPLOAD_CLEAR_TIMEOUT

See Also:

Constant Field Values

FILEUPLOAD_HIDE_BROWSE_DURING_UPLOAD

public static final String FILEUPLOAD_HIDE_BROWSE_DURING_UPLOAD

See Also:

Constant Field Values

FILE_EXTENSIONS_SETTING

public static final String FILE_EXTENSIONS_SETTING

See Also:

Constant Field Values

Constructor Detail

FileUploadWidgetSettings

public FileUploadWidgetSettings()

FileUploadWidgetSettings

public FileUploadWidgetSettings(IPluginConfig pluginConfig)

Method Detail

setFileExtensions

public void setFileExtensions(String[] fileExtensions)

getFileExtensions

public String[] getFileExtensions()

setMaxNumberOfFiles

public void setMaxNumberOfFiles(int nr)

getMaxNumberOfFiles

public int getMaxNumberOfFiles()

setAutoUpload

public void setAutoUpload(boolean set)

isAutoUpload

public boolean isAutoUpload()

setClearAfterUpload

public void setClearAfterUpload(boolean clear)

isClearAfterUpload

public boolean isClearAfterUpload()

getClearTimeout

public int getClearTimeout()

setClearTimeout

public void setClearTimeout(int clearTimeout)

setHideBrowseDuringUpload

public void setHideBrowseDuringUpload(boolean hideBrowseDuringUpload)

isHideBrowseDuringUpload

public boolean isHideBrowseDuringUpload()

getButtonWidth

public String getButtonWidth()

setButtonWidth

public void setButtonWidth(String buttonWidth)

getButtonHeight

public String getButtonHeight()

setButtonHeight

public void setButtonHeight(String buttonHeight)

isFlashUploadEnabled

public boolean isFlashUploadEnabled()

Indicates if the upload widget should use Flash.

Returns:

true if flash should be used, false otherwise

setFlashUploadEnabled

public void setFlashUploadEnabled(boolean flashUploadEnabled)

If set to true (default) the upload plugin will use flash for file uploads, otherwise it will use a plain Javascript upload.

Parameters:

flashUploadEnabled - boolean indicating if flash should be used for file uploads.